zstd

package

v1.136.0 Latest Latest Go to latest Published: Feb 13, 2026 License: Apache-2.0 Imports: 3 Imported by: 13

Documentation ¶

This section is empty.

This section is empty.

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

Decompress appends decompressed src to dst and returns the result.

This function must be called only for the trusted src. Otherwise use DecompressLimited function.

func DecompressLimited(dst, src []byte, maxDataSizeBytes int) ([]byte, error)

Decompress appends decompressed src to dst and returns the result.

If the decompressed result exceeds maxDataSizeBytes, then error is returned.

func PutReader(zr *Reader)

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

func PutWriter(zw *Writer)

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

type Reader = gozstd.Reader

Reader is zstd reader

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(r io.Reader) *Reader

NewReader returns zstd reader for the given r.

type Writer = gozstd.Writer

Writer is zstd writer

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(w io.Writer, level int) *Writer

NewWriterLevel returns zstd writer for the given w and level.