Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pgs

package module

Go to main page

Versions in this module

v2

v2.0.3

Mar 24, 2023

v2.0.2-alpha

Sep 20, 2022

v2.0.1

Jan 6, 2023

v2.0.1-alpha

Sep 13, 2022

v2.0.0

Jan 5, 2023

Changes in this version

+ const BoolT

+ const BytesT

+ const DoubleT

+ const EnumT

+ const Fixed32T

+ const Fixed64T

+ const FloatT

+ const GroupT

+ const Int32T

+ const Int64T

+ const MessageT

+ const Optional

+ const Repeated

+ const Required

+ const SFixed32

+ const SFixed64

+ const SInt32

+ const SInt64

+ const StringT

+ const UInt32T

+ const UInt64T

+ func C(wrap int, args ...interface{}) string

+ func C80(args ...interface{}) string

+ func ID(s string) string

+ func Walk(v Visitor, n Node) error

+ type AST interface

+ Lookup func(name string) (Entity, bool)

+ Packages func() map[string]Package

+ Targets func() map[string]File

+ func ProcessCodeGeneratorRequest(debug Debugger, req *plugin_go.CodeGeneratorRequest) AST

+ func ProcessCodeGeneratorRequestBidirectional(debug Debugger, req *plugin_go.CodeGeneratorRequest) AST

+ func ProcessDescriptors(debug Debugger, req *plugin_go.CodeGeneratorRequest) AST

+ func ProcessFileDescriptorSet(debug Debugger, fdset *descriptor.FileDescriptorSet) AST

+ func ProcessFileDescriptorSetBidirectional(debug Debugger, fdset *descriptor.FileDescriptorSet) AST

+ type Artifact interface

+ type BuildContext interface

+ JoinPath func(name ...string) string

+ OutputPath func() string

+ Parameters func() Parameters

+ Pop func() BuildContext

+ PopDir func() BuildContext

+ Push func(prefix string) BuildContext

+ PushDir func(dir string) BuildContext

+ func Context(d Debugger, params Parameters, output string) BuildContext

+ type CustomFile struct

+ Contents string

+ Name string

+ Overwrite bool

+ Perms os.FileMode

+ type CustomTemplateFile struct

+ Name string

+ Overwrite bool

+ Perms os.FileMode

+ type Debugger interface

+ Pop func() Debugger

+ Push func(prefix string) Debugger

+ type DebuggerCommon interface

+ Assert func(expr bool, v ...interface{})

+ CheckErr func(err error, v ...interface{})

+ Debug func(v ...interface{})

+ Debugf func(format string, v ...interface{})

+ Exit func(code int)

+ Fail func(v ...interface{})

+ Failf func(format string, v ...interface{})

+ Log func(v ...interface{})

+ Logf func(format string, v ...interface{})

+ type Entity interface

+ BuildTarget func() bool

+ Extension func(desc *protoimpl.ExtensionInfo, ext interface{}) (ok bool, err error)

+ File func() File

+ FullyQualifiedName func() string

+ Imports func() []File

+ Name func() Name

+ Package func() Package

+ SourceCodeInfo func() SourceCodeInfo

+ Syntax func() Syntax

+ type Enum interface

+ Dependents func() []Message

+ Descriptor func() *descriptor.EnumDescriptorProto

+ Parent func() ParentEntity

+ Values func() []EnumValue

+ type EnumValue interface

+ Descriptor func() *descriptor.EnumValueDescriptorProto

+ Enum func() Enum

+ Value func() int32

+ type Extension interface

+ DefinedIn func() ParentEntity

+ Extendee func() Message

+ type Field interface

+ Descriptor func() *descriptor.FieldDescriptorProto

+ HasOptionalKeyword func() bool

+ HasPresence func() bool

+ InOneOf func() bool

+ InRealOneOf func() bool

+ Message func() Message

+ OneOf func() OneOf

+ Required func() bool

+ Type func() FieldType

+ type FieldType interface

+ Element func() FieldTypeElem

+ Embed func() Message

+ Enum func() Enum

+ Field func() Field

+ Imports func() []File

+ IsEmbed func() bool

