flagutil

Documentation

Overview

Package flagutil contains flags that parse string lists and string maps.

Index

• func DualFormatBoolVar(p *bool, name string, value bool, usage string)
• func DualFormatInt64Var(p *int64, name string, value int64, usage string)
• func DualFormatIntVar(p *int, name string, value int, usage string)
• func DualFormatStringListVar(p *[]string, name string, value []string, usage string)
• func DualFormatStringVar(p *string, name string, value string, usage string)
• func StringListVar(p *[]string, name string, defaultValue []string, usage string)
• type StringListValue
  • func (value StringListValue) Get() interface{}
  • func (value *StringListValue) Set(v string) error
  • func (value StringListValue) String() string
• type StringMapValue
  • func (value StringMapValue) Get() interface{}
  • func (value *StringMapValue) Set(v string) error
  • func (value StringMapValue) String() string

Functions

func DualFormatBoolVar

func DualFormatBoolVar(p *bool, name string, value bool, usage string)

DualFormatBoolVar creates a flag which supports both dashes and underscores

func DualFormatInt64Var

func DualFormatInt64Var(p *int64, name string, value int64, usage string)

DualFormatInt64Var creates a flag which supports both dashes and underscores

func DualFormatIntVar

func DualFormatIntVar(p *int, name string, value int, usage string)

DualFormatIntVar creates a flag which supports both dashes and underscores

func DualFormatStringListVar

func DualFormatStringListVar(p *[]string, name string, value []string, usage string)

DualFormatStringListVar creates a flag which supports both dashes and underscores

func DualFormatStringVar

func DualFormatStringVar(p *string, name string, value string, usage string)

DualFormatStringVar creates a flag which supports both dashes and underscores

func StringListVar

func StringListVar(p *[]string, name string, defaultValue []string, usage string)

StringListVar defines a []string flag with the specified name, value and usage string. The argument 'p' points to a []string in which to store the value of the flag.

Types

type StringListValue

type StringListValue []string

StringListValue is a []string flag that accepts a comma separated list of elements. To include an element containing a comma, quote it with a backslash '\'.

func (StringListValue) Get

func (value StringListValue) Get() interface{}

Get returns the []string value of this flag.

func (*StringListValue) Set

func (value *StringListValue) Set(v string) error

Set sets the value of this flag from parsing the given string.

func (StringListValue) String

func (value StringListValue) String() string

String returns the string representation of this flag.

type StringMapValue

type StringMapValue map[string]string

StringMapValue is a map[string]string flag. It accepts a comma-separated list of key value pairs, of the form key:value. The keys cannot contain colons.

func (StringMapValue) Get

func (value StringMapValue) Get() interface{}

Get returns the map[string]string value of this flag.

func (*StringMapValue) Set

func (value *StringMapValue) Set(v string) error

Set sets the value of this flag from parsing the given string.

func (StringMapValue) String

func (value StringMapValue) String() string

String returns the string representation of this flag.