zstd

Documentation

Index

• func CompressLevel(dst, src []byte, compressionLevel int) []byte
• func Decompress(dst, src []byte) ([]byte, error)
• func PutReader(zr *Reader)
• func PutWriter(zw *Writer)
• type Reader
  • func GetReader(r io.Reader) *Reader
  • func NewReader(r io.Reader) *Reader
• type Writer
  • func GetWriter(w io.Writer, compressLevel int) *Writer
  • func NewWriterLevel(w io.Writer, level int) *Writer

Functions

func CompressLevel

func CompressLevel(dst, src []byte, compressionLevel int) []byte

CompressLevel appends compressed src to dst and returns the result.

The given compressionLevel is used for the compression.

func Decompress

func Decompress(dst, src []byte) ([]byte, error)

Decompress appends decompressed src to dst and returns the result.

func PutReader

func PutReader(zr *Reader)

PutReader returns zr to the pool, so it could be reused via GetReader.

func PutWriter

func PutWriter(zw *Writer)

PutWriter returns zw to the pool, so it could be reused via GetWriter.

Types

type Reader

type Reader = gozstd.Reader

Reader is zstd reader

func GetReader

func GetReader(r io.Reader) *Reader

GetReader returns Reader for reading zstd-uncompressed data from r.

When the reader is no longer needed, return back it to the pool via PutReader().

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns zstd reader for the given r.

type Writer

type Writer = gozstd.Writer

Writer is zstd writer

func GetWriter

func GetWriter(w io.Writer, compressLevel int) *Writer

GetWriter returns Writer for writing zstd-compressed data to w.

When the writer is no longer needed, return back it to the pool via PutWriter.

func NewWriterLevel

func NewWriterLevel(w io.Writer, level int) *Writer

NewWriterLevel returns zstd writer for the given w and level.