pluginutils

Documentation

Index

• Constants
• func EndWithDefault(field protoreflect.FieldDescriptor) bool
• func EndWithJsonScalar(field protoreflect.FieldDescriptor) bool
• func GetField(msg *protogen.Message, path string) *protogen.Field
• func GetFieldProtoreflect(md protoreflect.MessageDescriptor, path string) protoreflect.FieldDescriptor
• func Intersect(mx []string, my []string, ms ...[]string) []string
• func JsonFieldPath(rootMsg *protogen.Message) func(path string) string
• func ListAllPaths(msg protoreflect.MessageDescriptor) []string
• func ListPaths(prefix string, msg protoreflect.MessageDescriptor, endWith ListPathEndWith) []string
• func RangeField(msg descriptorx.MessageDescriptor, path string, ...) bool
• func RangeFieldPath(path string, f func(field string, restPath string) bool) bool
• func Substract(mx []string, my []string, ms ...[]string) []string
• func Union(mx []string, my []string, ms ...[]string) []string
• 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 ListPathEndWith
• type PluginInfo
• type PreForEachFileRunner
  • func NewForEachFileRunner(info PluginInfo) PreForEachFileRunner

Constants

const ListPathDepthMax = 10

Functions

func EndWithDefault

func EndWithDefault(field protoreflect.FieldDescriptor) bool

func EndWithJsonScalar

func EndWithJsonScalar(field protoreflect.FieldDescriptor) bool

func GetField

func GetField(msg *protogen.Message, path string) *protogen.Field

func GetFieldProtoreflect

func GetFieldProtoreflect(md protoreflect.MessageDescriptor, path string) protoreflect.FieldDescriptor

func Intersect

func Intersect(mx []string, my []string, ms ...[]string) []string

Intersect returns the intersection of all the paths in the input field masks.

func JsonFieldPath

func JsonFieldPath(rootMsg *protogen.Message) func(path string) string

func ListAllPaths

func ListAllPaths(msg protoreflect.MessageDescriptor) []string

func ListPaths

func ListPaths(prefix string, msg protoreflect.MessageDescriptor, endWith ListPathEndWith) []string

func RangeField

func RangeField(msg descriptorx.MessageDescriptor, path string, fn func(field descriptorx.FieldDescriptor, restPath string) bool) bool

func RangeFieldPath

func RangeFieldPath(path string, f func(field string, restPath string) bool) bool

RangeFieldPath is like strings.Split(path, "."), but avoids allocations by iterating over each field in place and calling a iterator function.

func Substract

func Substract(mx []string, my []string, ms ...[]string) []string

func Union

func Union(mx []string, my []string, ms ...[]string) []string

Union returns the union of all the paths in the input field masks.

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 ListPathEndWith

type ListPathEndWith func(field protoreflect.FieldDescriptor) bool

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