compress

Documentation

Overview

Package compress provides the generic APIs implemented by parquet compression codecs.

https://github.com/apache/parquet-format/blob/master/Compression.md

Index

• type Codec
• type Compressor
  • func (c *Compressor) Encode(dst, src []byte, newWriter func(io.Writer) (Writer, error)) ([]byte, error)
• type Decompressor
  • func (d *Decompressor) Decode(dst, src []byte, newReader func(io.Reader) (Reader, error)) ([]byte, error)
• type Reader
• type Writer

Types

type Codec

type Codec interface {
	// Returns a human-readable name for the codec.
	String() string

	// Returns the code of the compression codec in the parquet format.
	CompressionCodec() format.CompressionCodec

	// Writes the compressed version of src to dst and returns it.
	//
	// The method automatically reallocates the output buffer if its capacity
	// was too small to hold the compressed data.
	Encode(dst, src []byte) ([]byte, error)

	// Writes the uncompressed version of src to dst and returns it.
	//
	// The method automatically reallocates the output buffer if its capacity
	// was too small to hold the uncompressed data.
	Decode(dst, src []byte) ([]byte, error)
}

The Codec interface represents parquet compression codecs implemented by the compress sub-packages.

Codec instances must be safe to use concurrently from multiple goroutines.

type Compressor

type Compressor struct {
	// contains filtered or unexported fields
}

func (*Compressor) Encode

func (c *Compressor) Encode(dst, src []byte, newWriter func(io.Writer) (Writer, error)) ([]byte, error)

type Decompressor

type Decompressor struct {
	// contains filtered or unexported fields
}

func (*Decompressor) Decode

func (d *Decompressor) Decode(dst, src []byte, newReader func(io.Reader) (Reader, error)) ([]byte, error)

type Reader

type Reader interface {
	io.ReadCloser
	Reset(io.Reader) error
}

type Writer

type Writer interface {
	io.WriteCloser
	Reset(io.Writer)
}