xcodec

Documentation

Index

• func Register(codec Codec)
• type Codec
  • func Get(name string) (Codec, bool)
  • func MustGet(name string) Codec
• type StreamCodec
• type StreamRead
• type StreamReadExt
• type StreamWrite
• type StreamWriteExt

Functions

func Register

func Register(codec Codec)

Register register codec to global registry. If codec with same name exist, the new one will replace the old one

Types

type Codec

type Codec interface {
	// Name is name/id of this codec strategy, like json/yaml etc...
	Name() string
	Marshal(v interface{}) ([]byte, error)
	Unmarshal(data []byte, v interface{}) error
}

Codec is definition of encoding can marshal/unmarshal data

func Get

func Get(name string) (Codec, bool)

Get get codec by name

func MustGet

func MustGet(name string) Codec

MustGet must get codec by name, if not exists, panic

type StreamCodec

type StreamCodec interface {
	Encode(w io.Writer, v interface{}) error
	Decode(r io.Reader, v interface{}) error
	Name() string
}

type StreamRead

type StreamRead interface {
	Read(p []byte) error
}

type StreamReadExt

type StreamReadExt interface {
	StreamRead
	ByteOrder() binary.ByteOrder
	Codec() Codec
	ReadInt8(i *int8) error
	ReadInt16(i *int16) error
	ReadInt32(i *int32) error
	ReadInt64(i *int64) error

	ReadUint8(i *uint8) error
	ReadUint16(i *uint16) error
	ReadUint32(i *uint32) error
	ReadUint64(i *uint64) error

	ReadFloat32(f *float32) error
	ReadFloat64(f *float64) error

	ReadString(str *string) error

	ReadBool(b *bool) error

	ReadAny(v interface{}) error
}

type StreamWrite

type StreamWrite interface {
	Write(p []byte) error
}

type StreamWriteExt

type StreamWriteExt interface {
	StreamWrite
	ByteOrder() binary.ByteOrder
	Codec() Codec
	WriteInt8(i int8) error
	WriteInt16(i int16) error
	WriteInt32(i int32) error
	WriteInt64(i int64) error

	WriteUint8(i uint8) error
	WriteUint16(i uint16) error
	WriteUint32(i uint32) error
	WriteUint64(i uint64) error

	WriteFloat32(f float32) error
	WriteFloat64(f float64) error

	WriteString(str string) error

	WriteBool(b bool) error

	WriteAny(v interface{}) error
}