+ IsEnum func() bool

+ IsMap func() bool

+ IsOptional func() bool

+ IsRepeated func() bool

+ IsRequired func() bool

+ Key func() FieldTypeElem

+ ProtoLabel func() ProtoLabel

+ ProtoType func() ProtoType

+ type FieldTypeElem interface

+ Embed func() Message

+ Enum func() Enum

+ Imports func() []File

+ IsEmbed func() bool

+ IsEnum func() bool

+ ParentType func() FieldType

+ ProtoType func() ProtoType

+ type File interface

+ Dependents func() []File

+ Descriptor func() *descriptor.FileDescriptorProto

+ InputPath func() FilePath

+ PackageSourceCodeInfo func() SourceCodeInfo

+ Services func() []Service

+ SyntaxSourceCodeInfo func() SourceCodeInfo

+ TransitiveImports func() []File

+ UnusedImports func() []File

+ type FilePath string

+ func JoinPaths(elem ...string) FilePath

+ func (n FilePath) Base() string

+ func (n FilePath) BaseName() string

+ func (n FilePath) Dir() FilePath

+ func (n FilePath) Ext() string

+ func (n FilePath) Pop() FilePath

+ func (n FilePath) Push(elem string) FilePath

+ func (n FilePath) SetBase(base string) FilePath

+ func (n FilePath) SetExt(ext string) FilePath

+ func (n FilePath) String() string

+ type Generator struct

+ func Init(opts ...InitOption) *Generator

+ func (g *Generator) AST() AST

+ func (g *Generator) RegisterModule(m ...Module) *Generator

+ func (g *Generator) RegisterPostProcessor(p ...PostProcessor) *Generator

+ func (g *Generator) Render()

+ type GeneratorAppend struct

+ Contents string

+ FileName string

+ func (f GeneratorAppend) ProtoFile() (*plugin_go.CodeGeneratorResponse_File, error)

+ type GeneratorArtifact interface

+ ProtoFile func() (*plugin_go.CodeGeneratorResponse_File, error)

+ type GeneratorError struct

+ Message string

+ type GeneratorFile struct

+ Contents string

+ Name string

+ Overwrite bool

+ func (f GeneratorFile) ProtoFile() (*plugin_go.CodeGeneratorResponse_File, error)

+ type GeneratorInjection struct

+ Contents string

+ FileName string

+ InsertionPoint string

+ func (f GeneratorInjection) ProtoFile() (*plugin_go.CodeGeneratorResponse_File, error)

+ type GeneratorTemplateAppend struct

+ FileName string

+ func (f GeneratorTemplateAppend) ProtoFile() (*plugin_go.CodeGeneratorResponse_File, error)

+ type GeneratorTemplateFile struct

+ Name string

+ Overwrite bool

+ func (f GeneratorTemplateFile) ProtoFile() (*plugin_go.CodeGeneratorResponse_File, error)

+ type GeneratorTemplateInjection struct

+ FileName string

+ InsertionPoint string

+ func (f GeneratorTemplateInjection) ProtoFile() (*plugin_go.CodeGeneratorResponse_File, error)

+ type InitOption func(g *Generator)

+ func BiDirectional() InitOption

+ func DebugEnv(f string) InitOption

+ func DebugMode() InitOption

+ func FileSystem(fs afero.Fs) InitOption

+ func MutateParams(pm ...ParamMutator) InitOption

+ func ProtocInput(r io.Reader) InitOption

+ func ProtocOutput(w io.Writer) InitOption

+ func SupportedFeatures(feat *uint64) InitOption

+ type Message interface

+ Dependents func() []Message

+ Descriptor func() *descriptor.DescriptorProto

+ Extensions func() []Extension

+ Fields func() []Field

+ IsMapEntry func() bool

+ IsWellKnown func() bool

+ NonOneOfFields func() []Field

+ OneOfFields func() []Field

+ OneOfs func() []OneOf

+ Parent func() ParentEntity

+ RealOneOfs func() []OneOf

+ SyntheticOneOfFields func() []Field

+ WellKnownType func() WellKnownType

+ type Method interface

