Documentation
¶
Index ¶
- Constants
- Variables
- func ToJSON(a Args) (string, error)
- func ToParam(a Args) (string, error)deprecated
- func ValidateIPAddress(val string) (string, error)
- func ValidateLabel(val string) (string, error)
- func ValidateSysctl(val string) (string, error)
- type Args
- func (args Args) Add(key, value string)
- func (args Args) Contains(field string) bool
- func (args Args) Del(key, value string)
- func (args Args) ExactMatch(key, source string) bool
- func (args Args) FuzzyMatch(key, source string) bool
- func (args Args) Get(key string) []string
- func (args Args) Include(field string) booldeprecated
- func (args Args) Len() int
- func (args Args) MarshalJSON() ([]byte, error)
- func (args Args) Match(field, source string) bool
- func (args Args) MatchKVList(key string, sources map[string]string) bool
- func (args Args) UniqueExactMatch(key, source string) bool
- func (args Args) Validate(accepted map[string]bool) error
- func (args Args) WalkValues(field string, op func(value string) error) error
- type FilterOpt
- type KeyValuePair
- type ListOpts
- func (opts *ListOpts) Delete(key string)
- func (opts *ListOpts) Get(key string) bool
- func (opts *ListOpts) GetAll() []string
- func (opts *ListOpts) GetAllOrEmpty() []string
- func (opts *ListOpts) GetMap() map[string]struct{}
- func (opts *ListOpts) Len() int
- func (opts *ListOpts) Set(value string) error
- func (opts *ListOpts) String() string
- func (opts *ListOpts) Type() string
- type MapOpts
- type NamedListOpts
- type NamedMapOpts
- type NamedOption
- type ValidatorFctListType
- type ValidatorFctType
Constants ¶
const DefaultHTTPHost = "localhost"
DefaultHTTPHost Default HTTP Host used if only port is provided to -H flag e.g. docker daemon -H tcp://:8080
Variables ¶
var ErrBadFormat = errors.New("bad format of filter (expected name=value)")
ErrBadFormat is an error returned when a filter is not in the form key=value
Deprecated: this error will be removed in a future version
Functions ¶
func ValidateIPAddress ¶
ValidateIPAddress validates an Ip address.
func ValidateLabel ¶
ValidateLabel validates that the specified string is a valid label, and returns it. Labels are in the form on key=value.
func ValidateSysctl ¶
ValidateSysctl validates a sysctl and returns it.
Types ¶
type Args ¶
type Args struct {
// contains filtered or unexported fields
}
Args stores a mapping of keys to a set of multiple values.
func NewArgs ¶
func NewArgs(initialArgs ...KeyValuePair) Args
NewArgs returns a new Args populated with the initial args
func (Args) ExactMatch ¶
ExactMatch returns true if the source matches exactly one of the values.
func (Args) FuzzyMatch ¶
FuzzyMatch returns true if the source matches exactly one value, or the source has one of the values as a prefix.
func (Args) MarshalJSON ¶
MarshalJSON returns a JSON byte representation of the Args
func (Args) MatchKVList ¶
MatchKVList returns true if all the pairs in sources exist as key=value pairs in the mapping at key, or if there are no values at key.
func (Args) UniqueExactMatch ¶
UniqueExactMatch returns true if there is only one value and the source matches exactly the value.
type FilterOpt ¶
type FilterOpt struct {
// contains filtered or unexported fields
}
FilterOpt is a flag type for validating filters
type KeyValuePair ¶
KeyValuePair are used to initialize a new Args
func Arg ¶
func Arg(key, value string) KeyValuePair
Arg creates a new KeyValuePair for initializing Args
type ListOpts ¶
type ListOpts struct {
// contains filtered or unexported fields
}
ListOpts holds a list of values and a validation function.
func NewListOpts ¶
func NewListOpts(validator ValidatorFctType) ListOpts
NewListOpts creates a new ListOpts with the specified validator.
func NewListOptsRef ¶
func NewListOptsRef(values *[]string, validator ValidatorFctType) *ListOpts
NewListOptsRef creates a new ListOpts with the specified values and validator.
func (*ListOpts) GetAllOrEmpty ¶
GetAllOrEmpty returns the values of the slice or an empty slice when there are no values.
func (*ListOpts) GetMap ¶
GetMap returns the content of values in a map in order to avoid duplicates.
type MapOpts ¶
type MapOpts struct {
// contains filtered or unexported fields
}
MapOpts holds a map of values and a validation function.
func NewMapOpts ¶
func NewMapOpts(values map[string]string, validator ValidatorFctType) *MapOpts
NewMapOpts creates a new MapOpts with the specified map of values and a validator.
type NamedListOpts ¶
type NamedListOpts struct {
ListOpts
// contains filtered or unexported fields
}
NamedListOpts is a ListOpts with a configuration name. This struct is useful to keep reference to the assigned field name in the internal configuration struct.
func NewNamedListOptsRef ¶
func NewNamedListOptsRef(name string, values *[]string, validator ValidatorFctType) *NamedListOpts
NewNamedListOptsRef creates a reference to a new NamedListOpts struct.
func (*NamedListOpts) Name ¶
func (o *NamedListOpts) Name() string
Name returns the name of the NamedListOpts in the configuration.
type NamedMapOpts ¶
type NamedMapOpts struct {
MapOpts
// contains filtered or unexported fields
}
NamedMapOpts is a MapOpts struct with a configuration name. This struct is useful to keep reference to the assigned field name in the internal configuration struct.
func NewNamedMapOpts ¶
func NewNamedMapOpts(name string, values map[string]string, validator ValidatorFctType) *NamedMapOpts
NewNamedMapOpts creates a reference to a new NamedMapOpts struct.
func (*NamedMapOpts) Name ¶
func (o *NamedMapOpts) Name() string
Name returns the name of the NamedMapOpts in the configuration.
type NamedOption ¶
type NamedOption interface {
Name() string
}
NamedOption is an interface that list and map options with names implement.
type ValidatorFctListType ¶
ValidatorFctListType defines a validator function that returns a validated list of string and/or an error
type ValidatorFctType ¶
ValidatorFctType defines a validator function that returns a validated string and/or an error.
Source Files