codec

Documentation

Overview

Package codec is a generated GoMock package.

Index

• Constants
• Variables
• type Codec
• type GeneralCodec
• type Manager
  • func NewDefaultManager() Manager
  • func NewManager(maxSize int) Manager
• type MockManager
  • func NewMockManager(ctrl *gomock.Controller) *MockManager
  • func (m *MockManager) EXPECT() *MockManagerMockRecorder
  • func (m *MockManager) Marshal(arg0 uint16, arg1 any) ([]byte, error)
  • func (m *MockManager) RegisterCodec(arg0 uint16, arg1 Codec) error
  • func (m *MockManager) Size(arg0 uint16, arg1 any) (int, error)
  • func (m *MockManager) Unmarshal(arg0 []byte, arg1 any) (uint16, error)
• type MockManagerMockRecorder
  • func (mr *MockManagerMockRecorder) Marshal(arg0, arg1 any) *gomock.Call
  • func (mr *MockManagerMockRecorder) RegisterCodec(arg0, arg1 any) *gomock.Call
  • func (mr *MockManagerMockRecorder) Size(arg0, arg1 any) *gomock.Call
  • func (mr *MockManagerMockRecorder) Unmarshal(arg0, arg1 any) *gomock.Call
• type Registry

Constants

const (
	VersionSize = wrappers.ShortLen
)

Variables

var (
	ErrUnsupportedType           = errors.New("unsupported type")
	ErrMaxSliceLenExceeded       = errors.New("max slice length exceeded")
	ErrDoesNotImplementInterface = errors.New("does not implement interface")
	ErrUnexportedField           = errors.New("unexported field")
	ErrExtraSpace                = errors.New("trailing buffer space")
	ErrMarshalZeroLength         = errors.New("can't marshal zero length value")
	ErrUnmarshalZeroLength       = errors.New("can't unmarshal zero length value")
)

var (
	ErrUnknownVersion    = errors.New("unknown codec version")
	ErrMarshalNil        = errors.New("can't marshal nil pointer or interface")
	ErrUnmarshalNil      = errors.New("can't unmarshal nil")
	ErrUnmarshalTooBig   = errors.New("byte array exceeds maximum length")
	ErrCantPackVersion   = errors.New("couldn't pack codec version")
	ErrCantUnpackVersion = errors.New("couldn't unpack codec version")
	ErrDuplicatedVersion = errors.New("duplicated codec version")
)

var ErrDuplicateType = errors.New("duplicate type registration")

Types

type Codec

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

	// Returns the size, in bytes, of [value] when it's marshaled
	Size(value interface{}) (int, error)
}

Codec marshals and unmarshals

type GeneralCodec

type GeneralCodec interface {
	Codec
	Registry
}

GeneralCodec marshals and unmarshals structs including interfaces

type Manager

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

	// Size returns the size, in bytes, of [value] when it's marshaled
	// using the codec with the given version.
	// RegisterCodec must have been called with that version.
	// If [value] is nil, returns [ErrMarshalNil]
	Size(version uint16, value interface{}) (int, error)

	// 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 MockManager

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

MockManager is a mock of Manager interface.

func NewMockManager

func NewMockManager(ctrl *gomock.Controller) *MockManager

NewMockManager creates a new mock instance.

func (*MockManager) EXPECT

func (m *MockManager) EXPECT() *MockManagerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockManager) Marshal

func (m *MockManager) Marshal(arg0 uint16, arg1 any) ([]byte, error)

Marshal mocks base method.

func (*MockManager) RegisterCodec

func (m *MockManager) RegisterCodec(arg0 uint16, arg1 Codec) error

RegisterCodec mocks base method.

func (*MockManager) Size

func (m *MockManager) Size(arg0 uint16, arg1 any) (int, error)

Size mocks base method.

func (*MockManager) Unmarshal

func (m *MockManager) Unmarshal(arg0 []byte, arg1 any) (uint16, error)

Unmarshal mocks base method.

type MockManagerMockRecorder

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

MockManagerMockRecorder is the mock recorder for MockManager.

func (*MockManagerMockRecorder) Marshal

func (mr *MockManagerMockRecorder) Marshal(arg0, arg1 any) *gomock.Call

Marshal indicates an expected call of Marshal.

func (*MockManagerMockRecorder) RegisterCodec

func (mr *MockManagerMockRecorder) RegisterCodec(arg0, arg1 any) *gomock.Call

RegisterCodec indicates an expected call of RegisterCodec.

func (*MockManagerMockRecorder) Size

func (mr *MockManagerMockRecorder) Size(arg0, arg1 any) *gomock.Call

Size indicates an expected call of Size.

func (*MockManagerMockRecorder) Unmarshal

func (mr *MockManagerMockRecorder) Unmarshal(arg0, arg1 any) *gomock.Call

Unmarshal indicates an expected call of Unmarshal.

type Registry

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

Registry registers new types that can be marshaled into