parse

Documentation

Overview

Package parse is parsed proto file to struct

Index

• type Field
  • func (r Field) GoTypeZero() string
• type PbService
  • func GetServices(file *protogen.File) []*PbService
  • func (s *PbService) RandNumber() int
• type RPCMethod
  • func GetMethods(m *protogen.Method) []*RPCMethod
  • func (m *RPCMethod) HandlerName() string
  • func (m *RPCMethod) HasPathParams() bool
  • func (m *RPCMethod) InitPathParams()
• type ServiceMethod
  • func (t *ServiceMethod) AddOne(i int) int

Types

type Field

type Field struct {
	Name      string // field name
	FieldType string // field type
	Comment   string // field comment
}

Field message field

func (Field) GoTypeZero

func (r Field) GoTypeZero() string

GoTypeZero default zero value for type

type PbService

type PbService struct {
	Name      string           // Greeter
	LowerName string           // greeter first character to lower
	Methods   []*ServiceMethod // service methods

	CutServiceName      string // GreeterService --> Greeter
	LowerCutServiceName string // GreeterService --> greeter
}

PbService service fields

func GetServices

func GetServices(file *protogen.File) []*PbService

GetServices parse protobuf services

func (*PbService) RandNumber

func (s *PbService) RandNumber() int

RandNumber rand number 1~100

type RPCMethod

type RPCMethod struct {
	Name    string // SayHello
	Num     int    // one rpc RPCMethod can correspond to multiple http requests
	Request string // SayHelloReq
	Reply   string // SayHelloResp

	// http_rule
	Path         string // rule
	Method       string // HTTP Method
	Body         string
	ResponseBody string
}

RPCMethod describes a rpc method

func GetMethods

func GetMethods(m *protogen.Method) []*RPCMethod

GetMethods get rpc method descriptions

func (*RPCMethod) HandlerName

func (m *RPCMethod) HandlerName() string

HandlerName for gin handler name

func (*RPCMethod) HasPathParams

func (m *RPCMethod) HasPathParams() bool

HasPathParams whether to include routing parameters

func (*RPCMethod) InitPathParams

func (m *RPCMethod) InitPathParams()

InitPathParams conversion parameter routing {xx} --> :xx

type ServiceMethod

type ServiceMethod struct {
	MethodName    string // Create
	Request       string // CreateRequest
	RequestFields []*Field
	Reply         string // CreateReply
	ReplyFields   []*Field
	Comment       string // e.g. Create a record

	ServiceName         string // Greeter
	LowerServiceName    string // greeter first character to lower
	LowerCutServiceName string // GreeterService --> greeter

	// http_rule
	Path   string // rule
	Method string // HTTP Method
	Body   string
}

ServiceMethod RPCMethod fields

func (*ServiceMethod) AddOne

func (t *ServiceMethod) AddOne(i int) int

AddOne counter