parser

package

Go to main page

Versions in this module

v1

v1.2.4

Jul 1, 2025

v1.2.2

Jun 2, 2025

v1.2.1

Apr 28, 2025

Changes in this version

type ArgumentsParser

+ ParsingState ParsingState

+ type ParsedArguments struct

+ LongNameToArgument map[string]*arguments.Argument

+ PositionalArguments map[string]*positionals.PositionalArgument

+ ShortNameToArgument map[string]*arguments.Argument

+ func (pa *ParsedArguments) AddArgument(argument *arguments.Argument)

+ func (pa *ParsedArguments) AddPositionalArgument(argument *positionals.PositionalArgument)

type ParsingState

+ func (ps *ParsingState) AddErrorMessage(message string)

+ func (ps *ParsingState) ClearErrorMessages()

+ func (ps *ParsingState) GetErrorMessages() []string

+ func (ps *ParsingState) SetRawArguments(rawArguments []string)

v1.2.0

Apr 16, 2025

Changes in this version

type ArgumentsParser

+ Options ArgumentsParserOptions

+ SubParsers SubParsers

+ func NewParser(banner string) *ArgumentsParser

+ func (ap *ArgumentsParser) AddSubParser(name, banner string) *ArgumentsParser

+ func (ap *ArgumentsParser) SetOptShowBannerOnHelp(showBannerOnHelp bool)

+ func (ap *ArgumentsParser) SetOptShowBannerOnRun(showBannerOnRun bool)

+ func (ap *ArgumentsParser) SetupSubParsing(name string, value *string, caseInsensitive bool)

+ type ArgumentsParserOptions struct

+ ShowBannerOnHelp bool

+ ShowBannerOnRun bool

+ type ParsingState struct

+ ErrorMessages []string

+ ParsedArguments map[string]*arguments.Argument

+ RawArguments []string

+ type SubParsers struct

+ CaseInsensitive bool

+ Enabled bool

+ Name string

+ Parsers map[string]*ArgumentsParser

+ Value *string

+ func (sp *SubParsers) AddSubParser(name, banner string) *ArgumentsParser

+ func (sp *SubParsers) GetSubParser(name string) *ArgumentsParser

v1.1.7

Apr 11, 2025

Changes in this version

+ type ArgumentsParser struct

+ Banner string

+ DefaultGroup *argumentgroup.ArgumentGroup

+ Groups map[string]*argumentgroup.ArgumentGroup

+ PositionalArguments []positionals.PositionalArgument

+ ShowBannerOnHelp bool

+ ShowBannerOnRun bool

+ func (ap *ArgumentsParser) ArgumentIsPresent(argumentName string) bool

+ func (ap *ArgumentsParser) Get(argumentFlag string) (interface{}, error)

+ func (ap *ArgumentsParser) NewArgumentGroup(name string) (*argumentgroup.ArgumentGroup, error)

+ func (ap *ArgumentsParser) NewBoolArgument(ptr *bool, shortName, longName string, defaultValue bool, help string) error

+ func (ap *ArgumentsParser) NewDependentArgumentGroup(name string) (*argumentgroup.ArgumentGroup, error)

+ func (ap *ArgumentsParser) NewIntArgument(ptr *int, shortName, longName string, defaultValue int, required bool, ...) error

+ func (ap *ArgumentsParser) NewIntPositionalArgument(ptr *int, name string, help string) error

+ func (ap *ArgumentsParser) NewIntRangeArgument(ptr *int, shortName, longName string, defaultValue int, rangeStart int, ...) error

+ func (ap *ArgumentsParser) NewListOfIntsArgument(ptr *[]int, shortName, longName string, defaultValue []int, required bool, ...) error

+ func (ap *ArgumentsParser) NewListOfStringsArgument(ptr *[]string, shortName, longName string, defaultValue []string, ...) error

+ func (ap *ArgumentsParser) NewMapOfHttpHeadersArgument(ptr *map[string]string, shortName, longName string, ...) error

+ func (ap *ArgumentsParser) NewNotRequiredMutuallyExclusiveArgumentGroup(name string) (*argumentgroup.ArgumentGroup, error)

+ func (ap *ArgumentsParser) NewRequiredMutuallyExclusiveArgumentGroup(name string) (*argumentgroup.ArgumentGroup, error)

+ func (ap *ArgumentsParser) NewStringArgument(ptr *string, shortName, longName string, defaultValue string, required bool, ...) error

+ func (ap *ArgumentsParser) NewStringPositionalArgument(ptr *string, name string, help string) error

+ func (ap *ArgumentsParser) NewTcpPortArgument(ptr *int, shortName, longName string, defaultValue int, required bool, ...) error

+ func (ap *ArgumentsParser) Parse()

+ func (ap *ArgumentsParser) ParseFrom(index int)

+ func (ap *ArgumentsParser) PrintArgumentTree()

+ func (ap *ArgumentsParser) Register(arg arguments.Argument) error

+ func (ap *ArgumentsParser) RegisterPositional(newPositionalArgument positionals.PositionalArgument) error

+ func (ap *ArgumentsParser) Usage()

+ func (ap *ArgumentsParser) UsageFrom(index int)

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