compress

Documentation

Overview

Package compress is responsible for compression data.

Index

• Constants
• func Compress(data []byte) ([]byte, error)
• func Init(conf *Config) error
• type Compression
  • func New(conf *Config) (Compression, error)
• type Config
• type Format

Constants

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

Format is the format of compression that happens.

Functions

func Compress

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

Compress will compress any given array of bytes.

func Init

func Init(conf *Config) error

Init will initialise global compression instance.

Types

type Compression

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

Compression will compress any given array of bytes.

func New

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

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

type Config

type Config struct {
	Format Format
	Level  int
}

Config holds configurations need for creating a new Compress instance.

type Format

type Format string

Format is the format of compression that happens.