encoder

Documentation

Overview

Package encoder supports to encode and decode structs in multiple formats.

Index

• func Decode(enc Encoder, b []byte, v interface{}) error
• func DecodeReader(enc Encoder, r io.Reader, v interface{}) error
• func Ptr(i interface{}) (ptr reflect.Value, elem reflect.Value)
• type DecodeDetail
  • func AnalyzeSetHinter(d DecodeDetail, v interface{}) DecodeDetail
  • func (d DecodeDetail) IsValid([]byte) error
• type DecodeFunc
• type Encoder
• type Encoders
  • func NewEncoders() *Encoders
  • func (encs *Encoders) Find(ht hint.Hint) Encoder

Functions

func Decode

func Decode(enc Encoder, b []byte, v interface{}) error

func DecodeReader

func DecodeReader(enc Encoder, r io.Reader, v interface{}) error

func Ptr

func Ptr(i interface{}) (ptr reflect.Value, elem reflect.Value)

Types

type DecodeDetail

type DecodeDetail struct {
	Instance interface{}
	Decode   DecodeFunc
	Desc     string
	Hint     hint.Hint
}

func AnalyzeSetHinter

func AnalyzeSetHinter(d DecodeDetail, v interface{}) DecodeDetail

func (DecodeDetail) IsValid

func (d DecodeDetail) IsValid([]byte) error

type DecodeFunc

type DecodeFunc func([]byte, hint.Hint) (interface{}, error)

type Encoder

type Encoder interface {
	hint.Hinter
	Add(DecodeDetail) error
	AddHinter(hint.Hinter) error
	Marshal(interface{}) ([]byte, error) // NOTE native marshaler func
	Unmarshal([]byte, interface{}) error // NOTE native unmarshaler func
	StreamEncoder(io.Writer) util.StreamEncoder
	StreamDecoder(io.Reader) util.StreamDecoder
	Decode([]byte) (interface{}, error)                        // NOTE decode by hint inside []byte
	DecodeWithHint([]byte, hint.Hint) (interface{}, error)     // NOTE decode []byte by given hint
	DecodeWithHintType([]byte, hint.Type) (interface{}, error) // NOTE decode []byte by given type
	DecodeWithFixedHintType(string, int) (interface{}, error)  // NOTE decode string by fixed type size
	DecodeSlice([]byte) ([]interface{}, error)                 // NOTE decode sliced data
}

type Encoders

type Encoders struct {
	*hint.CompatibleSet
}

func NewEncoders

func NewEncoders() *Encoders

func (*Encoders) Find

func (encs *Encoders) Find(ht hint.Hint) Encoder