Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Bool ¶
type Bool struct {
// contains filtered or unexported fields
}
Bool is a boolean parameter
func (Bool) Description ¶
func (i Bool) Description() string
type ErrInvalidType ¶
func (ErrInvalidType) Error ¶
func (e ErrInvalidType) Error() string
type ErrInvalidValue ¶
type ErrInvalidValue struct { ParameterName string Value string Context *string // optional context }
func (ErrInvalidValue) Error ¶
func (e ErrInvalidValue) Error() string
type ErrUnrecognizedOption ¶
type ErrUnrecognizedOption struct {
Option string
}
func (ErrUnrecognizedOption) Error ¶
func (e ErrUnrecognizedOption) Error() string
type ErrValueOutOfRange ¶
func (ErrValueOutOfRange) Error ¶
func (e ErrValueOutOfRange) Error() string
type Float ¶
type Float struct {
// contains filtered or unexported fields
}
Float is a float parameter with optional min and max constraints
func (Float) Description ¶
func (i Float) Description() string
type Int ¶
type Int struct {
// contains filtered or unexported fields
}
Int is an int parameter with optional min and max constraints
func (Int) Description ¶
func (i Int) Description() string
type ParamInterface ¶
ParamInterface provides an interface to a parameter
type ParametersInterface ¶
type ParametersInterface interface { ParameterList() List ValidateParam(param *keyvalue.KeyValue) error }
Add a ParametersInterface to a struct to store and validate parameters
func NewParameters ¶
func NewParameters(params List) ParametersInterface
type Str ¶
type Str struct {
// contains filtered or unexported fields
}
Str is a string parameter
func (Str) Description ¶
func (i Str) Description() string
func (Str) ValidValues ¶
Click to show internal directories.
Click to hide internal directories.