+ ClientStreaming func() bool

+ Descriptor func() *descriptor.MethodDescriptorProto

+ Input func() Message

+ Output func() Message

+ ServerStreaming func() bool

+ Service func() Service

+ type MockDebugger interface

+ Err func() error

+ ExitCode func() int

+ Exited func() bool

+ Failed func() bool

+ Output func() io.Reader

+ func InitMockDebugger() MockDebugger

+ type Module interface

+ Execute func(targets map[string]File, packages map[string]Package) []Artifact

+ InitContext func(c BuildContext)

+ Name func() string

+ type ModuleBase struct

+ func (m *ModuleBase) AddArtifact(a ...Artifact)

+ func (m *ModuleBase) AddCustomFile(name, content string, perms os.FileMode)

+ func (m *ModuleBase) AddCustomTemplateFile(name string, tpl Template, data interface{}, perms os.FileMode)

+ func (m *ModuleBase) AddError(message string)

+ func (m *ModuleBase) AddGeneratorAppend(name, content string)

+ func (m *ModuleBase) AddGeneratorFile(name, content string)

+ func (m *ModuleBase) AddGeneratorInjection(name, point, content string)

+ func (m *ModuleBase) AddGeneratorTemplateAppend(name string, tpl Template, data interface{})

+ func (m *ModuleBase) AddGeneratorTemplateFile(name string, tpl Template, data interface{})

+ func (m *ModuleBase) AddGeneratorTemplateInjection(name, point string, tpl Template, data interface{})

+ func (m *ModuleBase) Artifacts() []Artifact

+ func (m *ModuleBase) Execute(targets map[string]File, packages map[string]Package) []Artifact

+ func (m *ModuleBase) InitContext(c BuildContext)

+ func (m *ModuleBase) Name() string

+ func (m *ModuleBase) OverwriteCustomFile(name, content string, perms os.FileMode)

+ func (m *ModuleBase) OverwriteCustomTemplateFile(name string, tpl Template, data interface{}, perms os.FileMode)

+ func (m *ModuleBase) OverwriteGeneratorFile(name, content string)

+ func (m *ModuleBase) OverwriteGeneratorTemplateFile(name string, tpl Template, data interface{})

+ func (m *ModuleBase) Pop() BuildContext

+ func (m *ModuleBase) PopDir() BuildContext

+ func (m *ModuleBase) Push(prefix string) BuildContext

+ func (m *ModuleBase) PushDir(dir string) BuildContext

+ type Name string

+ const WellKnownTypePackage

+ func (n Name) LowerCamelCase() Name

+ func (n Name) LowerDotNotation() Name

+ func (n Name) LowerSnakeCase() Name

+ func (n Name) ScreamingSnakeCase() Name

+ func (n Name) SnakeCase() Name

+ func (n Name) Split() (parts []string)

+ func (n Name) String() string

+ func (n Name) Transform(mod, first NameTransformer, sep string) Name

+ func (n Name) UpperCamelCase() Name

+ func (n Name) UpperDotNotation() Name

+ func (n Name) UpperSnakeCase() Name

+ type NameTransformer func(string) string

+ func (n NameTransformer) Chain(t NameTransformer) NameTransformer

+ type Node interface

+ type OneOf interface

+ Descriptor func() *descriptor.OneofDescriptorProto

+ Fields func() []Field

+ IsSynthetic func() bool

+ Message func() Message

+ type Package interface

+ Files func() []File

+ ProtoName func() Name

+ type ParamMutator func(p Parameters)

+ type Parameters map[string]string

+ func ParseParameters(p string) (params Parameters)

+ func (p Parameters) Bool(name string) (bool, error)

+ func (p Parameters) BoolDefault(name string, def bool) (bool, error)

+ func (p Parameters) Clone() Parameters

+ func (p Parameters) Duration(name string) (time.Duration, error)

+ func (p Parameters) DurationDefault(name string, def time.Duration) (time.Duration, error)

+ func (p Parameters) Float(name string) (float64, error)

+ func (p Parameters) FloatDefault(name string, def float64) (float64, error)

