codecs

Documentation

Index

• type Compressor
  • func NewCodecWriter(w io.Writer, codec pb.CompressionCodec) (Compressor, error)
• type Decompressor
  • func NewCodecReader(r io.Reader, codec pb.CompressionCodec) (Decompressor, error)

Types

type Compressor

type Compressor io.WriteCloser

Compressor is a WriteCloser where Close closes and releases Compressor state, potentially flushing final content to the underlying Writer, but does not Close or otherwise affect the underlying Writer.

func NewCodecWriter

func NewCodecWriter(w io.Writer, codec pb.CompressionCodec) (Compressor, error)

NewCodecWriter returns a Compressor wrapping the Writer encoding with CompressionCodec.

type Decompressor

type Decompressor io.ReadCloser

Decompressor is a ReadCloser where Close closes and releases Decompressor state, but does not Close or affect the underlying Reader.

func NewCodecReader

func NewCodecReader(r io.Reader, codec pb.CompressionCodec) (Decompressor, error)

NewCodecReader returns a Decompressor of the Reader encoded with CompressionCodec.