descriptors

Documentation

Index

• func BuildMessage[T any](opts ...BuilderOptions) []*builder.MessageBuilder
• type Builder
  • func (b *Builder) BuildMessage(msgType reflect.Type, ...) *builder.MessageBuilder
• type BuilderOptions
• type FlagRegistrar
• type FlagSet

Functions

func BuildMessage

func BuildMessage[T any](opts ...BuilderOptions) []*builder.MessageBuilder

Types

type Builder

type Builder struct {
	BuilderOptions
	// contains filtered or unexported fields
}

func (*Builder) BuildMessage

func (b *Builder) BuildMessage(msgType reflect.Type, newFieldHook func(f *builder.FieldBuilder, rf reflect.StructField)) *builder.MessageBuilder

type BuilderOptions

type BuilderOptions struct {
	// Tags to use to get field names, in order of preference.
	FieldNameFromTags []string
	// Called for each field. The provided options can be modified before
	// the field is added to the message by returning a mutator function.
	EditFlagOptions func(rf reflect.StructField) func(*cli.FlagOptions)
	// Called for each field. The provided comment can be modified before
	// the field is added to the message.
	EditFieldComment func(rf reflect.StructField, in *string)
	// Called for each field. If it returns true, the field will be skipped.
	SkipFieldFunc func(rf reflect.StructField) bool
}

type FlagRegistrar

type FlagRegistrar[FS FlagSet[F], F any] interface {
	RegisterFlags(flags FS)
}

type FlagSet

type FlagSet[F any] interface {
	VisitAll(func(F))
}