codec

Documentation

Overview

Package codec is the registration center for supported codecs you can register whatever codec implementation you want

e.g. for json codec, you can register you own codec implementation based on other json library (other than encoding/json)

by default, using encoding/json for json codec and gogoproto for protobuf codec

Index

• func GetBytesBuf(size int) []byte
• func PutBytesBuf(b *[]byte)
• func Register(kind arhatgopb.CodecType, codec Interface)
• type Decoder
• type Encoder
• type Interface
  • func Get(kind arhatgopb.CodecType) (Interface, bool)
• type MarshalFunc
• type UnmarshalFunc

Functions

func GetBytesBuf

func GetBytesBuf(size int) []byte

func PutBytesBuf

func PutBytesBuf(b *[]byte)

func Register

func Register(kind arhatgopb.CodecType, codec Interface)

Types

type Decoder

type Decoder interface {
	// Decode one message from stream
	Decode(out interface{}) error
}

Decoder for stream data decoding

type Encoder

type Encoder interface {
	// Encode one message to stream
	Encode(any interface{}) error
}

Encoder for stream data encoding

type Interface

type Interface interface {
	// Type is the codec kind
	Type() arhatgopb.CodecType

	// NewEncoder creates a new Encoder which will encode messages to the Writer
	NewEncoder(w io.Writer) Encoder

	// NewEncoder creates a new Decoder which will decode messages from the Reader
	NewDecoder(r io.Reader) Decoder

	// Unmarshal non stream data
	Unmarshal(data []byte, out interface{}) error

	// Marshal v as non stream data
	Marshal(v interface{}) ([]byte, error)
}

Interface of codec knows how to encode/decode all kinds of data, including stream data

func Get

func Get(kind arhatgopb.CodecType) (Interface, bool)

type MarshalFunc

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

type UnmarshalFunc

type UnmarshalFunc func(data []byte, out interface{}) error