shared

package

v0.0.0-...-14bcf06 Latest Latest Go to latest Published: May 6, 2020 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	Enum    = "enum"
	Message = "message"

	TODOComment = "***TODO***"
)

This section is empty.

func Register(tpl *template.Template, params pgs.Parameters)

type EnumDoc struct {
	pgs.Enum
	Values []*EnumDocValue
}

type EnumDocValue struct {
	Name    string
	Value   int32
	Comment string
}

type Func struct {
	pgsgo.Context
}

func (fn Func) Anchor(name pgs.Name) string

func (fn Func) EmbedFields(field pgs.Field, enumDoc map[string]interface{}, msgDoc map[string]interface{})

func (fn Func) EmbedMessages(file pgs.File) map[string]map[string]interface{}

func (fn Func) EnumDoc(enum pgs.Enum) []*EnumDocValue

func (fn Func) GatewayDoc(method pgs.Method) *GatewayDoc

func (fn Func) GatewayURL(method pgs.Method) string

func (fn Func) JSONDemo(message pgs.Message) string

func (fn Func) LeadingComment(info pgs.SourceCodeInfo) string

func (fn Func) MessageDoc(msg pgs.Message) []*MessageDocField

func (fn Func) TOCComment(info pgs.SourceCodeInfo) string

func (fn Func) TrailingComment(info pgs.SourceCodeInfo) string

type GatewayDoc struct {
	URL          string
	Method       string
	ContentType  string
	JsonRequired bool
}

type MessageDoc struct {
	pgs.Message
	Fields []*MessageDocField
}

type MessageDocField struct {
	Name      string
	Comment   string
	ProtoType string
	JsonType  string
	Default   string
	Required  bool
}