zbor

Documentation

Index

• type Codec
  • func NewCodec() *Codec
  • func (c *Codec) Compress(data []byte) ([]byte, error)
  • func (c *Codec) Decode(data []byte, value interface{}) error
  • func (c *Codec) Decompress(compressed []byte) ([]byte, error)
  • func (c *Codec) Encode(value interface{}) ([]byte, error)
  • func (c *Codec) Marshal(value interface{}) ([]byte, error)
  • func (c *Codec) Unmarshal(compressed []byte, value interface{}) error

Types

type Codec

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

Codec encodes and decodes Go values using cbor encoding and zstandard compression.

func NewCodec

func NewCodec() *Codec

NewCodec creates a new Codec.

func (*Codec) Compress

func (c *Codec) Compress(data []byte) ([]byte, error)

Compress encodes the given bytes into a compressed format using zstandard.

func (*Codec) Decode

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

Decode parses CBOR-encoded data into the given value.

func (*Codec) Decompress

func (c *Codec) Decompress(compressed []byte) ([]byte, error)

Decompress reads compressed data that uses the zstandard format and returns the original uncompressed byte slice.

func (*Codec) Encode

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

Encode returns the CBOR encoding of the given value.

func (*Codec) Marshal

func (c *Codec) Marshal(value interface{}) ([]byte, error)

Marshal encodes the given value and then compresses it, and returns the resulting slice of bytes.

func (*Codec) Unmarshal

func (c *Codec) Unmarshal(compressed []byte, value interface{}) error

Unmarshal decompresses the given bytes and decodes the resulting CBOR-encoded data into the given value.