cliargs

package module

Go to main page

Versions in this module

v0

v0.9.0

Oct 15, 2024

v0.8.0

Sep 1, 2024

Changes in this version

type Cmd

+ OptCfgs []OptCfg

+ func NewCmd() Cmd

+ func (cmd *Cmd) Parse() error

+ func (cmd *Cmd) ParseFor(optStore any) error

+ func (cmd *Cmd) ParseUntilSubCmd() (Cmd, error)

+ func (cmd *Cmd) ParseUntilSubCmdFor(optStore any) (Cmd, error)

+ func (cmd *Cmd) ParseUntilSubCmdWith(optCfgs []OptCfg) (Cmd, error)

+ func (cmd *Cmd) ParseWith(optCfgs []OptCfg) error

+ func (cmd Cmd) String() string

type Help

+ func NewHelpWithMargins(marginLeft, marginRight int) Help

+ func (help *Help) AddOptsWithIndent(optCfgs []OptCfg, indent int)

+ func (help *Help) AddOptsWithIndentAndMargins(optCfgs []OptCfg, indent, marginLeft, marginRight int)

+ func (help *Help) AddOptsWithMargins(optCfgs []OptCfg, marginLeft, marginRight int)

+ func (help *Help) AddTextWithIndent(text string, indent int)

+ func (help *Help) AddTextWithIndentAndMargins(text string, indent, marginLeft, marginRight int)

+ func (help *Help) AddTextWithMargins(text string, marginLeft, marginRight int)

+ func (help *Help) AddTextsWithIndent(texts []string, indent int)

+ func (help *Help) AddTextsWithIndentAndMargins(texts []string, indent, marginLeft, marginRight int)

+ func (help *Help) AddTextsWithMargins(texts []string, marginLeft, marginRight int)

type OptCfg

+ Validator *func(string, string, string) error

v0.7.0

Mar 18, 2024

Changes in this version

+ type ConfigHasDefaultsButHasNoArg struct

+ StoreKey string

+ func (e ConfigHasDefaultsButHasNoArg) Error() string

+ func (e ConfigHasDefaultsButHasNoArg) GetOpt() string

type ConfigIsArrayButHasNoArg

+ StoreKey string

type OptCfg

+ ArgInHelp string

+ Defaults []string

+ Names []string

+ StoreKey string

type OptionIsNotArray

+ Name string

+ StoreKey string

+ type OptionNameIsDuplicated struct

+ Name string

+ StoreKey string

+ func (e OptionNameIsDuplicated) Error() string

+ func (e OptionNameIsDuplicated) GetOpt() string

type OptionNeedsArg

+ Name string

+ StoreKey string

type OptionTakesNoArg

+ Name string

+ StoreKey string

+ type StoreKeyIsDuplicated struct

+ StoreKey string

+ func (e StoreKeyIsDuplicated) Error() string

+ func (e StoreKeyIsDuplicated) GetOpt() string

type UnconfiguredOption

+ Name string

v0.6.0

Oct 23, 2023

Changes in this version

type ConfigHasDefaultButHasNoArg

+ func (e ConfigHasDefaultButHasNoArg) GetOpt() string

type ConfigIsArrayButHasNoArg

+ func (e ConfigIsArrayButHasNoArg) GetOpt() string

+ type InvalidOption interface

+ Error func() string

+ GetOpt func() string

type OptionHasInvalidChar

+ func (e OptionHasInvalidChar) GetOpt() string

type OptionIsNotArray

+ func (e OptionIsNotArray) GetOpt() string

type OptionNeedsArg

+ func (e OptionNeedsArg) GetOpt() string

type OptionTakesNoArg

+ func (e OptionTakesNoArg) GetOpt() string

type UnconfiguredOption

+ func (e UnconfiguredOption) GetOpt() string

v0.5.2

Oct 22, 2023

v0.5.1

Oct 15, 2023

v0.5.0

Jun 18, 2023

Changes in this version

+ func FindFirstArg(osArgs []string) (index int, arg string, exists bool)

+ func ParseFor(osArgs []string, options any) (Cmd, []OptCfg, error)

+ type Cmd struct

+ Name string

+ func Parse() (Cmd, error)

+ func ParseWith(osArgs []string, optCfgs []OptCfg) (Cmd, error)

+ func (cmd Cmd) Args() []string

+ func (cmd Cmd) HasOpt(name string) bool

+ func (cmd Cmd) OptArg(name string) string

+ func (cmd Cmd) OptArgs(name string) []string

+ type ConfigHasDefaultButHasNoArg struct

+ Option string

+ func (e ConfigHasDefaultButHasNoArg) Error() string

+ type ConfigIsArrayButHasNoArg struct

+ Option string

+ func (e ConfigIsArrayButHasNoArg) Error() string

+ type FailToParseFloat struct

+ BitSize int

+ Field string

+ Input string

+ Option string

+ func (e FailToParseFloat) Error() string

+ func (e FailToParseFloat) Unwrap() error

+ type FailToParseInt struct

+ BitSize int

+ Field string

+ Input string

+ Option string

+ func (e FailToParseInt) Error() string

+ func (e FailToParseInt) Unwrap() error

+ type FailToParseUint struct

+ BitSize int

+ Field string

+ Input string

+ Option string

+ func (e FailToParseUint) Error() string

+ func (e FailToParseUint) Unwrap() error

+ type Help struct

+ func NewHelp(wrapOpts ...int) Help

+ func (help *Help) AddOpts(optCfgs []OptCfg, wrapOpts ...int)

+ func (help *Help) AddText(text string, wrapOpts ...int)

+ func (help *Help) AddTexts(texts []string, wrapOpts ...int)

+ func (help Help) Iter() HelpIter

+ func (help Help) Print()

+ type HelpIter struct

+ func (iter *HelpIter) Next() (string, IterStatus)

+ type IllegalOptionType struct

+ Field string

+ Option string

+ Type reflect.Type

+ func (e IllegalOptionType) Error() string

+ type IterStatus bool

+ const ITER_HAS_MORE

+ const ITER_NO_MORE

+ type OptCfg struct

+ Aliases []string

+ ArgHelp string

+ Default []string

+ Desc string

+ HasArg bool

+ IsArray bool

+ Name string

+ OnParsed *func([]string) error

+ func MakeOptCfgsFor(options any) ([]OptCfg, error)

+ type OptionHasInvalidChar struct

+ Option string

+ func (e OptionHasInvalidChar) Error() string

+ type OptionIsNotArray struct

+ Option string

+ func (e OptionIsNotArray) Error() string

+ type OptionNeedsArg struct

+ Option string

+ func (e OptionNeedsArg) Error() string

+ type OptionStoreIsNotChangeable struct

+ func (e OptionStoreIsNotChangeable) Error() string

+ type OptionTakesNoArg struct

+ Option string

+ func (e OptionTakesNoArg) Error() string

+ type UnconfiguredOption struct

+ Option string

+ func (e UnconfiguredOption) Error() string

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