compression

Documentation

Index

• type Algorithm
• type Option
  • func WithAlgorithm(alg Algorithm) Option
  • func WithDefaultAlgorithms() Option
• type Registry
  • func New(opts ...Option) *Registry
  • func (r *Registry) Close() error
  • func (r *Registry) Compress(alg string, data []byte) ([]byte, error)
  • func (r *Registry) Decompress(alg string, data []byte) ([]byte, error)

Types

type Algorithm

type Algorithm interface {
	Compress(value []byte) ([]byte, error)
	Decompress(value []byte) ([]byte, error)
	Accept(alg string) bool
	Close() error
}

Algorithm defines compression/decompression algorithm functionality.

type Option

type Option func(opts *Registry)

Option is a registry instance option.

func WithAlgorithm

func WithAlgorithm(alg Algorithm) Option

WithAlgorithm adds compression algorithm to the list of available algorithms.

func WithDefaultAlgorithms

func WithDefaultAlgorithms() Option

WithDefaultAlgorithms adds default compression algorithms to the list of available algorithms.

type Registry

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

Registry contains compression algorithms.

func New

func New(opts ...Option) *Registry

New return new instance of compression algorithm registry.

func (*Registry) Close

func (r *Registry) Close() error

Close frees resources being maintained by compression algorithm.

func (*Registry) Compress

func (r *Registry) Compress(alg string, data []byte) ([]byte, error)

Compress data using specified algorithm.

func (*Registry) Decompress

func (r *Registry) Decompress(alg string, data []byte) ([]byte, error)

Decompress will decompress compressed data using specified algorithm.