schema

README

schema

Package iris-contrib/schema is a clone of https://github.com/gorilla/schema with two additional minor but required features:

1. Default package-level decoders for forms and url queries
2. Able to use more than one struct field tag to map a field with a key, which is useful when the same struct needs to be mapped with URL query string and form data, as requested two tags names are required so.

License

Copyright (c) 2012 Rodrigo Moraes. All rights reserved. Copyright (c) 2019 Gerasimos Maropoulos for edits. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright

notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Documentation

Index

• Variables
• func Decode(values map[string][]string, ptr interface{}) error
• func DecodeForm(values map[string][]string, ptr interface{}) error
• func DecodeHeaders(values map[string][]string, ptr interface{}) error
• func DecodeParams(values map[string][]string, ptr interface{}) error
• func DecodeQuery(values map[string][]string, ptr interface{}) error
• func IsErrPath(err error) bool
• type ConversionError
  • func (e ConversionError) Error() string
• type Converter
• type Decoder
  • func NewDecoder() *Decoder
  • func (d *Decoder) AddAliasTag(tag ...string) *Decoder
  • func (d *Decoder) Decode(dst interface{}, src map[string][]string) error
  • func (d *Decoder) IgnoreUnknownKeys(i bool) *Decoder
  • func (d *Decoder) RegisterConverter(value interface{}, converterFunc Converter) *Decoder
  • func (d *Decoder) SetAliasTag(tag ...string) *Decoder
  • func (d *Decoder) ZeroEmpty(z bool) *Decoder
• type EmptyFieldError
  • func (e EmptyFieldError) Error() string
• type Encoder
  • func NewEncoder() *Encoder
  • func (e *Encoder) AddAliasTag(tag ...string)
  • 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 MultiError
  • func (e MultiError) Error() string
• type UnknownKeyError
  • func (e UnknownKeyError) Error() string

Variables

var (

	// Form Decoder. The default instance for DecodeForm function.
	Form = NewDecoder().SetAliasTag("form")
	// Query Decoder. The default instance for DecodeQuery function.
	Query = NewDecoder().SetAliasTag("url").IgnoreUnknownKeys(true) // allow unknown url queries
	// Headers Decoder. The default instance for DecodeHeaders function.
	Headers = NewDecoder().SetAliasTag("header").IgnoreUnknownKeys(true)
	// Params Decoder. The default instance for DecodeParams function.
	Params = NewDecoder().SetAliasTag("param").IgnoreUnknownKeys(true)
)

Functions

func Decode

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

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

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

func DecodeHeaders

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

DecodeHeaders maps "values" to "ptr". With "header" tag for fields.

func DecodeParams

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

DecodeParams maps "values" to "ptr". With "param" tag for fields.

func DecodeQuery

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

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

func IsErrPath

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.

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 Converter

type Converter func(string) reflect.Value

type Decoder

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

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

func NewDecoder

func NewDecoder() *Decoder

NewDecoder returns a new Decoder.

func (*Decoder) AddAliasTag

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

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

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

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 Converter) *Decoder

RegisterConverter registers a converter function for a custom type.

func (*Decoder) SetAliasTag

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

SetAliasTag overrides the tags.

func (*Decoder) ZeroEmpty

func (d *Decoder) ZeroEmpty(z bool) *Decoder

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

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) AddAliasTag

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

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 overrides the tags.

type MultiError

type MultiError map[string]error

MultiError stores multiple decoding errors.

Borrowed from the App Engine SDK.

func (MultiError) Error

func (e MultiError) Error() string

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