mtos

Documentation

Index

• func Decode(dst any, src map[string][]string) error
• func IgnoreUnknownKeys(i bool)
• func MapFormByTag(ptr interface{}, setter Setter, tag string) error
• func RegisterConverter(value interface{}, converterFunc reflecti.StringConverter)
• func SetAliasTag(tag string)
• func SetByKV(value reflect.Value, field *reflect.StructField, kv PeekV, tagValue string) (isSet bool, err error)
• func SetByKVs(value reflect.Value, field *reflect.StructField, kv PeekVs, tagValue string, ...) (isSet bool, err error)
• func SetFieldByString(dst any, field, value string) error
• func SetValueByString(field reflect.Value, value string) error
• func Unmarshal(dst any, mapData map[string]any, opts ...DecoderConfigOption) error
• func ZeroEmpty(z bool)
• type Args
  • func (args Args) Peek(key string) (v string, ok bool)
  • func (args Args) TrySet(value reflect.Value, field *reflect.StructField, key string) (isSet bool, err error)
• type Args2
  • func (args Args2) Peek(key string) (v []string, ok bool)
  • func (args Args2) TrySet(value reflect.Value, field *reflect.StructField, key string, opt SetOptions) (isSet bool, err error)
• type ConversionError
  • func (e ConversionError) Error() string
• type Decoder
  • func DefaultDecoder() *Decoder
  • func NewDecoder(tag string) *Decoder
  • func (d *Decoder) Decode(dst interface{}, src map[string][]string) error
  • func (d *Decoder) IgnoreUnknownKeys(i bool)
  • func (d *Decoder) RegisterConverter(value interface{}, converterFunc reflecti.StringConverter)
  • func (d *Decoder) SetAliasTag(tag string)
  • func (d *Decoder) ZeroEmpty(z bool)
• type DecoderConfigOption
• type EmptyFieldError
  • func (e EmptyFieldError) Error() string
• type Encoder
  • func NewEncoder(tag string) *Encoder
  • func (e *Encoder) Encode(src interface{}, dst map[string][]string) error
  • func (e *Encoder) RegisterEncoder(value interface{}, encoder func(reflect.Value) string)
  • func (e *Encoder) SetAliasTag(tag string)
• type KVSource
  • func (form KVSource) Peek(key string) (string, bool)
  • func (form KVSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string) (isSet bool, err error)
• type KVsSource
  • func (form KVsSource) Peek(key string) ([]string, bool)
  • func (form KVsSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string, ...) (isSet bool, err error)
• type PeekV
• type PeekVs
• type PeekVsSource
  • func (args PeekVsSource) Peek(key string) (v []string, ok bool)
  • func (args PeekVsSource) TrySet(value reflect.Value, field *reflect.StructField, key string, opt SetOptions) (isSet bool, err error)
• type SetOptions
• type Setter
• type UnknownKeyError
  • func (e UnknownKeyError) Error() string

Functions

func Decode

func Decode(dst any, src map[string][]string) error

func IgnoreUnknownKeys

func IgnoreUnknownKeys(i bool)

func MapFormByTag

func MapFormByTag(ptr interface{}, setter Setter, tag string) error

func RegisterConverter

func RegisterConverter(value interface{}, converterFunc reflecti.StringConverter)

RegisterConverter registers a converter function for a custom type.

func SetAliasTag

func SetAliasTag(tag string)

func SetByKV

func SetByKV(value reflect.Value, field *reflect.StructField, kv PeekV, tagValue string) (isSet bool, err error)

func SetByKVs

func SetByKVs(value reflect.Value, field *reflect.StructField, kv PeekVs, tagValue string, opt SetOptions) (isSet bool, err error)

func SetFieldByString

func SetFieldByString(dst any, field, value string) error

func SetValueByString

func SetValueByString(field reflect.Value, value string) error

func Unmarshal

func Unmarshal(dst any, mapData map[string]any, opts ...DecoderConfigOption) error

func ZeroEmpty

func ZeroEmpty(z bool)

Types

type Args

type Args []PeekV

func (Args) Peek

func (args Args) Peek(key string) (v string, ok bool)

func (Args) TrySet

func (args Args) TrySet(value reflect.Value, field *reflect.StructField, key string) (isSet bool, err error)

type Args2

type Args2 []PeekVs

func (Args2) Peek

func (args Args2) Peek(key string) (v []string, ok bool)

func (Args2) TrySet

func (args Args2) TrySet(value reflect.Value, field *reflect.StructField, key string, opt SetOptions) (isSet bool, err error)

type ConversionError

type ConversionError struct {
	Key   string       // key from the source map.
	Type  reflect.Type // expected type of elem
	Index int          // index for multi-value fields; -1 for single-value fields.
	Err   error        // low-level error (when it exists)
}

