ask

package module

Go to main page

Versions in this module

v0

v0.2.0

Jun 16, 2024

v0.1.3

Jan 25, 2022

Changes in this version

+ func Run(cmd interface{})

v0.1.2

Jul 9, 2021

v0.1.1

Jul 9, 2021

v0.1.0

Jul 5, 2021

Changes in this version

+ var HelpErr = errors.New("ask: help asked with flag")

+ func FlagValue(typ reflect.Type, val reflect.Value) (flag.Value, error)

+ func ParseArgs(sortedShort []PrefixedFlag, sortedLong []PrefixedFlag, args []string, ...) (remaining []string, err error)

+ func ParseIPv4Mask(s string) net.IPMask

+ func ParseLongArg(sortedFlags []PrefixedFlag, firstArg string, args []string, fn ApplyArg) (nextArgs []string, err error)

+ func ParseShortArg(sortedFlags []PrefixedFlag, firstArg string, args []string, fn ApplyArg) (nextArgs []string, err error)

+ type ApplyArg func(fl PrefixedFlag, value string) error

+ type BoolSliceValue []bool

+ func (s *BoolSliceValue) Set(val string) error

+ func (s *BoolSliceValue) String() string

+ func (s *BoolSliceValue) Type() string

+ type BoolValue bool

+ func (b *BoolValue) Implicit() string

+ func (b *BoolValue) Set(s string) error

+ func (b *BoolValue) String() string

+ func (b *BoolValue) Type() string

+ type ChangedMarkers map[string][]*bool

+ type DurationSliceValue []time.Duration

+ func (s *DurationSliceValue) Set(val string) error

+ func (s *DurationSliceValue) String() string

+ func (s *DurationSliceValue) Type() string

+ type DurationValue time.Duration

+ func (d *DurationValue) Set(s string) error

+ func (d *DurationValue) String() string

+ func (d *DurationValue) Type() string

+ type ExecutionOptions struct

+ OnDeprecated func(fl PrefixedFlag) error

+ type Flag struct

+ Default string

+ Deprecated string

+ Help string

+ Hidden bool

+ IsArg bool

+ Name string

+ Required bool

+ Shorthand uint8

+ Value flag.Value

+ func LoadField(f reflect.StructField, val reflect.Value) (fl *Flag, err error)

+ type FlagGroup struct

+ Entries []*FlagGroup

+ Flags []*Flag

+ GroupName string

+ func LoadGroup(name string, val reflect.Value, changes ChangedMarkers) (*FlagGroup, error)

+ func (g *FlagGroup) All(prefix string) []PrefixedFlag

+ func (g *FlagGroup) Usage(prefix string, showHidden bool, out *strings.Builder)

+ type Float32SliceValue []float32

+ func (s *Float32SliceValue) Set(val string) error

+ func (s *Float32SliceValue) String() string

+ func (s *Float32SliceValue) Type() string

+ type Float32Value float32

+ func (f *Float32Value) Set(s string) error

+ func (f *Float32Value) String() string

+ func (f *Float32Value) Type() string

+ type Float64SliceValue []float64

+ func (s *Float64SliceValue) Set(val string) error

+ func (s *Float64SliceValue) String() string

+ func (s *Float64SliceValue) Type() string

+ type Float64Value float64

+ func (f *Float64Value) Set(s string) error

+ func (f *Float64Value) String() string

+ func (f *Float64Value) Type() string

+ type IPMaskValue net.IPMask

+ func (i *IPMaskValue) Set(s string) error

+ func (i *IPMaskValue) String() string

+ func (i *IPMaskValue) Type() string

+ type IPNetValue net.IPNet

+ func (*IPNetValue) Type() string

+ func (ipnet *IPNetValue) Set(s string) error

+ func (ipnet IPNetValue) String() string

+ type IPSliceValue []net.IP

+ func (s *IPSliceValue) Set(val string) error

+ func (s *IPSliceValue) String() string

+ func (s *IPSliceValue) Type() string

+ type IPValue net.IP

+ func (i *IPValue) Set(s string) error

+ func (i *IPValue) String() string

+ func (i *IPValue) Type() string

+ type ImplicitValue interface

+ Implicit func() string

+ type InlineHelp string

+ func (v InlineHelp) Help() string

+ type Int16SliceValue []int16

+ func (s *Int16SliceValue) Set(val string) error

+ func (s *Int16SliceValue) String() string

+ func (s *Int16SliceValue) Type() string

+ type Int16Value int16

+ func (i *Int16Value) Set(s string) error

+ func (i *Int16Value) String() string

+ func (i *Int16Value) Type() string

+ type Int32SliceValue []int32

+ func (s *Int32SliceValue) Set(val string) error

+ func (s *Int32SliceValue) String() string

+ func (s *Int32SliceValue) Type() string

+ type Int32Value int32

+ func (i *Int32Value) Set(s string) error

+ func (i *Int32Value) String() string

+ func (i *Int32Value) Type() string

+ type Int64SliceValue []int64

+ func (s *Int64SliceValue) Set(val string) error

+ func (s *Int64SliceValue) String() string

