compression

Documentation

Overview

Package compression manages compression algorithm implementations.

Index

• Variables
• func DecompressByHeader(output io.Writer, input io.Reader) error
• func RegisterCompressor(name Name, c Compressor)
• func RegisterDeprecatedCompressor(name Name, c Compressor)
• type Compressor
• type HeaderID
• type Name

Variables

var (
	ByHeaderID     = map[HeaderID]Compressor{}
	ByName         = map[Name]Compressor{}
	HeaderIDToName = map[HeaderID]Name{}
	IsDeprecated   = map[Name]bool{}
)

maps of registered compressors by header ID and name.

Functions

func DecompressByHeader

func DecompressByHeader(output io.Writer, input io.Reader) error

DecompressByHeader decodes compression header from the provided input and decompresses the remainder.

func RegisterCompressor

func RegisterCompressor(name Name, c Compressor)

RegisterCompressor registers the provided compressor implementation.

func RegisterDeprecatedCompressor

func RegisterDeprecatedCompressor(name Name, c Compressor)

RegisterDeprecatedCompressor registers the provided compressor implementation.

Types

type Compressor

type Compressor interface {
	HeaderID() HeaderID
	Compress(output io.Writer, input io.Reader) error
	Decompress(output io.Writer, input io.Reader, withHeader bool) error
}

Compressor implements compression and decompression of a byte slice.

type HeaderID

type HeaderID uint32

HeaderID is a unique identifier of the compressor stored in the compressed block header.

const (
	HeaderZstdDefault           HeaderID = 0x1100
	HeaderZstdFastest           HeaderID = 0x1101
	HeaderZstdBetterCompression HeaderID = 0x1102
	HeaderZstdBestCompression   HeaderID = 0x1103
)

defined header IDs.

type Name

type Name string

Name is the name of the compressor to use.