formbinder

Documentation

Index

• func Decode(vs url.Values, dst interface{}) error
• type DecodeCustomType
• type DecodeCustomTypeField
• type DecodeCustomTypeFunc
• type Decoder
  • func NewDecoder(opts *DecoderOptions) *Decoder
  • func (dec *Decoder) Decode(vs url.Values, dst interface{}) error
  • func (dec *Decoder) RegisterCustomType(fn DecodeCustomTypeFunc, types []interface{}, fields []interface{}) *Decoder
• type DecoderOptions
• type Error
  • func (s *Error) Error() string

Functions

func Decode

func Decode(vs url.Values, dst interface{}) error

Decode decodes the url.Values into a element that must be a pointer to a type provided by argument

Types

type DecodeCustomType

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

DecodeCustomType fields for custom types

type DecodeCustomTypeField

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

DecodeCustomTypeField is a function registered for a specific field of the struct passed to the Decoder

type DecodeCustomTypeFunc

type DecodeCustomTypeFunc func([]string) (interface{}, error)

DecodeCustomTypeFunc is a function that indicate how should to decode a custom type

type Decoder

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

Decoder the main to decode the values

func NewDecoder

func NewDecoder(opts *DecoderOptions) *Decoder

NewDecoder creates a new instance of Decoder

func (*Decoder) Decode

func (dec *Decoder) Decode(vs url.Values, dst interface{}) error

Decode decodes the url.Values into a element that must be a pointer to a type provided by argument

func (*Decoder) RegisterCustomType

func (dec *Decoder) RegisterCustomType(fn DecodeCustomTypeFunc, types []interface{}, fields []interface{}) *Decoder

RegisterCustomType It is the method responsible for register functions for decoding custom types

type DecoderOptions

type DecoderOptions struct {
	// TagName indicates the tag name for decoding a value by the tag
	TagName string
	// PrefUnmarshalText indicates if should to give preference to UnmarshalText over custom type registered
	PrefUnmarshalText 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.
	IgnoreUnknownKeys bool
}

DecoderOptions options for decoding the values

type Error

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

func (*Error) Error

func (s *Error) Error() string