encoding

Documentation

Index

• func DecodeMessagePack(in []byte, out interface{}) error
• func DecodeString(b []byte) (int, string, error)
• func EncodeMessagePack(msg interface{}) ([]byte, error)
• func EncodeString(s string) ([]byte, error)
• func NewMsgPackHandle() *codec.MsgpackHandle
• type MessagePackCodec
  • func InitMessagePack() MessagePackCodec
  • func (m *MessagePackCodec) AddExtension(t reflect.Type, id byte, encoder func(reflect.Value) ([]byte, error), ...) error
  • func (m *MessagePackCodec) Decode(in []byte, out interface{}) error
  • func (m *MessagePackCodec) Encode(msg interface{}) ([]byte, error)
• type MessagePackCodecDecoder
  • func NewMessagePackDecoder(b []byte) *MessagePackCodecDecoder
  • func (m *MessagePackCodecDecoder) Decode(msg interface{}) error
• type MessagePackCodecEncoder
  • func NewMessagePackEncoder() *MessagePackCodecEncoder
  • func (m *MessagePackCodecEncoder) Bytes() []byte
  • func (m *MessagePackCodecEncoder) Encode(msg interface{}) error

Functions

func DecodeMessagePack

func DecodeMessagePack(in []byte, out interface{}) error

DecodeMessagePack function decodes a byte slice of MessagePack data into a given object.

func DecodeString

func DecodeString(b []byte) (int, string, error)

DecodeString converts an input byte slice into a string. Arguments:

b: Input byte slice to be decoded.

Returns: - Integer: Length of byte representation of the string. - String: Decoded string. - Error: 'invalid length' if slice is empty or insufficient length, else nil.

The function reads the first byte as string length (l), creates a slice of length l and returns the formed string.

func EncodeMessagePack

func EncodeMessagePack(msg interface{}) ([]byte, error)

EncodeMessagePack function encodes a given object into MessagePack format.

func EncodeString

func EncodeString(s string) ([]byte, error)

EncodeString Functions for encoding and decoding strings to and from byte slices.

func NewMsgPackHandle

func NewMsgPackHandle() *codec.MsgpackHandle

NewMsgPackHandle is a helper function to create a new instance of MsgpackHandle

Types

type MessagePackCodec

type MessagePackCodec struct {
	MsgPack *codec.MsgpackHandle
	// contains filtered or unexported fields
}

MessagePackCodec struct, holds references to MessagePack handler and byte slice, along with Encoder and Decoder, and a typeMap for storing reflect.Type

func InitMessagePack

func InitMessagePack() MessagePackCodec

InitMessagePack function initializes MessagePackCodec struct and returns it.

func (*MessagePackCodec) AddExtension

func (m *MessagePackCodec) AddExtension(
	t reflect.Type,
	id byte,
	encoder func(reflect.Value) ([]byte, error),
	decoder func(reflect.Value, []byte) error) error

AddExtension method allows for setting custom encoders/decoders for specific reflect.Types.

func (*MessagePackCodec) Decode

func (m *MessagePackCodec) Decode(in []byte, out interface{}) error

Decode on MessagePackCodec type, using a byte slice as input.

func (*MessagePackCodec) Encode

func (m *MessagePackCodec) Encode(msg interface{}) ([]byte, error)

Encode method for MessagePackCodec. It encodes the input value into a byte slice using MessagePack. Returns encoded byte slice or error.

type MessagePackCodecDecoder

type MessagePackCodecDecoder struct {
	*MessagePackCodec
}

MessagePackCodecDecoder struct, holds a reference to a MessagePackCodec instance.

func NewMessagePackDecoder

func NewMessagePackDecoder(b []byte) *MessagePackCodecDecoder

NewMessagePackDecoder function takes in a byte slice, and returns a pointer to newly created and initialized MessagePackCodecDecoder

func (*MessagePackCodecDecoder) Decode

func (m *MessagePackCodecDecoder) Decode(msg interface{}) error

Decode is a method on MessagePackCodecDecoder that decodes MessagePack data into the provided interface; returns an error if any decoding issues occur.

type MessagePackCodecEncoder

type MessagePackCodecEncoder struct {
	MessagePackCodec // Embedded MessagePackCodec
}

MessagePackCodecEncoder struct derives from MessagePackCodec it manages IDs and counts of the encoded objects.

func NewMessagePackEncoder

func NewMessagePackEncoder() *MessagePackCodecEncoder

NewMessagePackEncoder function creates new MessagePackCodecEncoder and initializes it.

func (*MessagePackCodecEncoder) Bytes

func (m *MessagePackCodecEncoder) Bytes() []byte

Bytes is a method for MessagePackCodecEncoder. It returns a byte slice pointer b.

func (*MessagePackCodecEncoder) Encode

func (m *MessagePackCodecEncoder) Encode(msg interface{}) error

Encode is a method for MessagePackCodecEncoder. It takes in msg of type interface{} as input, that is to be encoded. Returns an error if encountered during encoding.