schema: github.com/iris-contrib/schema Index | Files

package schema

import "github.com/iris-contrib/schema"

Index

Package Files

cache.go converter.go decoder.go encoder.go schema.go

func Decode Uses

func Decode(values map[string][]string, ptr interface{}) error

Decode maps "values" to "ptr". With one of the "form", "url" or "schema" tag fields that can override the field's name mapping to key.

func DecodeForm Uses

func DecodeForm(values map[string][]string, ptr interface{}) error

DecodeForm maps "values" to "ptr". With "form" tag for fields.

func DecodeQuery Uses

func DecodeQuery(values map[string][]string, ptr interface{}) error

DecodeQuery maps "values" to "ptr". With "url" tag for fields.

func IsErrPath Uses

func IsErrPath(err error) bool

IsErrPath reports whether the incoming error is type of unknown field passed, which can be ignored when server allows unknown post values to be sent by the client.

type ConversionError Uses

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 Uses

func (e ConversionError) Error() string

type Converter Uses

type Converter func(string) reflect.Value

type Decoder Uses

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

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

func NewDecoder Uses

func NewDecoder() *Decoder

NewDecoder returns a new Decoder.

func (*Decoder) AddAliasTag Uses

func (d *Decoder) AddAliasTag(tag ...string)

AddAliasTag adds a tag used to locate custom field aliases. Defaults are "schema", "form" and "url".

func (*Decoder) Decode Uses

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 Uses

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 Uses

func (d *Decoder) RegisterConverter(value interface{}, converterFunc Converter)

RegisterConverter registers a converter function for a custom type.

func (*Decoder) SetAliasTag Uses

func (d *Decoder) SetAliasTag(tag ...string)

SetAliasTag overrides the tags.

func (*Decoder) ZeroEmpty Uses

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 EmptyFieldError Uses

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

EmptyFieldError stores information about an empty required field.

func (EmptyFieldError) Error Uses

func (e EmptyFieldError) Error() string

type Encoder Uses

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

Encoder encodes values from a struct into url.Values.

func NewEncoder Uses

func NewEncoder() *Encoder

NewEncoder returns a new Encoder with defaults.

func (*Encoder) AddAliasTag Uses

func (e *Encoder) AddAliasTag(tag ...string)

AddAliasTag adds a tag used to locate custom field aliases. Defaults are "schema", "form" and "url".

func (*Encoder) Encode Uses

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 Uses

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

RegisterEncoder registers a converter for encoding a custom type.

func (*Encoder) SetAliasTag Uses

func (e *Encoder) SetAliasTag(tag ...string)

SetAliasTag overrides the tags.

type MultiError Uses

type MultiError map[string]error

MultiError stores multiple decoding errors.

Borrowed from the App Engine SDK.

func (MultiError) Error Uses

func (e MultiError) Error() string

type UnknownKeyError Uses

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

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

func (UnknownKeyError) Error Uses

func (e UnknownKeyError) Error() string

Package schema imports 7 packages (graph) and is imported by 7 packages. Updated 2019-07-24. Refresh now. Tools for package owners. This is a quick bug-fix fork (has fewer than three commits, and only during the week it was created).