+ func (s *Int64SliceValue) Type() string

+ type Int64Value int64

+ func (i *Int64Value) Set(s string) error

+ func (i *Int64Value) String() string

+ func (i *Int64Value) Type() string

+ type Int8SliceValue []int8

+ func (s *Int8SliceValue) Set(val string) error

+ func (s *Int8SliceValue) String() string

+ func (s *Int8SliceValue) Type() string

+ type Int8Value int8

+ func (i *Int8Value) Set(s string) error

+ func (i *Int8Value) String() string

+ func (i *Int8Value) Type() string

+ type IntSliceValue []int

+ func (s *IntSliceValue) Set(val string) error

+ func (s *IntSliceValue) String() string

+ func (s *IntSliceValue) Type() string

+ type IntValue int

+ func (i *IntValue) Set(s string) error

+ func (i *IntValue) String() string

+ func (i *IntValue) Type() string

+ type PrefixedFlag struct

+ Path string

+ type StringSliceValue []string

+ func (s *StringSliceValue) Set(val string) error

+ func (s *StringSliceValue) String() string

+ func (s *StringSliceValue) Type() string

+ type StringValue string

+ func (s *StringValue) Set(val string) error

+ func (s *StringValue) String() string

+ func (s *StringValue) Type() string

+ type TypedValue interface

+ Type func() string

+ type Uint16SliceValue []uint16

+ func (s *Uint16SliceValue) Set(val string) error

+ func (s *Uint16SliceValue) String() string

+ func (s *Uint16SliceValue) Type() string

+ type Uint16Value uint16

+ func (i *Uint16Value) Set(s string) error

+ func (i *Uint16Value) String() string

+ func (i *Uint16Value) Type() string

+ type Uint32SliceValue []uint32

+ func (s *Uint32SliceValue) Set(val string) error

+ func (s *Uint32SliceValue) String() string

+ func (s *Uint32SliceValue) Type() string

+ type Uint32Value uint32

+ func (i *Uint32Value) Set(s string) error

+ func (i *Uint32Value) String() string

+ func (i *Uint32Value) Type() string

+ type Uint64SliceValue []uint64

+ func (s *Uint64SliceValue) Set(val string) error

+ func (s *Uint64SliceValue) String() string

+ func (s *Uint64SliceValue) Type() string

+ type Uint64Value uint64

+ func (i *Uint64Value) Set(s string) error

+ func (i *Uint64Value) String() string

+ func (i *Uint64Value) Type() string

+ type Uint8Value uint8

+ func (i *Uint8Value) Set(s string) error

+ func (i *Uint8Value) String() string

+ func (i *Uint8Value) Type() string

+ type UintSliceValue []uint

+ func (s *UintSliceValue) Set(val string) error

+ func (s *UintSliceValue) String() string

+ func (s *UintSliceValue) Type() string

+ type UintValue uint

+ func (i *UintValue) Set(s string) error

+ func (i *UintValue) String() string

+ func (i *UintValue) Type() string

v0.0.6

Jun 17, 2021

v0.0.5

Jul 11, 2020

Changes in this version

+ type ChangedMarker struct

+ Dest *bool

+ Name string

type CommandDescription

+ ChangedMarkers []ChangedMarker

v0.0.4

Jul 4, 2020

v0.0.3

Jul 3, 2020

v0.0.2

Jul 2, 2020

Changes in this version

+ var UnrecognizedErr = errors.New("command was not recognized")

+ func AddFlag(flags *pflag.FlagSet, typ reflect.Type, val reflect.Value, name string, ...) error

+ type BytesHexFlag []byte

+ func (f *BytesHexFlag) Set(value string) error

+ func (f *BytesHexFlag) Type() string

+ func (f BytesHexFlag) String() string

+ type CommandKnownRoutes interface

+ Routes func() []string

type CommandRoute

+ Cmd func(route string) (cmd interface{}, err error)

+ type InitDefault interface

+ Default func()

v0.0.1

Jun 12, 2020

Changes in this version

+ var InvalidCmdTypeErr = errors.New("command type is not supported")

+ var NotRecognizedErr = errors.New("command was not recognized")

+ type Command interface

+ Run func(ctx context.Context, args ...string) error

+ type CommandDescription struct

+ FlagsSet *pflag.FlagSet

+ Help string

+ OptionalArgs []string

+ RequiredArgs []string

+ func Load(val interface{}) (*CommandDescription, error)

+ func LoadReflect(val reflect.Value) (*CommandDescription, error)

+ func (descr *CommandDescription) Execute(ctx context.Context, args ...string) (final *CommandDescription, isHelp bool, err error)

+ func (descr *CommandDescription) Load(val interface{}) error

+ func (descr *CommandDescription) LoadField(f reflect.StructField, val reflect.Value) (requiredArg, optionalArg string, err error)

+ func (descr *CommandDescription) LoadReflect(val reflect.Value) error

+ func (descr *CommandDescription) Usage(name string) string

+ type CommandRoute interface

+ Get func(ctx context.Context, args ...string) (cmd interface{}, remaining []string, err error)

+ type Help interface

+ Help func() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL