Categorygithub.com/unity-technologies/trussdeftree
package
0.1.0
Repository: https://github.com/unity-technologies/truss.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
17
Dependents
0
Files
1.2k SLOC

# README

Documentation Structure

This package contains structs and code defining how protobuf documentation will be represented within this program, and code for the creation, navigation and serialization of these structures.

# Packages

No description provided by the author

# Functions

Assemble takes a deftree that's already had http options parsed by svcparse and inserted, then assembles the `HttpParameters` corresponding to each ServiceMethod's http annotations.
AssociateComments walks the provided CodeGeneratorRequest finding comments and then copying them into their corresponding location within the deftree.
Searches through the files in the request and returns the path to the first one which contains a service declaration.
New accepts a Protobuf plugin.CodeGeneratorRequest and the contents of the file containing the service declaration and returns a Deftree struct.
NewEnum returns a *ProtoEnum created from a *descriptor.EnumDescriptorProto.
Build a new deftree.File struct.
NewFromString creates a Deftree from a string of a valid protobuf definition.
NewMessage returns a *ProtoMessage created from a *descriptor.DescriptorProto.
NewService creates a new *ProtoService from a descriptor.ServiceDescriptorProto.

# Structs

BindingField represents a single field within an `option` annotation for an rpc method.
No description provided by the author
No description provided by the author
HttpParameter contains information for one parameter of an http binding.
No description provided by the author
No description provided by the author
MicroserviceDefinition is the root node for any particular `Deftree`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

Deftree is the root interface for this package, and is chiefly implemented by MicroserviceDefinition.
Describable offers an interface for traversing a Deftree and finding information from the nodes within it.