compression

package

v0.0.0-...-e2e6556 Latest Latest Go to latest Published: Apr 21, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	GZIP_TYPE    = "gzip"
	ZLIB_TYPE    = "zlib"
	DEFLATE_TYPE = "deflate"
	SNAPPY_TYPE  = "snappy"
	ZSTD_TYPE    = "zstd"
)

View Source

var (
	ErrUnknownCompressionType = errors.New("unknown-compression-type")
)

func NewReader(compressionType string, reader io.Reader) (io.Reader, error)

func NewWriter(compressionType string, writer io.Writer) (io.WriteCloser, error)

type Compressor[I, O []byte] struct {
	// contains filtered or unexported fields
}

Compressor is a generic task capable of compress a []byte into zstd or gzip.

func NewCompressor[T, K []byte](compressionType string, logger *slog.Logger) *Compressor[T, K]

Creates a new Compressor task.

func (d *Compressor[I, O]) Run(_ context.Context, input I, meta map[string]interface{}, _ string) (O, error)

Run receives output from previous worker, calls adaptFn and compress it into selected format.

type Decompressor[T, K []byte] struct {
	// contains filtered or unexported fields
}

Decompressor is a generic task capable of decompress []byte compressed with ZSTD or GZIP

func NewDecompressor[I, O []byte](compressionType string, logger *slog.Logger) *Decompressor[I, O]

func (d *Decompressor[I, O]) Run(_ context.Context, input I, meta map[string]interface{}, _ string) (O, error)

The return data from Run will be []byte decompressed