argo

package

Go to main page

Versions in this module

v1

v1.4.10

Sep 21, 2024

v1.4.9

Sep 21, 2024

Changes in this version

+ type ArgumentBindingError interface

+ Builder func() ArgumentBuilder

+ Unwrap func() error

+ type FlagBindingError interface

+ ArgumentBuilder func() ArgumentBuilder

+ FlagBuilder func() FlagBuilder

+ Unwrap func() error

v1.4.8

Mar 5, 2024

v1.4.7

Feb 25, 2024

v1.4.6

Feb 25, 2024

v1.4.5

Feb 22, 2024

v1.4.4

Feb 20, 2024

v1.4.3

Nov 14, 2023

v1.4.2

Nov 14, 2023

v1.4.1

Nov 14, 2023

v1.4.0

Nov 10, 2023

v1.3.0

Nov 6, 2023

v1.2.1

Oct 28, 2023

v1.2.0

Oct 27, 2023

Changes in this version

+ func ByteSliceParserBase64(s string) ([]byte, error)

+ func ByteSliceParserHex(s string) ([]byte, error)

+ func ByteSliceParserRaw(s string) ([]byte, error)

+ type ByteSliceParser = func(string) ([]byte, error)

+ type Scanner interface

+ HasNext func() bool

+ Next func() T

+ func DelimitedSliceScanner(input, delimiters string) Scanner[string]

+ type StringScannerFactory = func(input string) Scanner[string]

type UnmarshalSliceProps

+ ByteSliceParser ByteSliceParser

+ Scanner StringScannerFactory

v1.1.0

Oct 26, 2023

Changes in this version

+ func NoneOfPostParseArgumentValidator(values []T, message string) any

+ func NoneOfPreParseArgumentValidator(values []string, message string) any

+ func NumericRangePostParseArgumentValidator(minimum, maximum T, message string) any

+ func OneOfPostParseArgumentValidator(values []T, message string) any

+ func OneOfPreParseArgumentValidator(values []string, message string) any

type ArgumentBuilder

+ WithValidator func(validatorFn any) ArgumentBuilder

type CommandBranchBuilder

+ OnIncomplete func(handler OnIncompleteHandler) CommandBranchBuilder

type CommandBuilder

+ WithCallback func(cb CommandCallback) CommandBuilder

+ type CommandCallback = func(command Command)

type CommandTreeBuilder

+ OnIncomplete func(handler OnIncompleteHandler) CommandTreeBuilder

+ type NumericValue interface

+ type OnIncompleteHandler = func(command CommandParent)

type UnmarshalProps

+ Time UnmarshalTimeProps

+ type UnmarshalTimeProps struct

+ DateFormats []string

v1.0.3

Oct 22, 2023

v1.0.2

Oct 22, 2023

v1.0.1

Oct 21, 2023

v1.0.0

Oct 20, 2023

Changes in this version

+ const ArgErrInvalidBinding

+ const ArgErrInvalidBindingBadType

+ const ArgErrInvalidDefault

+ const ArgErrInvalidDefaultFn

+ const ArgErrInvalidDefaultVal

+ type Argument interface

+ AppendWarning func(warning string)

+ BindingType func() reflect.Type

+ Default func() any

+ DefaultType func() reflect.Type

+ Description func() string

+ HasBinding func() bool

+ HasDefault func() bool

+ HasDescription func() bool

+ HasName func() bool

+ IsRequired func() bool

+ Name func() string

+ RawValue func() string

+ WasHit func() bool

+ type ArgumentBuilder interface

+ Build func(ctx *WarningContext) (Argument, error)

+ Require func() ArgumentBuilder

+ WithBinding func(pointer any) ArgumentBuilder

+ WithDefault func(def any) ArgumentBuilder

+ WithDescription func(desc string) ArgumentBuilder

+ WithName func(name string) ArgumentBuilder

+ WithUnmarshaler func(fn ValueUnmarshaler) ArgumentBuilder

