compress

Documentation

Index

• Variables
• type Compressor
• type Map
  • func NewMap(params MapParams) *Map
  • func (f *Map) Get(kind string) Compressor
  • func (f *Map) Register(kind string, c Compressor)
• type MapParams

Variables

var Module = fx.Options(
	fx.Provide(snappy.NewCompressor),
	fx.Provide(s2.NewCompressor),
	fx.Provide(zstd.NewCompressor),
	fx.Provide(none.NewCompressor),
	fx.Provide(NewMap),
)

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 Map

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

Map of compressor.

func NewMap

func NewMap(params MapParams) *Map

NewMap for compressor.

func (*Map) Get

func (f *Map) Get(kind string) Compressor

Get from kind.

func (*Map) Register

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

Register kind and compressor.

type MapParams

type MapParams struct {
	fx.In

	Zstd   *zstd.Compressor
	S2     *s2.Compressor
	Snappy *snappy.Compressor
	None   *none.Compressor
}

MapParams for compressor.