package compress

Import Path
	github.com/parquet-go/parquet-go/compress (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 4 packages

Involved Source Files

	  d compress.go
		Package compress provides the generic APIs implemented by parquet compression
		codecs.
		
		https://github.com/apache/parquet-format/blob/master/Compression.md
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Codec (interface)
		The Codec interface represents parquet compression codecs implemented by the
		compress sub-packages.
		
		Codec instances must be safe to use concurrently from multiple goroutines.

		Methods (total 4)
			( Codec) CompressionCodec() format.CompressionCodec
				Returns the code of the compression codec in the parquet format.

			( Codec) Decode(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.

			( Codec) Encode(dst, src []byte) ([]byte, error)
				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.

			( Codec) String() string
				Returns a human-readable name for the codec.

		Implemented By (at least 6)
			*github.com/parquet-go/parquet-go/compress/brotli.Codec
			*github.com/parquet-go/parquet-go/compress/gzip.Codec
			*github.com/parquet-go/parquet-go/compress/lz4.Codec
			*github.com/parquet-go/parquet-go/compress/snappy.Codec
			*github.com/parquet-go/parquet-go/compress/uncompressed.Codec
			*github.com/parquet-go/parquet-go/compress/zstd.Codec
		Implements (at least 2)
			 Codec : expvar.Var
			 Codec : fmt.Stringer
		As Outputs Of (at least 6)
			func github.com/parquet-go/parquet-go.LookupCompressionCodec(codec format.CompressionCodec) Codec
			func github.com/parquet-go/parquet-go.(*Column).Compression() Codec
			func github.com/parquet-go/parquet-go.Field.Compression() Codec
			func github.com/parquet-go/parquet-go.Group.Compression() Codec
			func github.com/parquet-go/parquet-go.Node.Compression() Codec
			func github.com/parquet-go/parquet-go.(*Schema).Compression() Codec
		As Inputs Of (at least 2)
			func github.com/parquet-go/parquet-go.Compressed(node parquet.Node, codec Codec) parquet.Node
			func github.com/parquet-go/parquet-go.Compression(codec Codec) parquet.WriterOption

	 type Compressor (struct)

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

	 type Decompressor (struct)

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

	 type Reader (interface)

		Methods (total 3)
			( Reader) Close() error
			( Reader) Read(p []byte) (n int, err error)
			( Reader) Reset(io.Reader) error
		Implemented By (at least 2)
			*github.com/klauspost/compress/gzip.Reader
			*compress/gzip.Reader
		Implements (at least 4)
			 Reader : github.com/prometheus/common/expfmt.Closer
			 Reader : io.Closer
			 Reader : io.ReadCloser
			 Reader : io.Reader

	 type Writer (interface)

		Methods (total 3)
			( Writer) Close() error
			( Writer) Reset(io.Writer)
			( Writer) Write([]byte) (int, error)
		Implemented By (at least 12)
			*github.com/andybalholm/brotli.Writer
			*github.com/andybalholm/brotli/matchfinder.Writer
			*github.com/golang/snappy.Writer
			*github.com/klauspost/compress/flate.Writer
			*github.com/klauspost/compress/gzip.Writer
			*github.com/klauspost/compress/internal/snapref.Writer
			*github.com/klauspost/compress/s2.Writer
			*github.com/klauspost/compress/zstd.Encoder
			*github.com/pierrec/lz4/v4.Writer
			*compress/flate.Writer
			*compress/gzip.Writer
			*compress/zlib.Writer
		Implements (at least 6)
			 Writer : github.com/miekg/dns.Writer
			 Writer : github.com/prometheus/common/expfmt.Closer
			 Writer : internal/bisect.Writer
			 Writer : io.Closer
			 Writer : io.WriteCloser
			 Writer : io.Writer

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.