package opts

import "github.com/containers/storage/internal/opts"

Index ¶

• Variables
• func ToJSON(a Args) (string, error)
• func ToParam(a Args) (string, error)
• func ValidateIPAddress(val string) (string, error)
• func ValidateLabel(val string) (string, error)
• func ValidateSysctl(val string) (string, error)
• type Args
• func NewArgs(initialArgs ...KeyValuePair) Args
• func ParseFlag(arg string, prev Args) (Args, error)
• 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) bool
• 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
• func NewFilterOpt() FilterOpt
• func (o *FilterOpt) Set(value string) error
• func (o *FilterOpt) String() string
• func (o *FilterOpt) Type() string
• func (o *FilterOpt) Value() Args
• type KeyValuePair
• func Arg(key, value string) KeyValuePair
• type ListOpts
• func NewListOpts(validator ValidatorFctType) ListOpts
• func NewListOptsRef(values *[]string, validator ValidatorFctType) *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
• func NewMapOpts(values map[string]string, validator ValidatorFctType) *MapOpts
• func (opts *MapOpts) GetAll() map[string]string
• func (opts *MapOpts) Set(value string) error
• func (opts *MapOpts) String() string
• func (opts *MapOpts) Type() string
• type NamedListOpts
• func NewNamedListOptsRef(name string, values *[]string, validator ValidatorFctType) *NamedListOpts
• func (o *NamedListOpts) Name() string
• type NamedMapOpts
• func NewNamedMapOpts(name string, values map[string]string, validator ValidatorFctType) *NamedMapOpts
• func (o *NamedMapOpts) Name() string
• type NamedOption
• type ValidatorFctListType
• type ValidatorFctType

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 ToJSON ¶

func ToJSON(a Args) (string, error)

ToJSON returns the Args as a JSON encoded string

func ToParam ¶

func ToParam(a Args) (string, error)

ToParam encodes the Args as args JSON encoded string

Deprecated: use ToJSON

func ValidateIPAddress ¶

func ValidateIPAddress(val string) (string, error)

ValidateIPAddress validates an Ip address.

func ValidateLabel ¶

func ValidateLabel(val string) (string, error)

ValidateLabel validates that the specified string is a valid label, and returns it. Labels are in the form on key=value.

func ValidateSysctl ¶

func ValidateSysctl(val string) (string, error)

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 ParseFlag ¶

func ParseFlag(arg string, prev Args) (Args, error)

ParseFlag parses a key=value string and adds it to an Args.

Deprecated: Use Args.Add()

func (Args) Add ¶

func (args Args) Add(key, value string)

Add a new value to the set of values

func (Args) Contains ¶

func (args Args) Contains(field string) bool

Contains returns true if the key exists in the mapping

func (Args) Del ¶

func (args Args) Del(key, value string)

Del removes a value from the set

func (Args) ExactMatch ¶

func (args Args) ExactMatch(key, source string) bool

ExactMatch returns true if the source matches exactly one of the values.

func (Args) FuzzyMatch ¶

func (args Args) FuzzyMatch(key, source string) bool

FuzzyMatch returns true if the source matches exactly one value, or the source has one of the values as a prefix.

func (Args) Get ¶

func (args Args) Get(key string) []string

Get returns the list of values associated with the key

func (Args) Include ¶

func (args Args) Include(field string) bool

Include returns true if the key exists in the mapping

Deprecated: use Contains

func (Args) Len ¶

func (args Args) Len() int

Len returns the number of keys in the mapping

func (Args) MarshalJSON ¶

func (args Args) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON byte representation of the Args

func (Args) Match ¶

func (args Args) Match(field, source string) bool

Match returns true if any of the values at key match the source string

func (Args) MatchKVList ¶

func (args Args) MatchKVList(key string, sources map[string]string) bool

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 ¶

func (args Args) UniqueExactMatch(key, source string) bool

UniqueExactMatch returns true if there is only one value and the source matches exactly the value.

func (Args) Validate ¶

func (args Args) Validate(accepted map[string]bool) error

Validate compared the set of accepted keys against the keys in the mapping. An error is returned if any mapping keys are not in the accepted set.

func (Args) WalkValues ¶

func (args Args) WalkValues(field string, op func(value string) error) error

WalkValues iterates over the list of values for a key in the mapping and calls op() for each value. If op returns an error the iteration stops and the error is returned.

type FilterOpt ¶

type FilterOpt struct {
	// contains filtered or unexported fields
}

FilterOpt is a flag type for validating filters

func NewFilterOpt ¶

func NewFilterOpt() FilterOpt

NewFilterOpt returns a new FilterOpt

func (*FilterOpt) Set ¶

func (o *FilterOpt) Set(value string) error

Set sets the value of the opt by parsing the command line value

func (*FilterOpt) String ¶

func (o *FilterOpt) String() string

func (*FilterOpt) Type ¶

func (o *FilterOpt) Type() string

Type returns the option type

func (*FilterOpt) Value ¶

func (o *FilterOpt) Value() Args

Value returns the value of this option

type KeyValuePair ¶

type KeyValuePair struct {
	Key   string
	Value string
}

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) Delete ¶

func (opts *ListOpts) Delete(key string)

Delete removes the specified element from the slice.

func (*ListOpts) Get ¶

func (opts *ListOpts) Get(key string) bool

Get checks the existence of the specified key.

func (*ListOpts) GetAll ¶

func (opts *ListOpts) GetAll() []string

GetAll returns the values of slice.

func (*ListOpts) GetAllOrEmpty ¶

func (opts *ListOpts) GetAllOrEmpty() []string

GetAllOrEmpty returns the values of the slice or an empty slice when there are no values.

func (*ListOpts) GetMap ¶

func (opts *ListOpts) GetMap() map[string]struct{}

GetMap returns the content of values in a map in order to avoid duplicates.

func (*ListOpts) Len ¶

func (opts *ListOpts) Len() int

Len returns the amount of element in the slice.

func (*ListOpts) Set ¶

func (opts *ListOpts) Set(value string) error

Set validates if needed the input value and adds it to the internal slice.

func (*ListOpts) String ¶

func (opts *ListOpts) String() string

func (*ListOpts) Type ¶

func (opts *ListOpts) Type() string

Type returns a string name for this Option type

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.

func (*MapOpts) GetAll ¶

func (opts *MapOpts) GetAll() map[string]string

GetAll returns the values of MapOpts as a map.

func (*MapOpts) Set ¶

func (opts *MapOpts) Set(value string) error

Set validates if needed the input value and add it to the internal map, by splitting on '='.

func (*MapOpts) String ¶

func (opts *MapOpts) String() string

func (*MapOpts) Type ¶

func (opts *MapOpts) Type() string

Type returns a string name for this Option type

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 ¶

type ValidatorFctListType func(val string) ([]string, error)

ValidatorFctListType defines a validator function that returns a validated list of string and/or an error

type ValidatorFctType ¶

type ValidatorFctType func(val string) (string, error)

ValidatorFctType defines a validator function that returns a validated string and/or an error.

Source Files ¶

opts.go parse.go