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]) 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]
- type StaticFlag
- func (s *StaticFlag[T]) AllOrNone(name string) *StaticFlag[T]
- func (s *StaticFlag[T]) Allowed(vals ...string) *StaticFlag[T]
- func (s *StaticFlag[T]) Deprecated(reason string) *StaticFlag[T]
- func (s *StaticFlag[T]) DisableEnv() *StaticFlag[T]
- func (s *StaticFlag[T]) Env(key string) *StaticFlag[T]
- func (s *StaticFlag[T]) Hidden() *StaticFlag[T]
- func (s *StaticFlag[T]) HideAllowed() *StaticFlag[T]
- func (s *StaticFlag[T]) HideRequired() *StaticFlag[T]
- func (s *StaticFlag[T]) HideRequires() *StaticFlag[T]
- func (s *StaticFlag[T]) OneOfGroup(name string) *StaticFlag[T]
- func (b *StaticFlag[T]) Placeholder(s string) *StaticFlag[T]
- func (s *StaticFlag[T]) Required() *StaticFlag[T]
- func (s *StaticFlag[T]) Requires(names ...string) *StaticFlag[T]
- func (b *StaticFlag[T]) Short(s string) *StaticFlag[T]
- func (s *StaticFlag[T]) 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]) 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.
type StaticFlag ¶
type StaticFlag[T any] struct { // contains filtered or unexported fields }
StaticFlag provides common builder methods for scalar and slice flags.
func NewStaticFlag ¶ added in v0.0.9
NewStaticFlag returns a DefaultFlag ready for embedding.
func (*StaticFlag[T]) AllOrNone ¶ added in v0.0.36
func (s *StaticFlag[T]) AllOrNone(name string) *StaticFlag[T]
AllOrNone assigns this flag to a require-together group.
func (*StaticFlag[T]) Allowed ¶
func (s *StaticFlag[T]) Allowed(vals ...string) *StaticFlag[T]
Allowed restricts help to show only these formatted values.
func (*StaticFlag[T]) Deprecated ¶
func (s *StaticFlag[T]) Deprecated(reason string) *StaticFlag[T]
Deprecated adds a deprecation notice.
func (*StaticFlag[T]) DisableEnv ¶
func (s *StaticFlag[T]) DisableEnv() *StaticFlag[T]
DisableEnv turns off environment‐variable lookup.
func (*StaticFlag[T]) Env ¶
func (s *StaticFlag[T]) Env(key string) *StaticFlag[T]
Env sets a custom environment‐variable key.
func (*StaticFlag[T]) Hidden ¶
func (s *StaticFlag[T]) Hidden() *StaticFlag[T]
Hidden omits the flag from help output.
func (*StaticFlag[T]) HideAllowed ¶ added in v0.0.39
func (s *StaticFlag[T]) HideAllowed() *StaticFlag[T]
HideAllowed hides the allowed values from help.
func (*StaticFlag[T]) HideRequired ¶ added in v0.0.39
func (s *StaticFlag[T]) HideRequired() *StaticFlag[T]
HideRequired hides the “(Required)” suffix from help.
func (*StaticFlag[T]) HideRequires ¶ added in v0.0.46
func (s *StaticFlag[T]) HideRequires() *StaticFlag[T]
HideRequires hides the “(Requires)” suffix from help.
func (*StaticFlag[T]) OneOfGroup ¶ added in v0.0.36
func (s *StaticFlag[T]) OneOfGroup(name string) *StaticFlag[T]
OneOfGroup assigns this flag to an exclusive group.
func (*StaticFlag[T]) Placeholder ¶
func (b *StaticFlag[T]) Placeholder(s string) *StaticFlag[T]
Placeholder customizes the value placeholder in usage.
func (*StaticFlag[T]) Required ¶
func (s *StaticFlag[T]) Required() *StaticFlag[T]
Required marks the flag as mandatory.
func (*StaticFlag[T]) Requires ¶ added in v0.0.46
func (s *StaticFlag[T]) Requires(names ...string) *StaticFlag[T]
Requires marks this flag as required by the given flag.
func (*StaticFlag[T]) Short ¶
func (b *StaticFlag[T]) Short(s string) *StaticFlag[T]
Short sets the one‐letter alias for this flag. Panics if you pass an empty or multi-rune string.
func (*StaticFlag[T]) Value ¶
func (s *StaticFlag[T]) Value() *T
Value exposes the underlying pointer for reading.
Source Files