zstd

Documentation

Overview

Package zstd provides utilities for connecting to external zStandard compression tasks.

Index

• func NewReader(filename string) io.ReadCloser
• func NewWriter(filename string) (io.WriteCloser, error)

Functions

func NewReader

func NewReader(filename string) io.ReadCloser

NewReader creates a reader piped to external zstd process reading from file. This function is only expected to be used for tests, so all errors are fatal.

Users of this function should read from the returned pipe and close it when done. TODO return errors

func NewWriter

func NewWriter(filename string) (io.WriteCloser, error)

NewWriter creates a writer piped to an external zstd process writing to filename. It returns a WriteCloser that pipes all writes through a zstd compression process. Upon Close(), the returned WriteCloser will wait for the zstd process to finish writing to disk.