compression

Documentation

Overview

Package compression provides a compression implementation based on the configuration or available build tags.

Index

• Constants
• type Component
• type StreamCompressor

Constants

const ZlibEncoding = "deflate"

ZlibEncoding is the content-encoding value for Zlib

const ZstdEncoding = "zstd"

ZstdEncoding is the content-encoding value for Zstd

Types

type Component

type Component interface {
	Compress(src []byte) ([]byte, error)
	Decompress(src []byte) ([]byte, error)
	CompressBound(sourceLen int) int
	ContentEncoding() string
	NewStreamCompressor(output *bytes.Buffer) StreamCompressor
}

Component is the component type.

type StreamCompressor

type StreamCompressor interface {
	io.WriteCloser
	Flush() error
}

StreamCompressor is the interface that zlib and zstd should implement