clipper

package module

Go to main page

Versions in this module

v0

v0.0.24

Feb 7, 2023

Changes in this version

type CommandConfig

+ func (commandConfig *CommandConfig) AddCounterFlag(name, shortName string, c *int, help string) *Opt

v0.0.23

Jan 22, 2023

v0.0.22

Jan 22, 2023

Changes in this version

type CommandConfig

+ Callback func() error

type Registry

+ func (registry *Registry) RegisterHelp(name string, help string, printCmdName, exitOnHelp bool)

+ func (registry *Registry) RegisterWithCallback(name string, help string, callback func() error) (*CommandConfig, bool)

v0.0.21

Jan 22, 2023

Changes in this version

type CommandConfig

+ func (commandConfig *CommandConfig) AddInt64Array(name, shortName string, value []int64, p *[]int64, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt64ArrayFromCSV(name, shortName string, value string, p *[]int64, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt64N(name, shortName string, value int64, p *int64, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt64NArray(name, shortName string, value []int64, p *[]int64, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt64NFromString(name, shortName string, value string, p *int64, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint64N(name, shortName string, value uint64, p *uint64, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint64NArray(name, shortName string, value []uint64, p *[]uint64, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint64NArrayFromCSV(name, shortName string, value string, p *[]uint64, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint64NFromString(name, shortName string, value string, p *uint64, help string) *Opt

+ func (commandConfig *CommandConfig) Addint64NArrayFromCSV(name, shortName string, value string, p *[]int64, help string) *Opt

v0.0.19

Jan 17, 2023

v0.0.18

Jan 15, 2023

v0.0.17

Jan 15, 2023

v0.0.16

Jan 15, 2023

Changes in this version

type Opt

+ EnvName string

+ func (o *Opt) AttachEnv(envName string) *Opt

v0.0.15

Jan 14, 2023

Changes in this version

type CommandConfig

+ func (commandConfig *CommandConfig) AddBoolFromString(name, shortName string, value string, b *bool, help string) *Opt

+ func (commandConfig *CommandConfig) GetFlag(flag string) *Opt

type Opt

+ CompleterValue string

+ IsFlag bool

+ IsMultiValue bool

+ func (o *Opt) GetCompeterValue() string

+ func (o *Opt) SetCompeterValue(competerValue string) *Opt

v0.0.14

Jan 13, 2023

v0.0.13

Jan 13, 2023

Changes in this version

type Registry

+ func (registry *Registry) ResetCommand(commandName string)

v0.0.12

Jan 13, 2023

v0.0.11

Jan 13, 2023

Changes in this version

type CommandConfig

+ func (commandConfig *CommandConfig) Reset()

v0.0.10

Jan 13, 2023

v0.0.9

Jan 13, 2023

v0.0.8

Jan 13, 2023

Changes in this version

type Registry

+ func (registry *Registry) CompleterAppended(line string) (c []string)

v0.0.7

Jan 13, 2023

Changes in this version

+ func SplitQuoted(s string) []string

v0.0.6

Jan 13, 2023

v0.0.5

Jan 13, 2023

v0.0.4

Jan 13, 2023

Changes in this version

type CommandConfig

+ func (commandConfig *CommandConfig) AddTimeFromString(name, shortName string, value string, p *time.Time, layout string, help string) *Opt

v0.0.3

Jan 13, 2023

v0.0.1

Jan 13, 2023

Changes in this version

+ var ErrIPMaskParse = errors.New("failed to parse IP mask")

+ var ErrIPParse = errors.New("failed to parse IP")

+ var ErrTypeMismatch = errors.New("type mismatch")

+ func CheckLen(name string, length, min, max int) error

+ func PrintHelp(registry *Registry, commandName string, commandConfig *CommandConfig)

+ func WrapInvalidValue(prefix string, err error) error

+ type Arg interface

+ CheckLen func() error

+ MaxLen func() int

+ MinLen func() int

+ SetMaxLen func(max int) Arg

+ SetMinLen func(min int) Arg

+ type CommandConfig struct

+ Args Arg

+ ArgsHelp string

+ Help string

+ Name string

+ Opts map[string]*Opt

+ OptsOrder []string

+ func (commandConfig *CommandConfig) AddBool(name, shortName string, value bool, b *bool, help string) *Opt

+ func (commandConfig *CommandConfig) AddBoolArray(name, shortName string, value []bool, p *[]bool, help string) *Opt

+ func (commandConfig *CommandConfig) AddBoolArrayFromCSV(name, shortName string, value string, p *[]bool, help string) *Opt

+ func (commandConfig *CommandConfig) AddDuration(name, shortName string, value time.Duration, p *time.Duration, help string) *Opt

+ func (commandConfig *CommandConfig) AddFlag(name, shortName string, b *bool, help string) *Opt

+ func (commandConfig *CommandConfig) AddFloat32(name, shortName string, value float32, p *float32, help string) *Opt

+ func (commandConfig *CommandConfig) AddFloat64(name, shortName string, value float64, p *float64, help string) *Opt

+ func (commandConfig *CommandConfig) AddIP(name, shortName string, value net.IP, p *net.IP, help string) *Opt

+ func (commandConfig *CommandConfig) AddIPArray(name, shortName string, value []net.IP, p *[]net.IP, help string) *Opt

+ func (commandConfig *CommandConfig) AddIPArrayFromCSV(name, shortName string, value string, p *[]net.IP, help string) *Opt

+ func (commandConfig *CommandConfig) AddIPFromString(name, shortName string, value string, p *net.IP, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt(name, shortName string, value int, p *int, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt16(name, shortName string, value int16, p *int16, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt32(name, shortName string, value int32, p *int32, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt32Array(name, shortName string, value []int32, p *[]int32, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt32ArrayFromCSV(name, shortName string, value string, p *[]int32, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt64(name, shortName string, value int64, p *int64, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt8(name, shortName string, value int8, p *int8, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt8Array(name, shortName string, value []int8, p *[]int8, help string) *Opt

+ func (commandConfig *CommandConfig) AddInt8ArrayFromCSV(name, shortName string, value string, p *[]int8, help string) *Opt

+ func (commandConfig *CommandConfig) AddIntArray(name, shortName string, value []int, p *[]int, help string) *Opt

+ func (commandConfig *CommandConfig) AddIntArrayFromCSV(name, shortName string, value string, p *[]int, help string) *Opt

+ func (commandConfig *CommandConfig) AddMultiFlag(name, shortName string, b *[]bool, help string) *Opt

+ func (commandConfig *CommandConfig) AddString(name, shortName string, value string, p *string, help string) *Opt

+ func (commandConfig *CommandConfig) AddStringArgs(max int, p *[]string, help string) Arg

+ func (commandConfig *CommandConfig) AddStringArray(name, shortName string, value []string, p *[]string, help string) *Opt

+ func (commandConfig *CommandConfig) AddStringArrayFromCSV(name, shortName string, value string, p *[]string, help string) *Opt

+ func (commandConfig *CommandConfig) AddTime(name, shortName string, value time.Time, p *time.Time, layout string, ...) *Opt

+ func (commandConfig *CommandConfig) AddUint(name, shortName string, value uint, p *uint, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint16(name, shortName string, value uint16, p *uint16, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint16Array(name, shortName string, value []uint16, p *[]uint16, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint16ArrayFromCSV(name, shortName string, value string, p *[]uint16, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint32(name, shortName string, value uint32, p *uint32, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint32Array(name, shortName string, value []uint32, p *[]uint32, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint32ArrayFromCSV(name, shortName string, value string, p *[]uint32, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint64(name, shortName string, value uint64, p *uint64, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint64Array(name, shortName string, value []uint64, p *[]uint64, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint64ArrayFromCSV(name, shortName string, value string, p *[]uint64, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint8(name, shortName string, value uint8, p *uint8, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint8Array(name, shortName string, value []uint8, p *[]uint8, help string) *Opt

+ func (commandConfig *CommandConfig) AddUint8ArrayFromCSV(name, shortName string, value string, p *[]uint8, help string) *Opt

+ func (commandConfig *CommandConfig) AddUintArray(name, shortName string, value []uint, p *[]uint, help string) *Opt

+ func (commandConfig *CommandConfig) AddUintArrayFromCSV(name, shortName string, value string, p *[]uint, help string) *Opt

+ func (commandConfig *CommandConfig) AddValue(name, shortName string, v Value, help string) *Opt

+ func (commandConfig *CommandConfig) AddVersionHelper(name, shortName, description, version string)

+ func (commandConfig *CommandConfig) Addint16Array(name, shortName string, value []int16, p *[]int16, help string) *Opt

+ func (commandConfig *CommandConfig) Addint16ArrayFromCSV(name, shortName string, value string, p *[]int16, help string) *Opt

+ func (commandConfig *CommandConfig) Addint64Array(name, shortName string, value []int64, p *[]int64, help string) *Opt

+ func (commandConfig *CommandConfig) Addint64ArrayFromCSV(name, shortName string, value string, p *[]int64, help string) *Opt

+ func (commandConfig *CommandConfig) DisableArgs() Arg

+ type ErrorInvalidValue struct

+ Prefix string

+ func (e ErrorInvalidValue) Error() string

+ type ErrorLengthOverflow struct

+ Cmp string

+ Name string

+ Value int

+ func (e ErrorLengthOverflow) Error() string

+ type ErrorRequiredFlag struct

+ Name string

+ func (e ErrorRequiredFlag) Error() string

+ type ErrorUnknownCommand struct

+ Name string

+ func (e ErrorUnknownCommand) Error() string

+ type ErrorUnknownFlag struct

+ Name string

+ func (e ErrorUnknownFlag) Error() string

+ type ErrorUnsupportedFlag struct

+ Name string

+ func (e ErrorUnsupportedFlag) Error() string

+ type ErrorUnsupportedValue struct

+ Name string

+ Value string

+ func (e ErrorUnsupportedValue) Error() string

+ type None struct

+ func (None) CheckLen() error

+ func (None) Get() interface{}

+ func (None) MaxLen() int

+ func (None) MinLen() int

+ func (None) Reset(interface{})

+ func (None) Set(v string, _ bool) error

+ func (None) String() string

+ func (None) Type() string

+ func (n None) SetMaxLen(_ int) Arg

+ func (n None) SetMinLen(_ int) Arg

+ type Opt struct

+ Changed bool

+ Help string

+ IsBool bool

+ IsInverted bool

+ IsRequired bool

+ Name string

+ ShortName string

+ ValidValues map[string]bool

+ Value Value

+ func (o *Opt) Reset()

+ func (o *Opt) Set(s string) error

+ func (o *Opt) SetRequired(required bool) *Opt

+ func (o *Opt) SetUsage(usage string) *Opt

+ func (o *Opt) SetValidValues(validValues []string) *Opt

+ func (o *Opt) Validate(s string) (isValid bool)

+ type Registry struct

+ Commands map[string]*CommandConfig

+ Description string

+ func NewRegistry(description string) *Registry

+ func (registry *Registry) Completer(line string) (c []string)

+ func (registry *Registry) Parse(values []string) (commandName string, err error)

+ func (registry *Registry) ParseInteract(values []string, dryRun bool) (commandName string, helpExit bool, err error)

+ func (registry *Registry) ParseOpt(values []string, exitOnHelp bool, dryRun bool) (commandName string, helpExit bool, err error)

+ func (registry *Registry) Register(name string, help string) (*CommandConfig, bool)

+ func (registry *Registry) Reset()

+ type Value interface

+ Get func() interface{}

+ Reset func(interface{})

+ Set func(s string, doAppend bool) error

+ String func() string

+ Type func() string

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