codec

Documentation

Index

• Constants
• Variables
• func DecodeAny(tc TypeCodec, to *TypedObj) (interface{}, error)
• func LimitReader(r io.Reader, n int64) io.Reader
• func Marshal(w io.Writer, v interface{}) error
• func MarshalAny(c Codec, tc TypeCodec, o interface{}) ([]byte, error)
• func MarshalToBytes(v interface{}) ([]byte, error)
• func MustMarshalToBytes(v interface{}) []byte
• func MustUnmarshalFromBytes(b []byte, v interface{}) []byte
• func Unmarshal(r io.Reader, v interface{}) error
• func UnmarshalAny(c Codec, tc TypeCodec, bs []byte) (interface{}, error)
• func UnmarshalFromBytes(b []byte, v interface{}) ([]byte, error)
• type Codec
• type DecodeAndCloser
  • func NewDecoder(r Reader) DecodeAndCloser
  • func NewSimpleDecoder(r io.Reader) DecodeAndCloser
• type DecodeSelfer
• type Decoder
• type EncodeAndCloser
  • func NewEncoder(w Writer) EncodeAndCloser
  • func NewEncoderBytes(b *[]byte) EncodeAndCloser
  • func NewSimpleEncoder(w io.Writer) EncodeAndCloser
• type EncodeSelfer
• type Encoder
• type Marshaler
• type ReadSelfer
• type Reader
• type Selfer
• type TypeCodec
• type TypedDict
  • func (m *TypedDict) RLPReadSelf(r Reader) error
  • func (m *TypedDict) RLPWriteSelf(w Writer) error
• type TypedObj
  • func EncodeAny(tc TypeCodec, o interface{}) (*TypedObj, error)
  • func (o *TypedObj) RLPDecodeSelf(d Decoder) error
  • func (o *TypedObj) RLPEncodeSelf(e Encoder) error
• type Unmarshaler
• type WriteSelfer
• type Writer

Constants

const (
	TypeNil uint8 = iota
	TypeDict
	TypeList
	TypeBytes
	TypeString
	TypeBool
	TypeCustom = 10
)

const MaxSizeForBytes = 1e6

MaxSizeForBytes is size limit for bytes buffer. msgpack decoder already has limit to 1 MB

Variables

var (
	ErrNilValue      = errors.New("NilValueError")
	ErrInvalidFormat = errors.New("InvalidFormatError")
	ErrIllegalType   = errors.New("IllegalTypeError")
)

var (
	TrueBytes  = []byte{0x01}
	FalseBytes = []byte{0x00}
)

var (
	BC = RLP
)

var MP = bytesWrapper{&mpCodecObject}

var Nil = &TypedObj{
	typedObjBase{
		TypeNil, nil,
	},
}

var RLP = bytesWrapper{&rlpCodecObject}

Functions

func DecodeAny

func DecodeAny(tc TypeCodec, to *TypedObj) (interface{}, error)

func LimitReader

func LimitReader(r io.Reader, n int64) io.Reader

func Marshal

func Marshal(w io.Writer, v interface{}) error

func MarshalAny

func MarshalAny(c Codec, tc TypeCodec, o interface{}) ([]byte, error)

func MarshalToBytes

func MarshalToBytes(v interface{}) ([]byte, error)

func MustMarshalToBytes

func MustMarshalToBytes(v interface{}) []byte

func MustUnmarshalFromBytes

func MustUnmarshalFromBytes(b []byte, v interface{}) []byte

func Unmarshal

func Unmarshal(r io.Reader, v interface{}) error

func UnmarshalAny

func UnmarshalAny(c Codec, tc TypeCodec, bs []byte) (interface{}, error)

func UnmarshalFromBytes

func UnmarshalFromBytes(b []byte, v interface{}) ([]byte, error)

Types

type Codec

type Codec interface {
	Marshal(w io.Writer, v interface{}) error
	Unmarshal(r io.Reader, v interface{}) error
	MarshalToBytes(v interface{}) ([]byte, error)
	UnmarshalFromBytes(b []byte, v interface{}) ([]byte, error)
	MustMarshalToBytes(v interface{}) []byte
	MustUnmarshalFromBytes(b []byte, v interface{}) []byte
	NewEncoderBytes(b *[]byte) EncodeAndCloser
	// contains filtered or unexported methods
}

type DecodeAndCloser

type DecodeAndCloser interface {
	Decoder
	Close() error
}

func NewDecoder

func NewDecoder(r Reader) DecodeAndCloser

func NewSimpleDecoder

func NewSimpleDecoder(r io.Reader) DecodeAndCloser

type DecodeSelfer

type DecodeSelfer interface {
	RLPDecodeSelf(d Decoder) error
}

type Decoder

type Decoder interface {
	Skip(cnt int) error
	Decode(o interface{}) error
	DecodeMulti(objs ...interface{}) (int, error)
	DecodeAll(objs ...interface{}) error
	DecodeBytes() ([]byte, error)
	DecodeList() (Decoder, error)
	DecodeListOf(objs ...interface{}) error
	SetMaxBytes(sz int) bool
}

type EncodeAndCloser

type EncodeAndCloser interface {
	Encoder
	Close() error
}

func NewEncoder

func NewEncoder(w Writer) EncodeAndCloser

func NewEncoderBytes

func NewEncoderBytes(b *[]byte) EncodeAndCloser

func NewSimpleEncoder

func NewSimpleEncoder(w io.Writer) EncodeAndCloser

type EncodeSelfer

type EncodeSelfer interface {
	RLPEncodeSelf(e Encoder) error
}

type Encoder

type Encoder interface {
	Encode(o interface{}) error
	EncodeMulti(objs ...interface{}) error
	EncodeList() (Encoder, error)
	EncodeListOf(objs ...interface{}) error
}

type Marshaler

type Marshaler interface {
	MarshalRLP() ([]byte, error)
}

type ReadSelfer

type ReadSelfer interface {
	RLPReadSelf(w Reader) error
}

type Reader

type Reader interface {
	Skip(cnt int) error
	ReadList() (Reader, error)
	ReadMap() (Reader, error)
	ReadBytes() ([]byte, error)
	ReadRaw() ([]byte, error)
	ReadValue(v reflect.Value) error
	Close() error
}

type Selfer

type Selfer interface {
	EncodeSelfer
	DecodeSelfer
}

type TypeCodec

type TypeCodec interface {
	Decode(tag uint8, data []byte) (interface{}, error)
	Encode(o interface{}) (uint8, []byte, error)
}

type TypedDict

type TypedDict struct {
	Keys []string
	Map  map[string]*TypedObj
}

func (*TypedDict) RLPReadSelf

func (m *TypedDict) RLPReadSelf(r Reader) error

func (*TypedDict) RLPWriteSelf

func (m *TypedDict) RLPWriteSelf(w Writer) error

type TypedObj

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

func EncodeAny

func EncodeAny(tc TypeCodec, o interface{}) (*TypedObj, error)

func (*TypedObj) RLPDecodeSelf

func (o *TypedObj) RLPDecodeSelf(d Decoder) error

func (*TypedObj) RLPEncodeSelf

func (o *TypedObj) RLPEncodeSelf(e Encoder) error

type Unmarshaler

type Unmarshaler interface {
	UnmarshalRLP([]byte) error
}

type WriteSelfer

type WriteSelfer interface {
	RLPWriteSelf(w Writer) error
}

type Writer

type Writer interface {
	WriteList() (Writer, error)
	WriteMap() (Writer, error)
	WriteBytes(b []byte) error
	WriteRaw(b []byte) error
	WriteValue(v reflect.Value) error
	WriteNull() error
	Close() error
}