Documentation ¶
Index ¶
Constants ¶
View Source
const ( Unary = iota ServerStreaming ClientStreaming BidirectionalStreaming )
View Source
const ProtoTpl = `` /* 2261-byte string literal not displayed */
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Endpoint ¶
type Endpoint struct { // the package name of the proto file PackageName string // the enclosing service name ServiceName string // my name MethodName string // the url path where api gateway resolves URLPath string // the http method, which is always POST HTTPMethod string // Comment placed at the beginning, as well as inline-Comment placed at the ending Comment string Typ RPCType Req Request Res Response }
Endpoint is also called method or interface
func (Endpoint) IsWebSocket ¶
type Enum ¶
type Enum struct { // only use Comment placed at the beginning Comment string // refers by field.typ Name string // Constants Constants []EnumField }
Enum is user-defined type which has one of a pre-defined list of values
type Field ¶
type Field struct { // Comment placed at the beginning, as well as inline-Comment placed at the ending Comment string Name string Typ string Repeat bool // the Enclosing type name of this field Enclosing string // contains filtered or unexported fields }
type Object ¶
type Object struct { // only use Comment placed at the beginning Comment string // refers by field.typ Name string // attributes Attrs []Field }
Object is user-defined field type
type ProtoFile ¶
type ProtoFile struct { // a proto file could have multiple service Services []Service // a proto file should have multiple object Objects []Object // a proto file should have multiple enum Enums []Enum }
ProtoFile is a parsing unit
func (*ProtoFile) ComposeFrom ¶
func (ProtoFile) GenerateMarkdown ¶
Click to show internal directories.
Click to hide internal directories.