cbor

Documentation

Index

• type Codec
  • func NewCodec() *Codec
  • func (c *Codec) Decode(data []byte) (interface{}, error)
  • func (c *Codec) Encode(v interface{}) ([]byte, error)
  • func (c *Codec) NewDecoder(r io.Reader) network.Decoder
  • func (c *Codec) NewEncoder(w io.Writer) network.Encoder
• type Decoder
  • func (d *Decoder) Decode() (interface{}, error)
• type Encoder
  • func (e *Encoder) Encode(v interface{}) error

Types

type Codec

type Codec struct {
}

Codec represents a CBOR codec for our network.

func NewCodec

func NewCodec() *Codec

NewCodec creates a new CBOR codec.

func (*Codec) Decode

func (c *Codec) Decode(data []byte) (interface{}, error)

Decode will, given a []byte 'envelope', return a Golang interface 'v'. Return an error if unpacking the envelope fails. NOTE: 'v' is the network message payload in un-serialized form. NOTE: 'code' is the message type. NOTE: 'what' is the 'code' name for debugging / instrumentation. NOTE: 'envelope' contains 'code' & serialized / encoded 'v'. i.e. 1st byte is 'code' and remaining bytes are CBOR encoded 'v'. Expected error returns during normal operations:

• codec.ErrInvalidEncoding if message encoding is invalid.
• codec.ErrUnknownMsgCode if message code byte does not match any of the configured message codes.
• codec.ErrMsgUnmarshal if the codec fails to unmarshal the data to the message type denoted by the message code.

func (*Codec) Encode

func (c *Codec) Encode(v interface{}) ([]byte, error)

Encode will, given a Golang interface 'v', return a []byte 'envelope'. Return an error if packing the envelope fails. NOTE: 'v' is the network message payload in unserialized form. NOTE: 'code' is the message type. NOTE: 'what' is the 'code' name for debugging / instrumentation. NOTE: 'envelope' contains 'code' & serialized / encoded 'v'. i.e. 1st byte is 'code' and remaining bytes are CBOR encoded 'v'.

func (*Codec) NewDecoder

func (c *Codec) NewDecoder(r io.Reader) network.Decoder

NewDecoder creates a new CBOR decoder with the given underlying reader.

func (*Codec) NewEncoder

func (c *Codec) NewEncoder(w io.Writer) network.Encoder

NewEncoder creates a new CBOR encoder with the given underlying writer.

type Decoder

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

Decoder implements a stream decoder for CBOR.

func (*Decoder) Decode

func (d *Decoder) Decode() (interface{}, error)

Decode will decode the next CBOR value from the stream. Expected error returns during normal operations:

• codec.ErrInvalidEncoding if message encoding is invalid.
• codec.ErrUnknownMsgCode if message code byte does not match any of the configured message codes.
• codec.ErrMsgUnmarshal if the codec fails to unmarshal the data to the message type denoted by the message code.

type Encoder

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

Encoder is an encoder to write serialized CBOR to a writer.

func (*Encoder) Encode

func (e *Encoder) Encode(v interface{}) error

Encode will convert the given message into CBOR and write it to the underlying encoder, followed by a new line.