mtos

Documentation

Index

• func Decode(dst any, src map[string][]string) error
• func IgnoreUnknownKeys(i bool)
• func RegisterConverter(value interface{}, converterFunc reflecti.StringConverter)
• func SetAliasTag(tag string)
• func Unmarshal(dst any, mapData map[string]any, opts ...DecoderConfigOption) error
• func ZeroEmpty(z bool)
• type ConversionError
  • func (e ConversionError) Error() string
• type Decoder
  • func DefaultDecoder() *Decoder
  • func NewDecoder() *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() *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 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 RegisterConverter

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

RegisterConverter registers a converter function for a custom type.

func SetAliasTag

func SetAliasTag(tag string)

func Unmarshal

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

func ZeroEmpty

func ZeroEmpty(z bool)

Types

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() *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() *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 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