+ func NewArgumentBuilder() ArgumentBuilder

+ type ArgumentError interface

+ Builder func() ArgumentBuilder

+ Is func(errorType ArgumentErrorType) bool

+ Type func() ArgumentErrorType

+ type ArgumentErrorType uint8

+ func (a ArgumentErrorType) String() string

+ type Command interface

+ AppendWarning func(warning string)

+ Arguments func() []Argument

+ Description func() string

+ FindLongFlag func(name string) Flag

+ FindShortFlag func(c byte) Flag

+ FlagGroups func() []FlagGroup

+ GetUnmappedLabel func() string

+ HasArguments func() bool

+ HasDescription func() bool

+ HasFlagGroups func() bool

+ HasPassthroughInputs func() bool

+ HasUnmappedInputs func() bool

+ HasUnmappedLabel func() bool

+ Name func() string

+ PassthroughInputs func() []string

+ UnmappedInputs func() []string

+ Warnings func() []string

+ type CommandBranch interface

+ type CommandBranchBuilder interface

+ Build func(warnings *WarningContext) (CommandBranch, error)

+ WithAliases func(aliases ...string) CommandBranchBuilder

+ WithBranch func(branch CommandBranchBuilder) CommandBranchBuilder

+ WithCallback func(cb CommandBranchCallback) CommandBranchBuilder

+ WithCommandGroup func(group CommandGroupBuilder) CommandBranchBuilder

+ WithDescription func(desc string) CommandBranchBuilder

+ WithFlag func(flag FlagBuilder) CommandBranchBuilder

+ WithFlagGroup func(flagGroup FlagGroupBuilder) CommandBranchBuilder

+ WithHelpDisabled func() CommandBranchBuilder

+ WithLeaf func(leaf CommandLeafBuilder) CommandBranchBuilder

+ func NewCommandBranchBuilder(name string) CommandBranchBuilder

+ type CommandBranchCallback = func(branch CommandBranch)

+ type CommandBuilder interface

+ Build func(ctx *WarningContext) (Command, error)

+ MustParse func(args []string) Command

+ Parse func(args []string) (Command, error)

+ WithArgument func(arg ArgumentBuilder) CommandBuilder

+ WithDescription func(desc string) CommandBuilder

+ WithFlag func(flag FlagBuilder) CommandBuilder

+ WithFlagGroup func(group FlagGroupBuilder) CommandBuilder

+ WithHelpDisabled func() CommandBuilder

+ WithUnmappedLabel func(label string) CommandBuilder

+ func NewCommandBuilder() CommandBuilder

+ type CommandChild interface

+ Aliases func() []string

+ HasAliases func() bool

+ Matches func(name string) bool

+ type CommandGroup interface

+ Branches func() []CommandBranch

+ Description func() string

+ FindChild func(name string) CommandChild

+ HasBranches func() bool

+ HasDescription func() bool

+ HasLeaves func() bool

+ Leaves func() []CommandLeaf

+ Name func() string

+ type CommandGroupBuilder interface

+ Build func(warnings *WarningContext) (CommandGroup, error)

+ WithBranch func(branch CommandBranchBuilder) CommandGroupBuilder

+ WithDescription func(desc string) CommandGroupBuilder

+ WithLeaf func(leaf CommandLeafBuilder) CommandGroupBuilder

+ func NewCommandGroupBuilder(name string) CommandGroupBuilder

+ type CommandLeaf interface

+ type CommandLeafBuilder interface

+ Build func(warnings *WarningContext) (CommandLeaf, error)

+ WithAliases func(aliases ...string) CommandLeafBuilder

+ WithArgument func(argument ArgumentBuilder) CommandLeafBuilder

+ WithCallback func(cb CommandLeafCallback) CommandLeafBuilder

+ WithDescription func(desc string) CommandLeafBuilder

+ WithFlag func(flag FlagBuilder) CommandLeafBuilder

+ WithFlagGroup func(flagGroup FlagGroupBuilder) CommandLeafBuilder

