argparse

Documentation

Index

• Constants
• type ParsedArgs
  • func Parse(args []string) (ParsedArgs, error)
  • func (p ParsedArgs) Checksum() string
  • func (p ParsedArgs) GetParameter(key string) string
  • func (p ParsedArgs) GetParameterList(key string) string
  • func (p ParsedArgs) IsPositionalTime() bool
  • func (p ParsedArgs) ToSelfStringChunks() []string
  • func (p ParsedArgs) ToSlugString() string
  • func (p ParsedArgs) Validate(ctx context.Context, flags map[string]config.Flag, ...) error

Constants

const (
	PrefixFlag          = "+"
	PrefixFlagClear     = "_"
	PrefixLiteral       = ":"
	SeparatorKeyword    = "="
	PositionalDelimiter = "--"

	FlagEnabled = "1"

	SerializePrefixPositional   = "0"
	SerializePrefixFlag         = "1"
	SerializePrefixParameter    = "2"
	SerializeParameterSeparator = "_"
)

Types

type ParsedArgs

type ParsedArgs struct {
	Parameters         map[string][]string
	Flags              map[string]bool
	Positional         []string
	ExplicitPositional bool
}

func Parse

func Parse(args []string) (ParsedArgs, error)

func (ParsedArgs) Checksum

func (p ParsedArgs) Checksum() string

func (ParsedArgs) GetParameter

func (p ParsedArgs) GetParameter(key string) string

func (ParsedArgs) GetParameterList

func (p ParsedArgs) GetParameterList(key string) string

func (ParsedArgs) IsPositionalTime

func (p ParsedArgs) IsPositionalTime() bool

func (ParsedArgs) ToSelfStringChunks

func (p ParsedArgs) ToSelfStringChunks() []string

func (ParsedArgs) ToSlugString

func (p ParsedArgs) ToSlugString() string

func (ParsedArgs) Validate

func (p ParsedArgs) Validate(
	ctx context.Context,
	flags map[string]config.Flag,
	parameters map[string]config.Parameter,
) error