Documentation
¶
Index ¶
- type DynamicFlag
- func (d *DynamicFlag[T]) AllOrNone(name string) *DynamicFlag[T]
- func (d *DynamicFlag[T]) Allowed(vals ...string) *DynamicFlag[T]
- func (d *DynamicFlag[T]) Deprecated(reason string) *DynamicFlag[T]
- func (d *DynamicFlag[T]) DisableEnv() *DynamicFlag[T]
- func (d *DynamicFlag[T]) Env(key string) *DynamicFlag[T]
- func (d *DynamicFlag[T]) Hidden() *DynamicFlag[T]
- func (d *DynamicFlag[T]) HideAllowed() *DynamicFlag[T]
- func (d *DynamicFlag[T]) HideDefault() *DynamicFlag[T]
- func (d *DynamicFlag[T]) HideRequired() *DynamicFlag[T]
- func (d *DynamicFlag[T]) HideRequires() *DynamicFlag[T]
- func (d *DynamicFlag[T]) OneOfGroup(name string) *DynamicFlag[T]
- func (d *DynamicFlag[T]) Placeholder(s string) *DynamicFlag[T]
- func (d *DynamicFlag[T]) Required() *DynamicFlag[T]
- func (d *DynamicFlag[T]) Requires(names ...string) *DynamicFlag[T]
- func (d *DynamicFlag[T]) Section(name string) *DynamicFlag[T]
- type StaticFlag
- func (s *StaticFlag[T, Self]) AllOrNone(name string) Self
- func (s *StaticFlag[T, Self]) Allowed(vals ...string) Self
- func (s *StaticFlag[T, Self]) Deprecated(reason string) Self
- func (s *StaticFlag[T, Self]) DisableEnv() Self
- func (s *StaticFlag[T, Self]) Env(key string) Self
- func (s *StaticFlag[T, Self]) Hidden() Self
- func (s *StaticFlag[T, Self]) HideAllowed() Self
- func (s *StaticFlag[T, Self]) HideDefault() Self
- func (s *StaticFlag[T, Self]) HideRequired() Self
- func (s *StaticFlag[T, Self]) HideRequires() Self
- func (s *StaticFlag[T, Self]) OneOfGroup(name string) Self
- func (b *StaticFlag[T, Self]) Placeholder(s string) Self
- func (s *StaticFlag[T, Self]) Required() Self
- func (s *StaticFlag[T, Self]) Requires(names ...string) Self
- func (b *StaticFlag[T, Self]) Section(name string) Self
- func (b *StaticFlag[T, Self]) Short(s string) Self
- func (s *StaticFlag[T, Self]) Value() *T
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DynamicFlag ¶
type DynamicFlag[T any] struct { // contains filtered or unexported fields }
DynamicFlag provides common builder methods for dynamic flags.
func NewDynamicFlag ¶
NewDynamicFlag returns a DynamicFlag ready for embedding.
func (*DynamicFlag[T]) AllOrNone ¶ added in v0.0.36
func (d *DynamicFlag[T]) AllOrNone(name string) *DynamicFlag[T]
AllOrNone assigns this flag to a require-together group.
func (*DynamicFlag[T]) Allowed ¶
func (d *DynamicFlag[T]) Allowed(vals ...string) *DynamicFlag[T]
Allowed restricts help to show only these formatted values.
func (*DynamicFlag[T]) Deprecated ¶
func (d *DynamicFlag[T]) Deprecated(reason string) *DynamicFlag[T]
Deprecated adds a deprecation notice.
func (*DynamicFlag[T]) DisableEnv ¶
func (d *DynamicFlag[T]) DisableEnv() *DynamicFlag[T]
DisableEnv turns off environment‐variable lookup.
func (*DynamicFlag[T]) Env ¶
func (d *DynamicFlag[T]) Env(key string) *DynamicFlag[T]
Env sets a custom environment‐variable key.
func (*DynamicFlag[T]) Hidden ¶
func (d *DynamicFlag[T]) Hidden() *DynamicFlag[T]
Hidden omits the flag from help output.
func (*DynamicFlag[T]) HideAllowed ¶ added in v0.0.39
func (d *DynamicFlag[T]) HideAllowed() *DynamicFlag[T]
HideAllowed hides the allowed values from help.
func (*DynamicFlag[T]) HideDefault ¶ added in v0.0.52
func (d *DynamicFlag[T]) HideDefault() *DynamicFlag[T]
HideDefault hides the default value from help output.
func (*DynamicFlag[T]) HideRequired ¶ added in v0.0.39
func (d *DynamicFlag[T]) HideRequired() *DynamicFlag[T]
HideRequired hides the “(Required)” suffix from help.
func (*DynamicFlag[T]) HideRequires ¶ added in v0.0.46
func (d *DynamicFlag[T]) HideRequires() *DynamicFlag[T]
HideRequires hides the “(Requires)” suffix from help.
func (*DynamicFlag[T]) OneOfGroup ¶ added in v0.0.36
func (d *DynamicFlag[T]) OneOfGroup(name string) *DynamicFlag[T]
OneOfGroup assigns this flag to an exclusive group.
func (*DynamicFlag[T]) Placeholder ¶
func (d *DynamicFlag[T]) Placeholder(s string) *DynamicFlag[T]
Placeholder customizes the value placeholder in usage.
func (*DynamicFlag[T]) Required ¶
func (d *DynamicFlag[T]) Required() *DynamicFlag[T]
Required marks the flag as mandatory.
func (*DynamicFlag[T]) Requires ¶ added in v0.0.46
func (d *DynamicFlag[T]) Requires(names ...string) *DynamicFlag[T]
Requires marks this flag as required by the given flag.
func (*DynamicFlag[T]) Section ¶ added in v0.0.52
func (d *DynamicFlag[T]) Section(name string) *DynamicFlag[T]
Section assigns this flag to a help section.
type StaticFlag ¶
StaticFlag provides common builder methods for scalar and slice flags. The Self type parameter allows fluent methods to return the concrete flag type.
func NewStaticFlag ¶ added in v0.0.9
func NewStaticFlag[T any, Self any](reg core.Registry, bf *core.BaseFlag, ptr *T, self Self) StaticFlag[T, Self]
NewStaticFlag returns a DefaultFlag ready for embedding. Pass the concrete flag as self to keep fluent chaining on that type.
func (*StaticFlag[T, Self]) AllOrNone ¶ added in v0.0.36
func (s *StaticFlag[T, Self]) AllOrNone(name string) Self
AllOrNone assigns this flag to a require-together group.
func (*StaticFlag[T, Self]) Allowed ¶
func (s *StaticFlag[T, Self]) Allowed(vals ...string) Self
Allowed restricts help to show only these formatted values.
func (*StaticFlag[T, Self]) Deprecated ¶
func (s *StaticFlag[T, Self]) Deprecated(reason string) Self
Deprecated adds a deprecation notice.
func (*StaticFlag[T, Self]) DisableEnv ¶
func (s *StaticFlag[T, Self]) DisableEnv() Self
DisableEnv turns off environment‐variable lookup.
func (*StaticFlag[T, Self]) Env ¶
func (s *StaticFlag[T, Self]) Env(key string) Self
Env sets a custom environment‐variable key.
func (*StaticFlag[T, Self]) Hidden ¶
func (s *StaticFlag[T, Self]) Hidden() Self
Hidden omits the flag from help output.
func (*StaticFlag[T, Self]) HideAllowed ¶ added in v0.0.39
func (s *StaticFlag[T, Self]) HideAllowed() Self
HideAllowed hides the allowed values from help.
func (*StaticFlag[T, Self]) HideDefault ¶ added in v0.0.52
func (s *StaticFlag[T, Self]) HideDefault() Self
HideDefault hides the default value from help output.
func (*StaticFlag[T, Self]) HideRequired ¶ added in v0.0.39
func (s *StaticFlag[T, Self]) HideRequired() Self
HideRequired hides the "(Required)" suffix from help.
func (*StaticFlag[T, Self]) HideRequires ¶ added in v0.0.46
func (s *StaticFlag[T, Self]) HideRequires() Self
HideRequires hides the "(Requires)" suffix from help.
func (*StaticFlag[T, Self]) OneOfGroup ¶ added in v0.0.36
func (s *StaticFlag[T, Self]) OneOfGroup(name string) Self
OneOfGroup assigns this flag to an exclusive group.
func (*StaticFlag[T, Self]) Placeholder ¶
func (b *StaticFlag[T, Self]) Placeholder(s string) Self
Placeholder customizes the value placeholder in usage.
func (*StaticFlag[T, Self]) Required ¶
func (s *StaticFlag[T, Self]) Required() Self
Required marks the flag as mandatory.
func (*StaticFlag[T, Self]) Requires ¶ added in v0.0.46
func (s *StaticFlag[T, Self]) Requires(names ...string) Self
Requires marks this flag as required by the given flag.
func (*StaticFlag[T, Self]) Section ¶ added in v0.0.52
func (b *StaticFlag[T, Self]) Section(name string) Self
Section assigns this flag to a help section.
func (*StaticFlag[T, Self]) Short ¶
func (b *StaticFlag[T, Self]) Short(s string) Self
Short sets the one‐letter alias for this flag. Panics if you pass an empty or multi-rune string.
func (*StaticFlag[T, Self]) Value ¶
func (s *StaticFlag[T, Self]) Value() *T
Value exposes the underlying pointer for reading.
Source Files