compress

Documentation

Index

• Constants
• func NewCompressedContainer(container stow.Container, mode Mode) stow.Container
• type Mode
  • func ModeFromName(name string) Mode
  • func (m Mode) AlgoName() string
  • func (m Mode) NewReader(rdr io.Reader) (io.Reader, error)
  • func (m Mode) NewWriter(wtr io.WriteCloser) (io.WriteCloser, error)
  • func (m Mode) String() string

Constants

const (
	ModeIdentity Mode = iota
	ModeUnknown
	ModeS2
	ModeGzip

	ModeIdentityName = "identity"
	ModeS2Name       = "s2"
	ModeGzipName     = "gzip"
	ModeUknownName   = "unknown"
)

Enumerate available modes and their textual names

Functions

func NewCompressedContainer

func NewCompressedContainer(container stow.Container, mode Mode) stow.Container

NewCompressedContainer wraps the provided container in transparent compression and decompression

Types

type Mode

type Mode uint8

Mode represents a compression mode

func ModeFromName

func ModeFromName(name string) Mode

ModeFromName constructs a Mode from a textual name

func (Mode) AlgoName

func (m Mode) AlgoName() string

AlgoName returns the textual name of a Mode

func (Mode) NewReader

func (m Mode) NewReader(rdr io.Reader) (io.Reader, error)

NewReader constructs a reader wrapper that applies this mode's decompression

func (Mode) NewWriter

func (m Mode) NewWriter(wtr io.WriteCloser) (io.WriteCloser, error)

NewWriter constructs a writer wrapper that applies this mode's compression

func (Mode) String

func (m Mode) String() string

String is a synonym for AlgoName