generator

Documentation

Index

• Variables
• type Generator
  • func (p *Generator) Generate(r *pluginpb.CodeGeneratorRequest) (*pluginpb.CodeGeneratorResponse, error)
• type Method
• type ProtoFile
• type Service

Variables

var SupportedFeatures = uint64(pluginpb.CodeGeneratorResponse_FEATURE_PROTO3_OPTIONAL)

SupportedFeatures describes a flag setting for supported features.

Types

type Generator

type Generator struct {
	Suffix   string
	Template string
}

Generator describes a protoc code generate plugin. It's an implementation of Generator from github.com/pseudomuto/protokit

func (*Generator) Generate

func (p *Generator) Generate(r *pluginpb.CodeGeneratorRequest) (*pluginpb.CodeGeneratorResponse, error)

Generate compiles the documentation and generates the CodeGeneratorResponse to send back to protoc. It does this by rendering a template based on the options parsed from the CodeGeneratorRequest.

type Method

type Method struct {
	Name            string
	Comment         string
	Request         string
	Response        string
	ClientStreaming bool
	ServerStreaming bool
}

type ProtoFile

type ProtoFile struct {
	Name     string
	Package  string
	Services []Service
}

type Service

type Service struct {
	Name    string
	Comment string
	Methods []Method
}