pluginutils

Documentation

Index

• func FindFieldByTextName(msg *protogen.Message, name string) *protogen.Field
• type FileGenerator
  • func (opt FileGenerator) P(v ...any)
  • func (opt FileGenerator) PComment(comments ...string)
  • func (opt FileGenerator) PCommentf(format string, args ...interface{})
  • func (opt FileGenerator) PTmpl(tmpl *template.Template, data interface{}, funcs ...template.FuncMap)
  • func (opt FileGenerator) PTmplStr(tmpl string, data interface{}, funcs ...template.FuncMap)
  • func (opt FileGenerator) Pf(format string, v ...any)
• type ForEachFileRunner
• type GenerateOptions
  • func (opt GenerateOptions) PHeader(p *protogen.Plugin)
  • func (opt GenerateOptions) PPackage()
• type PluginInfo
• type PreForEachFileRunner
  • func NewForEachFileRunner(info PluginInfo) PreForEachFileRunner

Functions

func FindFieldByTextName

func FindFieldByTextName(msg *protogen.Message, name string) *protogen.Field

Types

type FileGenerator

type FileGenerator struct {
	W *protogen.GeneratedFile // The file to write to
	F *protogen.File          // The proto file descr
}

func (FileGenerator) P

func (opt FileGenerator) P(v ...any)

P is a shorthand for (*protogen.GeneratedFile).P()

func (FileGenerator) PComment

func (opt FileGenerator) PComment(comments ...string)

PComment allows multiple lines string as comment.

func (FileGenerator) PCommentf

func (opt FileGenerator) PCommentf(format string, args ...interface{})

PCommentf allows formatted string as comment.

func (FileGenerator) PTmpl

func (opt FileGenerator) PTmpl(tmpl *template.Template, data interface{}, funcs ...template.FuncMap)

func (FileGenerator) PTmplStr

func (opt FileGenerator) PTmplStr(tmpl string, data interface{}, funcs ...template.FuncMap)

func (FileGenerator) Pf

func (opt FileGenerator) Pf(format string, v ...any)

Pf is same as P, but with formatted string.

type ForEachFileRunner

type ForEachFileRunner interface {
	Run(fn func(genOpt GenerateOptions) error)
}

type GenerateOptions

type GenerateOptions struct {
	FileGenerator
	PluginInfo
}

func (GenerateOptions) PHeader

func (opt GenerateOptions) PHeader(p *protogen.Plugin)

func (GenerateOptions) PPackage

func (opt GenerateOptions) PPackage()

type PluginInfo

type PluginInfo struct {
	PluginName        string
	VersionStr        string
	GenFileSuffix     string
	SupportedFeatures uint64
}

type PreForEachFileRunner

type PreForEachFileRunner interface {
	ForEachFileThat(fn func(protoFile *protogen.File) bool) ForEachFileRunner
}

func NewForEachFileRunner

func NewForEachFileRunner(info PluginInfo) PreForEachFileRunner

ForEachFileRunner helps to generate one file for each file that is being generated