gen

Documentation

Index

• func Append(s *string, args ...string)
• func CamelCase(s string) string
• func DefaultAPIOptions(pkg string, srv string, mth string) *options.HttpRule
• func DefaultHttpRule(name string) *options.HttpRule
• func ExtractAPIOptions(mth *descriptor.MethodDescriptorProto) (*options.HttpRule, error)
• func ExtractHttpMethod(opts *options.HttpRule) (method string, path string)
• func New(name string, opts ...Opt) *protoGen
• func ParseParameter(args string)
• func ParseRequest(r io.Reader) (*plugin.CodeGeneratorRequest, error)
• func SourceCode(buf *bytes.Buffer) (string, error)
• func Template(tpl string, m pongo2.Context) string
• func UnExport(s string) string
• type Context
• type FileDescriptor
  • func (t *FileDescriptor) GetService() []*Service
• type Method
  • func (t *Method) GetClientStreaming() bool
  • func (t *Method) GetHttpMethod() (method string, path string, defaultUrl bool)
  • func (t *Method) GetInputType() string
  • func (t *Method) GetName() string
  • func (t *Method) GetOptions() *descriptor.MethodOptions
  • func (t *Method) GetOutputType() string
  • func (t *Method) GetServerStreaming() bool
• type Opt
  • func OnlyService() Opt
• type Service
  • func (t *Service) GetMethod() (methods []*Method)
  • func (t *Service) GetName() string
  • func (t *Service) IsDefault() bool

Functions

func Append

func Append(s *string, args ...string)

func CamelCase

func CamelCase(s string) string

CamelCase returns the CamelCased name. If there is an interior underscore followed by a lower case letter, drop the underscore and convert the letter to upper case. There is a remote possibility of this rewrite causing a name collision, but it's so remote we're prepared to pretend it's nonexistent - since the C++ generator lowercases names, it's extremely unlikely to have two fields with different capitalizations. In short, _my_field_name_2 becomes XMyFieldName_2.

func DefaultAPIOptions

func DefaultAPIOptions(pkg string, srv string, mth string) *options.HttpRule

DefaultAPIOptions This generates an HttpRule that matches the gRPC mapping to HTTP/2 described in https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests i.e.:

• method is POST
• path is "<pkg name>/<service name>/<method name>"
• body should contain the serialized request message

func DefaultHttpRule

func DefaultHttpRule(name string) *options.HttpRule

func ExtractAPIOptions

func ExtractAPIOptions(mth *descriptor.MethodDescriptorProto) (*options.HttpRule, error)

func ExtractHttpMethod

func ExtractHttpMethod(opts *options.HttpRule) (method string, path string)

func New

func New(name string, opts ...Opt) *protoGen

func ParseParameter

func ParseParameter(args string)

func ParseRequest

func ParseRequest(r io.Reader) (*plugin.CodeGeneratorRequest, error)

func SourceCode

func SourceCode(buf *bytes.Buffer) (string, error)

func Template

func Template(tpl string, m pongo2.Context) string

func UnExport

func UnExport(s string) string

Types

type Context

type Context = pongo2.Context

type FileDescriptor

type FileDescriptor struct {
	Pkg string
	*descriptor.FileDescriptorProto
}

func (*FileDescriptor) GetService

func (t *FileDescriptor) GetService() []*Service

type Method

type Method struct {
	InType     string
	OutType    string
	CS         bool
	SS         bool
	Name       string
	HttpMethod string
	HttpPath   string
	DefaultUrl bool
	Srv        string
	Pkg        string
	// contains filtered or unexported fields
}

func (*Method) GetClientStreaming

func (t *Method) GetClientStreaming() bool

func (*Method) GetHttpMethod

func (t *Method) GetHttpMethod() (method string, path string, defaultUrl bool)

func (*Method) GetInputType

func (t *Method) GetInputType() string

func (*Method) GetName

func (t *Method) GetName() string

func (*Method) GetOptions

func (t *Method) GetOptions() *descriptor.MethodOptions

func (*Method) GetOutputType

func (t *Method) GetOutputType() string

func (*Method) GetServerStreaming

func (t *Method) GetServerStreaming() bool

type Opt

type Opt = func(opt *opts) error

func OnlyService

func OnlyService() Opt

type Service

type Service struct {
	Pkg string
	Srv string
	*descriptor.ServiceDescriptorProto
}

func (*Service) GetMethod

func (t *Service) GetMethod() (methods []*Method)

func (*Service) GetName

func (t *Service) GetName() string

func (*Service) IsDefault

func (t *Service) IsDefault() bool