cliargs

Documentation

Index

• type CliArgs
  • func Parse(rawArgs []string) *CliArgs
  • func (a *CliArgs) ArgsCount() int
  • func (a *CliArgs) ForEachArgs(handler func(item string))
  • func (a *CliArgs) ForEachOptions(handler func(item OptionItem))
  • func (a *CliArgs) GetArg(i int) string
  • func (a *CliArgs) GetOption(name string) OptionItem
  • func (a *CliArgs) GetOptionOrDefault(name string, defaultValue string) OptionItem
  • func (a *CliArgs) HasOption(name string) bool
  • func (a *CliArgs) OptionsCount() int
  • func (a *CliArgs) SubArgs(i int) *CliArgs
• type OptionItem
  • func (o OptionItem) TryParseBool(defaultValue bool) bool
  • func (o OptionItem) TryParseFloat32(defaultValue float32) float32
  • func (o OptionItem) TryParseFloat64(defaultValue float64) float64
  • func (o OptionItem) TryParseInt(defaultValue int) int
  • func (o OptionItem) TryParseInt64(defaultValue int64) int64
  • func (o OptionItem) TryParseUint(defaultValue uint) uint
  • func (o OptionItem) TryParseUint64(defaultValue uint64) uint64

Types

type CliArgs

type CliArgs struct {
	RawArgs []string              // 原始参数
	Options map[string]OptionItem // 选项参数
	Args    []string              // 参数
}

func Parse

func Parse(rawArgs []string) *CliArgs

解析命令行参数 支持解析 -name=value, --name=value, -name, --name 这种形式

func (*CliArgs) ArgsCount

func (a *CliArgs) ArgsCount() int

参数数量

func (*CliArgs) ForEachArgs

func (a *CliArgs) ForEachArgs(handler func(item string))

遍历所有参数

func (*CliArgs) ForEachOptions

func (a *CliArgs) ForEachOptions(handler func(item OptionItem))

遍历所有选项

func (*CliArgs) GetArg

func (a *CliArgs) GetArg(i int) string

取指定索引的参数，如果不存在则返回空字符串

func (*CliArgs) GetOption

func (a *CliArgs) GetOption(name string) OptionItem

获取指定选项

func (*CliArgs) GetOptionOrDefault

func (a *CliArgs) GetOptionOrDefault(name string, defaultValue string) OptionItem

获取指定选项，如果不存在则返回默认值

func (*CliArgs) HasOption

func (a *CliArgs) HasOption(name string) bool

是否包含指定选项

func (*CliArgs) OptionsCount

func (a *CliArgs) OptionsCount() int

选项的数量

func (*CliArgs) SubArgs

func (a *CliArgs) SubArgs(i int) *CliArgs

取指定索引位置开始的参数，如果不存在则返回空的Args

type OptionItem

type OptionItem struct {
	Key   string // 键
	Value string // 值
	Raw   string // 原始值
}

func (OptionItem) TryParseBool

func (o OptionItem) TryParseBool(defaultValue bool) bool

func (OptionItem) TryParseFloat32

func (o OptionItem) TryParseFloat32(defaultValue float32) float32

func (OptionItem) TryParseFloat64

func (o OptionItem) TryParseFloat64(defaultValue float64) float64

func (OptionItem) TryParseInt

func (o OptionItem) TryParseInt(defaultValue int) int

func (OptionItem) TryParseInt64

func (o OptionItem) TryParseInt64(defaultValue int64) int64

func (OptionItem) TryParseUint

func (o OptionItem) TryParseUint(defaultValue uint) uint

func (OptionItem) TryParseUint64

func (o OptionItem) TryParseUint64(defaultValue uint64) uint64