+ WithHelpDisabled func() CommandLeafBuilder

+ WithUnmappedLabel func(label string) CommandLeafBuilder

+ func NewCommandLeafBuilder(name string) CommandLeafBuilder

+ type CommandLeafCallback = func(leaf CommandLeaf)

+ type CommandNode interface

+ AppendWarning func(warning string)

+ Description func() string

+ FindLongFlag func(name string) Flag

+ FindShortFlag func(c byte) Flag

+ FlagGroups func() []FlagGroup

+ HasDescription func() bool

+ HasFlagGroups func() bool

+ HasParent func() bool

+ Name func() string

+ Parent func() CommandNode

+ Warnings func() []string

+ type CommandParent interface

+ CommandGroups func() []CommandGroup

+ FindChild func(name string) CommandChild

+ type CommandTree interface

+ SelectedCommand func() CommandLeaf

+ type CommandTreeBuilder interface

+ Build func(warnings *WarningContext) (CommandTree, error)

+ MustParse func(args []string) CommandTree

+ Parse func(args []string) (CommandTree, error)

+ WithBranch func(branch CommandBranchBuilder) CommandTreeBuilder

+ WithCallback func(cb CommandTreeCallback) CommandTreeBuilder

+ WithCommandGroup func(group CommandGroupBuilder) CommandTreeBuilder

+ WithDescription func(desc string) CommandTreeBuilder

+ WithFlag func(flag FlagBuilder) CommandTreeBuilder

+ WithFlagGroup func(flagGroup FlagGroupBuilder) CommandTreeBuilder

+ WithHelpDisabled func() CommandTreeBuilder

+ WithLeaf func(leaf CommandLeafBuilder) CommandTreeBuilder

+ func NewCommandTreeBuilder() CommandTreeBuilder

+ type CommandTreeCallback = func(com CommandTree)

+ type Flag interface

+ AppendWarning func(warning string)

+ Argument func() Argument

+ Description func() string

+ HasArgument func() bool

+ HasDescription func() bool

+ HasLongForm func() bool

+ HasShortForm func() bool

+ HitCount func() int

+ IsRequired func() bool

+ LongForm func() string

+ RequiresArgument func() bool

+ ShortForm func() byte

+ WasHit func() bool

+ type FlagBuilder interface

+ Build func(warnings *WarningContext) (Flag, error)

+ Require func() FlagBuilder

+ WithArgument func(arg ArgumentBuilder) FlagBuilder

+ WithBinding func(pointer any, required bool) FlagBuilder

+ WithBindingAndDefault func(pointer, def any, required bool) FlagBuilder

+ WithCallback func(fn FlagCallback) FlagBuilder

+ WithDescription func(desc string) FlagBuilder

+ WithLongForm func(form string) FlagBuilder

+ WithShortForm func(char byte) FlagBuilder

+ func NewFlagBuilder() FlagBuilder

+ type FlagCallback = func(flag Flag)

+ type FlagGroup interface

+ Description func() string

+ FindLongFlag func(name string) Flag

+ FindShortFlag func(c byte) Flag

+ Flags func() []Flag

+ HasDescription func() bool

+ Name func() string

+ type FlagGroupBuilder interface

+ Build func(warnings *WarningContext) (FlagGroup, error)

+ WithDescription func(desc string) FlagGroupBuilder

+ WithFlag func(flag FlagBuilder) FlagGroupBuilder

+ func NewFlagGroupBuilder(name string) FlagGroupBuilder

+ type FormatError interface

+ Argument func() string

+ Kind func() reflect.Kind

+ Root func() error

+ type HelpRenderer interface

+ RenderHelp func(command T, writer io.Writer) error

+ func CommandBranchHelpRenderer() HelpRenderer[CommandBranch]

+ func CommandHelpRenderer() HelpRenderer[Command]

+ func CommandLeafHelpRenderer() HelpRenderer[CommandLeaf]

+ func CommandTreeHelpRenderer() HelpRenderer[CommandTree]

+ type Hex int