ConversionError stores information about a failed conversion.

func (ConversionError) Error

func (e ConversionError) Error() string

type Decoder

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

Decoder decodes values from a map[string][]string to a struct.

func DefaultDecoder

func DefaultDecoder() *Decoder

func NewDecoder

func NewDecoder(tag string) *Decoder

NewDecoder returns a new Decoder.

func (*Decoder) Decode

func (d *Decoder) Decode(dst interface{}, src map[string][]string) error

Decode decodes a map[string][]string to a struct.

The first parameter must be a pointer to a struct.

The second parameter is a map, typically url.Values from an HTTP request. Keys are "paths" in dotted notation to the struct fields and nested structs.

See the package documentation for a full explanation of the mechanics.

func (*Decoder) IgnoreUnknownKeys

func (d *Decoder) IgnoreUnknownKeys(i bool)

IgnoreUnknownKeys controls the behaviour when the Decoder encounters unknown keys in the map. If i is true and an unknown field is encountered, it is ignored. This is similar to how unknown keys are handled by encoding/json. If i is false then Decode will return an error. Note that any valid keys will still be decoded in to the target struct.

To preserve backwards compatibility, the default value is false.

func (*Decoder) RegisterConverter

func (d *Decoder) RegisterConverter(value interface{}, converterFunc reflecti.StringConverter)

RegisterConverter registers a converter function for a custom type.

func (*Decoder) SetAliasTag

func (d *Decoder) SetAliasTag(tag string)

SetAliasTag changes the Tag used to locate custom field aliases. The default Tag is "schema".

func (*Decoder) ZeroEmpty

func (d *Decoder) ZeroEmpty(z bool)

ZeroEmpty controls the behaviour when the Decoder encounters empty values in a map. If z is true and a key in the map has the empty string as a value then the corresponding struct field is set to the zero value. If z is false then empty strings are ignored.

The default value is false, that is empty values do not change the value of the struct field.

type DecoderConfigOption

type DecoderConfigOption func(*mapstructure.DecoderConfig)

type EmptyFieldError

type EmptyFieldError struct {
	Key string // required key in the source map.
}

EmptyFieldError stores information about an empty required field.

func (EmptyFieldError) Error

func (e EmptyFieldError) Error() string

type Encoder

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

Encoder encodes values from a struct into url.Values.

func NewEncoder

func NewEncoder(tag string) *Encoder

NewEncoder returns a new Encoder with defaults.

func (*Encoder) Encode

func (e *Encoder) Encode(src interface{}, dst map[string][]string) error

Encode encodes a struct into map[string][]string.

Intended for use with url.Values.

func (*Encoder) RegisterEncoder

func (e *Encoder) RegisterEncoder(value interface{}, encoder func(reflect.Value) string)

RegisterEncoder registers a converter for encoding a custom type.

func (*Encoder) SetAliasTag

func (e *Encoder) SetAliasTag(tag string)

SetAliasTag changes the Tag used to locate custom field aliases. The default Tag is "schema".

type KVSource

type KVSource map[string]string

func (KVSource) Peek

func (form KVSource) Peek(key string) (string, bool)

func (KVSource) TrySet

func (form KVSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string) (isSet bool, err error)

TrySet tries to set a value by request's form source (like map[string][]string)

type KVsSource

type KVsSource map[string][]string

func (KVsSource) Peek

func (form KVsSource) Peek(key string) ([]string, bool)

func (KVsSource) TrySet

func (form KVsSource) TrySet(value reflect.Value, field *reflect.StructField, tagValue string, opt SetOptions) (isSet bool, err error)

TrySet tries to set a value by request's form source (like map[string][]string)

type PeekV

type PeekV interface {
	Peek(key string) (string, bool)
}

type PeekVs

type PeekVs interface {
	Peek(key string) ([]string, bool)
}

type PeekVsSource

type PeekVsSource []PeekVs

func (PeekVsSource) Peek

func (args PeekVsSource) Peek(key string) (v []string, ok bool)

func (PeekVsSource) TrySet

func (args PeekVsSource) TrySet(value reflect.Value, field *reflect.StructField, key string, opt SetOptions) (isSet bool, err error)

type SetOptions

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

type Setter

type Setter interface {
	TrySet(value reflect.Value, field *reflect.StructField, key string, opt SetOptions) (isSet bool, err error)
}

Setter tries to set value on a walking by fields of a struct

type UnknownKeyError

type UnknownKeyError struct {
	Key string // key from the source map.
}

UnknownKeyError stores information about an unknown key in the source map.

func (UnknownKeyError) Error

func (e UnknownKeyError) Error() string