sflag

Documentation

Index

• Constants
• func UsageFunc(groups ...*Group) func() string
• type Flag
• type FlagOption
  • func WithDenyDuplicate() FlagOption
• type FlagRef
• type FlagSet
  • func NewFlagSet(name string) *FlagSet
  • func (f *FlagSet) Args() []string
  • func (f *FlagSet) Bool(name, usage string) FlagRef[bool]
  • func (f *FlagSet) FixedStringFlags(name, usage string) FlagRef[[][2]string]
  • func (f *FlagSet) Lookup(name string) *Flag
  • func (f *FlagSet) NewGroup(name string) *Group
  • func (f *FlagSet) Parse(args []string) error
  • func (f *FlagSet) String(name, usage string) FlagRef[string]
  • func (f *FlagSet) StringFlags(name, usage string) FlagRef[[]string]
  • func (f *FlagSet) Strings(name, usage string) FlagRef[[]string]
  • func (f *FlagSet) Var(v Value, name, usage string, opts ...FlagOption) *Flag
• type FlagType
  • func (t FlagType) String() string
• type Group
  • func LookupGroup(groups ...*Group) (*Group, error)
  • func (g *Group) AddDescription(s string) *Group
  • func (g *Group) AddOptional(flag *Flag) *Group
  • func (g *Group) AddRequired(flag *Flag) *Group
  • func (g *Group) Lookup(name string) *Flag
  • func (g *Group) LookupByType(typ FlagType) []*Flag
  • func (g *Group) NonGroupFlagNames() []string
  • func (g *Group) Seen(name string) bool
  • func (g *Group) Usage() string
• type Value
  • func Bool(p *bool) Value
  • func FixedStringFlags(p *[][2]string) Value
  • func FlagValue[T any](p *T, from func(v string) (T, error)) Value
  • func String(p *string) Value
  • func StringFlags(p *[]string) Value
  • func Strings(p *[]string) Value
• type Values
  • func FlagValues[T any](p *T, from func(v string) (T, error), cap func() int) Values

Constants

const (
	CapNoLimit = -1
)

Functions

func UsageFunc

func UsageFunc(groups ...*Group) func() string

Types

type Flag

type Flag struct {
	Name  string
	Usage string
	Value Value
	// contains filtered or unexported fields
}

type FlagOption

type FlagOption func(*Flag)

func WithDenyDuplicate

func WithDenyDuplicate() FlagOption

type FlagRef

type FlagRef[T any] struct {
	Value func() T
	Flag  func() *Flag
}

type FlagSet

type FlagSet struct {
	Usage func() string
	// contains filtered or unexported fields
}

func NewFlagSet

func NewFlagSet(name string) *FlagSet

func (*FlagSet) Args

func (f *FlagSet) Args() []string

func (*FlagSet) Bool

func (f *FlagSet) Bool(name, usage string) FlagRef[bool]

Bool presents `-flag“ NOT `-flag true/false`

func (*FlagSet) FixedStringFlags

func (f *FlagSet) FixedStringFlags(name, usage string) FlagRef[[][2]string]

FixedStringFlags presents `-flag <value1> <value2> -flag <value3> <value4> -flag ...` This is a reference implementation

func (*FlagSet) Lookup

func (f *FlagSet) Lookup(name string) *Flag

func (*FlagSet) NewGroup

func (f *FlagSet) NewGroup(name string) *Group

func (*FlagSet) Parse

func (f *FlagSet) Parse(args []string) error

func (*FlagSet) String

func (f *FlagSet) String(name, usage string) FlagRef[string]

String presents `-flag <value>`

func (*FlagSet) StringFlags

func (f *FlagSet) StringFlags(name, usage string) FlagRef[[]string]

StringFlags presents `-flag <value1> -flag <value2> -flag <value3> -flag ...`

func (*FlagSet) Strings

func (f *FlagSet) Strings(name, usage string) FlagRef[[]string]

Strings presents `-flag <value1> <value2> <value3> ...`

func (*FlagSet) Var

func (f *FlagSet) Var(v Value, name, usage string, opts ...FlagOption) *Flag

type FlagType

type FlagType int

const (
	TypeRequired FlagType = iota + 1
	TypeOptional
)

func (FlagType) String

func (t FlagType) String() string

type Group

type Group struct {
	Name string
	// contains filtered or unexported fields
}

func LookupGroup

func LookupGroup(groups ...*Group) (*Group, error)

func (*Group) AddDescription

func (g *Group) AddDescription(s string) *Group

func (*Group) AddOptional

func (g *Group) AddOptional(flag *Flag) *Group

func (*Group) AddRequired

func (g *Group) AddRequired(flag *Flag) *Group

func (*Group) Lookup

func (g *Group) Lookup(name string) *Flag

func (*Group) LookupByType

func (g *Group) LookupByType(typ FlagType) []*Flag

func (*Group) NonGroupFlagNames

func (g *Group) NonGroupFlagNames() []string

NonGroupFlagNames returns non group flag with specified

func (*Group) Seen

func (g *Group) Seen(name string) bool

func (*Group) Usage

func (g *Group) Usage() string

type Value

type Value interface {
	Set(string) error
	Get() any
}

func Bool

func Bool(p *bool) Value

func FixedStringFlags

func FixedStringFlags(p *[][2]string) Value

func FlagValue

func FlagValue[T any](p *T, from func(v string) (T, error)) Value

func String

func String(p *string) Value

func StringFlags

func StringFlags(p *[]string) Value

func Strings

func Strings(p *[]string) Value

type Values

type Values interface {
	Value
	Cap() int
}

func FlagValues

func FlagValues[T any](p *T, from func(v string) (T, error), cap func() int) Values