compression

Documentation

Overview

Package compression provides compression support for store.Marshaler.

Index

• type Compressor
  • func ZStd() Compressor
• type Marshaler
  • func NewMarshaler(m store.Marshaler, c Compressor, minSize int) *Marshaler
  • func (m *Marshaler) MarshalResource(r resource.Resource) ([]byte, error)
  • func (m *Marshaler) UnmarshalResource(b []byte) (resource.Resource, error)

Types

type Compressor

type Compressor interface {
	Compress(prefix, data []byte) ([]byte, error)
	Decompress(data []byte) ([]byte, error)
	ID() byte
}

Compressor defines interface for compression and decompression.

func ZStd

func ZStd() Compressor

ZStd returns zstd compressor.

type Marshaler

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

Marshaler compresses and decompresses data from the underlying marshaler.

Marshaler also handles case when the underlying data is not compressed.

The trick used is that `0x00` can't start a valid protobuf message, so we use `0x00` as a marker for compressed data.

func NewMarshaler

func NewMarshaler(m store.Marshaler, c Compressor, minSize int) *Marshaler

NewMarshaler creates new Marshaler.

func (*Marshaler) MarshalResource

func (m *Marshaler) MarshalResource(r resource.Resource) ([]byte, error)

MarshalResource implements Marshaler interface.

func (*Marshaler) UnmarshalResource

func (m *Marshaler) UnmarshalResource(b []byte) (resource.Resource, error)

UnmarshalResource implements Marshaler interface.