zbor

package

v1.4.8 Latest Latest Go to latest Published: Oct 28, 2021 License: Apache-2.0 Imports: 5 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

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

func NewCodec() *Codec

NewCodec creates a new Codec.

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

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

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

Decode parses CBOR-encoded data into the given value.

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 (c *Codec) Encode(value interface{}) ([]byte, error)

Encode returns the CBOR encoding of the given value.

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 (c *Codec) Unmarshal(compressed []byte, value interface{}) error

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