Categorygithub.com/iris-contrib/schema
modulepackage
0.0.6
Repository: https://github.com/iris-contrib/schema.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
7
Dependents
21
Files
1k SLOC

# README

schema

Build Status

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.

# Functions

Decode maps "values" to "ptr".
DecodeForm maps "values" to "ptr".
DecodeHeaders maps "values" to "ptr".
DecodeParams maps "values" to "ptr".
DecodeQuery maps "values" to "ptr".
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.
NewDecoder returns a new Decoder.
NewEncoder returns a new Encoder with defaults.

# Variables

Form Decoder.
Headers Decoder.
Params Decoder.
allow unknown url queries.

# Structs

ConversionError stores information about a failed conversion.
Decoder decodes values from a map[string][]string to a struct.
EmptyFieldError stores information about an empty required field.
Encoder encodes values from a struct into url.Values.
UnknownKeyError stores information about an unknown key in the source map.

# Type aliases

No description provided by the author
MultiError stores multiple decoding errors.