compressor

Documentation

Index

• Variables
• type Compressor
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) Create(kind string) (Compressor, error)
  • func (f *Factory) Register(kind string, c Compressor)
• type None
  • func NewNone() *None
  • func (c *None) Compress(data []byte) []byte
  • func (c *None) Decompress(data []byte) ([]byte, error)
• type S2
  • func NewS2() *S2
  • func (c *S2) Compress(data []byte) []byte
  • func (c *S2) Decompress(data []byte) ([]byte, error)
• type Snappy
  • func NewSnappy() *Snappy
  • func (c *Snappy) Compress(data []byte) []byte
  • func (c *Snappy) Decompress(data []byte) ([]byte, error)
• type Zstd
  • func NewZstd() *Zstd
  • func (c *Zstd) Compress(data []byte) []byte
  • func (c *Zstd) Decompress(data []byte) ([]byte, error)

Variables

var ErrInvalidKind = errors.New("invalid kind")

ErrInvalidKind for compressor.

var Module = fx.Options(
	fx.Provide(NewSnappy),
	fx.Provide(NewFactory),
)

Module for fx.

Types

type Compressor

type Compressor interface {
	// Compress data.
	Compress(data []byte) []byte

	// Decompress data.
	Decompress(data []byte) ([]byte, error)
}

Compressor allows to have different ways to compress/decompress.

type Factory

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

Factory of compressor.

func NewFactory

func NewFactory() *Factory

NewFactory for compressor.

func (*Factory) Create

func (f *Factory) Create(kind string) (Compressor, error)

Create from kind.

func (*Factory) Register

func (f *Factory) Register(kind string, c Compressor)

Register kind and compressor.

type None

type None struct{}

None for compressor.

func NewNone

func NewNone() *None

NewNone compressor.

func (*None) Compress

func (c *None) Compress(data []byte) []byte

func (*None) Decompress

func (c *None) Decompress(data []byte) ([]byte, error)

type S2

type S2 struct{}

S2 for compressor.

func NewS2

func NewS2() *S2

NewS2 compressor.

func (*S2) Compress

func (c *S2) Compress(data []byte) []byte

func (*S2) Decompress

func (c *S2) Decompress(data []byte) ([]byte, error)

type Snappy

type Snappy struct{}

Snappy for compressor.

func NewSnappy

func NewSnappy() *Snappy

NewSnappy compressor.

func (*Snappy) Compress

func (c *Snappy) Compress(data []byte) []byte

func (*Snappy) Decompress

func (c *Snappy) Decompress(data []byte) ([]byte, error)

type Zstd

type Zstd struct{}

Zstd for compressor.

func NewZstd

func NewZstd() *Zstd

NewZstd compressor.

func (*Zstd) Compress

func (c *Zstd) Compress(data []byte) []byte

func (*Zstd) Decompress

func (c *Zstd) Decompress(data []byte) ([]byte, error)