codec

Documentation

Index

• Constants
• type Codec
  • func New(tagName string, maxSliceLen int) Codec
  • func NewDefault() Codec
• type Manager
  • func NewDefaultManager() Manager
  • func NewManager(maxSize int) Manager
• type Registry

Constants

const (

	// DefaultTagName that enables serialization.
	DefaultTagName = "serialize"

	// TagValue is the value the tag must have to be serialized.
	TagValue = "true"
)

Types

type Codec

type Codec interface {
	Registry
	MarshalInto(interface{}, *wrappers.Packer) error
	Unmarshal([]byte, interface{}) error
}

Codec marshals and unmarshals

func New

func New(tagName string, maxSliceLen int) Codec

New returns a new, concurrency-safe codec

func NewDefault

func NewDefault() Codec

NewDefault returns a new codec with reasonable default values

type Manager

type Manager interface {
	// Associate the given codec with the given version ID
	RegisterCodec(version uint16, codec Codec) error

	// Define the maximum size, in bytes, of something serialized/deserialized
	// by this codec manager
	SetMaxSize(int)

	// Marshal the given value using the codec with the given version.
	// RegisterCodec must have been called with that version.
	Marshal(version uint16, source interface{}) (destination []byte, err error)

	// Unmarshal the given bytes into the given destination. [destination] must
	// be a pointer or an interface. Returns the version of the codec that
	// produces the given bytes.
	Unmarshal(source []byte, destination interface{}) (version uint16, err error)
}

Manager describes the functionality for managing codec versions.

func NewDefaultManager

func NewDefaultManager() Manager

NewDefaultManager returns a new codec manager.

func NewManager

func NewManager(maxSize int) Manager

NewManager returns a new codec manager.

type Registry

type Registry interface {
	Skip(int)
	RegisterType(interface{}) error
}

Registry registers new types that can be marshaled into