compress

package

v1.10.15 Latest Latest Go to latest Published: Jun 20, 2023 License: Apache-2.0 Imports: 3 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

Package compress is responsible for compression data.

View Source

const (
	FormatNoop = Format("noop")
	FormatGZip = Format("gzip")
	FormatZSTD = Format("zstd")
)

Format is the format of compression that happens.

This section is empty.

func Compress(data []byte) ([]byte, error)

Compress will compress any given array of bytes.

func Init(conf *Config) error

Init will initialise global compression instance.

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

Compression will compress any given array of bytes.

func New(conf *Config) (Compression, error)

New creates an instance of Compression. Based on the Format value, it creates corresponding instance.

type Config struct {
	Format Format
	Level  int
}

Config holds configurations need for creating a new Compress instance.

type Format string

Format is the format of compression that happens.

Path	Synopsis
gzip Package gzip is an implementation of Compression interface using gzip format.	Package gzip is an implementation of Compression interface using gzip format.
noop Package noop is an implementation of Compression interface that doesn't compress data.	Package noop is an implementation of Compression interface that doesn't compress data.
zstd Package zstd is an implementation of Compression interface using zstd format.	Package zstd is an implementation of Compression interface using zstd format.