+ func (h *Hex) Unmarshal(value string) (err error)

+ type Hex16 int16

+ func (h *Hex16) Unmarshal(value string) (err error)

+ type Hex32 int32

+ func (h *Hex32) Unmarshal(value string) (err error)

+ type Hex64 int64

+ func (h *Hex64) Unmarshal(value string) (err error)

+ type Hex8 int8

+ func (h *Hex8) Unmarshal(value string) (err error)

+ type InvalidArgError struct

+ func (i *InvalidArgError) Builder() ArgumentBuilder

+ func (i *InvalidArgError) Error() string

+ func (i *InvalidArgError) Is(kind ArgumentErrorType) bool

+ func (i *InvalidArgError) Type() ArgumentErrorType

+ type InvalidTypeError struct

+ Value reflect.Value

+ func (i *InvalidTypeError) Error() string

+ type InvalidUnmarshalError struct

+ Argument string

+ Value reflect.Value

+ func (i *InvalidUnmarshalError) Error() string

+ type MissingFlagError interface

+ Flag func() Flag

+ type MissingRequiredArgumentError interface

+ Argument func() Argument

+ Flag func() Flag

+ HasFlag func() bool

+ type MultiError interface

+ AppendError func(err error)

+ Errors func() []error

+ type Octal int

+ func (o *Octal) Unmarshal(value string) (err error)

+ type Octal16 int16

+ func (o *Octal16) Unmarshal(value string) (err error)

+ type Octal32 int32

+ func (o *Octal32) Unmarshal(value string) (err error)

+ type Octal64 int64

+ func (o *Octal64) Unmarshal(value string) (err error)

+ type Octal8 int8

+ func (o *Octal8) Unmarshal(value string) (err error)

+ type UHex uint

+ func (h *UHex) Unmarshal(value string) (err error)

+ type UHex16 uint16

+ func (h *UHex16) Unmarshal(value string) (err error)

+ type UHex32 uint32

+ func (h *UHex32) Unmarshal(value string) (err error)

+ type UHex64 uint64

+ func (h *UHex64) Unmarshal(value string) (err error)

+ type UHex8 uint8

+ func (h *UHex8) Unmarshal(value string) (err error)

+ type UOctal uint

+ func (o *UOctal) Unmarshal(value string) (err error)

+ type UOctal16 uint16

+ func (o *UOctal16) Unmarshal(value string) (err error)

+ type UOctal32 uint32

+ func (o *UOctal32) Unmarshal(value string) (err error)

+ type UOctal64 uint64

+ func (o *UOctal64) Unmarshal(value string) (err error)

+ type UOctal8 uint8

+ func (o *UOctal8) Unmarshal(value string) (err error)

+ type UnmarshalIntegerProps struct

+ DefaultBase int

+ HexLeaders []string

+ OctalLeaders []string

+ type UnmarshalMapProps struct

+ EntrySeparatorChars string

+ KeyValSeparatorChars string

+ type UnmarshalProps struct

+ Integers UnmarshalIntegerProps

+ Maps UnmarshalMapProps

+ Slices UnmarshalSliceProps

+ func DefaultUnmarshalProps() UnmarshalProps

+ type UnmarshalSliceProps struct

+ type Unmarshaler interface

+ Unmarshal func(raw string) error

+ type UnmarshalerFunc func(raw string) error

+ func (u UnmarshalerFunc) Unmarshal(raw string) error

+ type UnmarshallingError interface

+ Value func() reflect.Value

+ type ValueUnmarshaler interface

+ Unmarshal func(raw string, val any) error

+ func NewDefaultMagicUnmarshaler() ValueUnmarshaler

+ func NewMagicUnmarshaler(props UnmarshalProps) ValueUnmarshaler

+ type ValueUnmarshalerFunc func(raw string, val any) error

+ func (v ValueUnmarshalerFunc) Unmarshal(raw string, val any) error

+ type WarningContext struct

+ func (w WarningContext) GetWarnings() []string

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