+ func (p Parameters) Int(name string) (int, error)

+ func (p Parameters) IntDefault(name string, def int) (int, error)

+ func (p Parameters) OutputPath() string

+ func (p Parameters) SetBool(name string, b bool)

+ func (p Parameters) SetDuration(name string, d time.Duration)

+ func (p Parameters) SetFloat(name string, f float64)

+ func (p Parameters) SetInt(name string, i int)

+ func (p Parameters) SetOutputPath(path string)

+ func (p Parameters) SetStr(name string, s string)

+ func (p Parameters) SetUint(name string, ui uint)

+ func (p Parameters) Str(name string) string

+ func (p Parameters) StrDefault(name string, def string) string

+ func (p Parameters) String() string

+ func (p Parameters) Uint(name string) (uint, error)

+ func (p Parameters) UintDefault(name string, def uint) (uint, error)

+ type ParentEntity interface

+ AllEnums func() []Enum

+ AllMessages func() []Message

+ DefinedExtensions func() []Extension

+ Enums func() []Enum

+ MapEntries func() []Message

+ Messages func() []Message

+ type PostProcessor interface

+ Match func(a Artifact) bool

+ Process func(in []byte) ([]byte, error)

+ type ProtoLabel descriptor.FieldDescriptorProto_Label

+ func (pl ProtoLabel) Proto() descriptor.FieldDescriptorProto_Label

+ func (pl ProtoLabel) ProtoPtr() *descriptor.FieldDescriptorProto_Label

+ func (pl ProtoLabel) String() string

+ type ProtoType descriptor.FieldDescriptorProto_Type

+ func (pt ProtoType) IsInt() bool

+ func (pt ProtoType) IsNumeric() bool

+ func (pt ProtoType) Proto() descriptor.FieldDescriptorProto_Type

+ func (pt ProtoType) ProtoPtr() *descriptor.FieldDescriptorProto_Type

+ func (pt ProtoType) String() string

+ type Service interface

+ Descriptor func() *descriptor.ServiceDescriptorProto

+ Methods func() []Method

+ type SourceCodeInfo interface

+ LeadingComments func() string

+ LeadingDetachedComments func() []string

+ Location func() *descriptor.SourceCodeInfo_Location

+ TrailingComments func() string

+ type Syntax string

+ const Proto2

+ const Proto3

+ func (s Syntax) String() string

+ func (s Syntax) SupportsRequiredPrefix() bool

+ type Template interface

+ Execute func(w io.Writer, data interface{}) error

+ type TemplateArtifact struct

+ Data interface{}

+ Template Template

+ type Visitor interface

+ VisitEnum func(Enum) (v Visitor, err error)

+ VisitEnumValue func(EnumValue) (v Visitor, err error)

+ VisitExtension func(Extension) (v Visitor, err error)

+ VisitField func(Field) (v Visitor, err error)

+ VisitFile func(File) (v Visitor, err error)

+ VisitMessage func(Message) (v Visitor, err error)

+ VisitMethod func(Method) (v Visitor, err error)

+ VisitOneOf func(OneOf) (v Visitor, err error)

+ VisitPackage func(Package) (v Visitor, err error)

+ VisitService func(Service) (v Visitor, err error)

+ func NilVisitor() Visitor

+ func PassThroughVisitor(v Visitor) Visitor

+ type WellKnownType Name

+ const AnyWKT

+ const BoolValueWKT

+ const BytesValueWKT

+ const DoubleValueWKT

+ const DurationWKT

+ const EmptyWKT

+ const FloatValueWKT

+ const Int32ValueWKT

+ const Int64ValueWKT

+ const ListValueWKT

+ const StringValueWKT

+ const StructWKT

+ const TimestampWKT

+ const UInt32ValueWKT

+ const UInt64ValueWKT

+ const UnknownWKT

+ const ValueWKT

+ func LookupWKT(n Name) WellKnownType

+ func (wkt WellKnownType) Name() Name

+ func (wkt WellKnownType) Valid() bool

v2.0.0-alpha.1

Aug 16, 2022

Other modules containing this package

github.com/lyft/protoc-gen-star