zstd

Documentation

Overview

Package zstd provides helper functions for interacting with zstd streams.

Index

• Variables
• func Is(r io.Reader) (bool, error)
• func ReadCloser(r io.ReadCloser) io.ReadCloser
• func ReadCloserLevel(r io.ReadCloser, level int) io.ReadCloser
• func UnzipReadCloser(r io.ReadCloser) (io.ReadCloser, error)

Variables

var MagicHeader = []byte{'\x28', '\xb5', '\x2f', '\xfd'}

MagicHeader is the start of zstd files.

Functions

func Is

func Is(r io.Reader) (bool, error)

Is detects whether the input stream is compressed.

func ReadCloser

func ReadCloser(r io.ReadCloser) io.ReadCloser

ReadCloser reads uncompressed input data from the io.ReadCloser and returns an io.ReadCloser from which compressed data may be read. This uses zstd level 1 for the compression.

func ReadCloserLevel

func ReadCloserLevel(r io.ReadCloser, level int) io.ReadCloser

ReadCloserLevel reads uncompressed input data from the io.ReadCloser and returns an io.ReadCloser from which compressed data may be read.

func UnzipReadCloser

func UnzipReadCloser(r io.ReadCloser) (io.ReadCloser, error)

UnzipReadCloser reads compressed input data from the io.ReadCloser and returns an io.ReadCloser from which uncompressed data may be read.