compression

Documentation

Index

• Variables
• type Compressor
  • func NewGzipCompressor(maxSize int64) (Compressor, error)
  • func NewNoCompressor() Compressor
  • func NewZstdCompressor(maxSize int64) (Compressor, error)
• type Type
  • func TypeFromString(s string) (Type, error)
  • func (t Type) MarshalJSON() ([]byte, error)
  • func (t Type) String() string

Variables

var (
	ErrInvalidMaxSizeCompressor = errors.New("invalid gzip compressor max size")
	ErrDecompressedMsgTooLarge  = errors.New("decompressed msg too large")
	ErrMsgTooLarge              = errors.New("msg too large to be compressed")
)

Types

type Compressor

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

Compressor compresss and decompresses messages. Decompress is the inverse of Compress. Decompress(Compress(msg)) == msg.

func NewGzipCompressor

func NewGzipCompressor(maxSize int64) (Compressor, error)

NewGzipCompressor returns a new gzip Compressor that compresses

func NewNoCompressor

func NewNoCompressor() Compressor

NewNoCompressor returns a Compressor that does nothing

func NewZstdCompressor

func NewZstdCompressor(maxSize int64) (Compressor, error)

type Type

type Type byte

const (
	TypeNone Type = iota + 1
	TypeGzip      // Remove once v1.11.x is out.
	TypeZstd
)

func TypeFromString

func TypeFromString(s string) (Type, error)

func (Type) MarshalJSON

func (t Type) MarshalJSON() ([]byte, error)

func (Type) String

func (t Type) String() string