compression

Documentation

Overview

Package compression manages compression algorithm implementations.

Index

• Variables
• func RegisterCompressor(name Name, c Compressor)
• type Compressor
• type HeaderID
  • func IDFromHeader(b []byte) (HeaderID, error)
• type Name

Variables

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

maps of registered compressors by header ID and name.

Functions

func RegisterCompressor

func RegisterCompressor(name Name, c Compressor)

RegisterCompressor registers the provided compressor implementation

Types

type Compressor

type Compressor interface {
	HeaderID() HeaderID
	Compress(output *bytes.Buffer, input []byte) error
	Decompress(output *bytes.Buffer, input []byte) 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.

func IDFromHeader

func IDFromHeader(b []byte) (HeaderID, error)

IDFromHeader retrieves compression ID from content header

type Name

type Name string

Name is the name of the compressor to use.