encoding

Documentation

Index

• Constants
• Variables
• func Decode(dst interface{}, src interface{}) (err error)
• func Encode(v interface{}) (ev interface{}, err error)
• func IgnoreType(t reflect.Type)
• type DecodeTypeError
  • func (e *DecodeTypeError) Error() string
• type Error
  • func (e *Error) Error() string
• type InvalidUnmarshalError
  • func (e *InvalidUnmarshalError) Error() string
• type Marshaler
• type MarshalerError
  • func (e *MarshalerError) Error() string
• type UnexpectedTypeError
  • func (e *UnexpectedTypeError) Error() string
• type Unmarshaler
• type UnsupportedTypeError
  • func (e *UnsupportedTypeError) Error() string
• type UnsupportedValueError
  • func (e *UnsupportedValueError) Error() string

Constants

const (
	TagName     = "gorethink"
	JSONTagName = "json"
	RefTagName  = "gorethink_ref"
)

Variables

var (
	Tags []string
)

Functions

func Decode

func Decode(dst interface{}, src interface{}) (err error)

Decode decodes map[string]interface{} into a struct. The first parameter must be a pointer.

func Encode

func Encode(v interface{}) (ev interface{}, err error)

Encode returns the encoded value of v.

Encode traverses the value v recursively and looks for structs. If a struct is found then it is checked for tagged fields and convert to map[string]interface{}

func IgnoreType

func IgnoreType(t reflect.Type)

IgnoreType causes the encoder to ignore a type when encoding

Types

type DecodeTypeError

type DecodeTypeError struct {
	DestType, SrcType reflect.Type
	Reason            string
}

An InvalidTypeError describes a value that was not appropriate for a value of a specific Go type.

func (*DecodeTypeError) Error

func (e *DecodeTypeError) Error() string

type Error

type Error struct {
	Errors []string
}

Error implements the error interface and can represents multiple errors that occur in the course of a single decode.

func (*Error) Error

func (e *Error) Error() string

type InvalidUnmarshalError

type InvalidUnmarshalError struct {
	Type reflect.Type
}

func (*InvalidUnmarshalError) Error

func (e *InvalidUnmarshalError) Error() string

type Marshaler

type Marshaler interface {
	MarshalRQL() (interface{}, error)
}

Marshaler is the interface implemented by objects that can marshal themselves into a valid RQL psuedo-type.

type MarshalerError

type MarshalerError struct {
	Type reflect.Type
	Err  error
}

func (*MarshalerError) Error

func (e *MarshalerError) Error() string

type UnexpectedTypeError

type UnexpectedTypeError struct {
	DestType, SrcType reflect.Type
}

An UnsupportedTypeError is returned by Marshal when attempting to encode an unexpected value type.

func (*UnexpectedTypeError) Error

func (e *UnexpectedTypeError) Error() string

type Unmarshaler

type Unmarshaler interface {
	UnmarshalRQL(interface{}) error
}

Unmarshaler is the interface implemented by objects that can unmarshal a psuedo-type object of themselves.

type UnsupportedTypeError

type UnsupportedTypeError struct {
	Type reflect.Type
}

An UnsupportedTypeError is returned by Marshal when attempting to encode an unsupported value type.

func (*UnsupportedTypeError) Error

func (e *UnsupportedTypeError) Error() string

type UnsupportedValueError

type UnsupportedValueError struct {
	Value reflect.Value
	Str   string
}

func (*UnsupportedValueError) Error

func (e *UnsupportedValueError) Error() string