BSD-3-Clause licensed by Bryan O'Sullivan
Maintained by luis@luispedro.org

Module documentation for 0.1.2.0

This version can be pinned in stack with:zstd-0.1.2.0@sha256:2ded2a168b4fa47489dd9e4b970eb4a7f9f13a29bc163f7ab5c3aa2070827978,3723

Zstandard bindings for Haskell

Travis

This library provides Haskell bindings to the Zstandard compression library.

Note that is now the official repositoryc for the zstd Haskell package. The original authors (Facebook) are no longer interested in maintaining it.

The library is structured to provide several layers of abstraction.

  • For the simplest use cases, the top-level Zstd module is the best place to get started.

  • If you need to stream a large amount of data with a constant memory footprint, use the Zstd.Streaming module. See also the conduit-zstd package which provides a very thin wrapper to integrate with the conduit library. If you need to use lazy bytestrings instead, see the Zstd.Lazy module. This is built using the abstractions from the Zstd.Streaming module.

  • When your usage is dominated by lots of small messages (presumably using pre-computed compression dictionaries), use the Zstd.Efficient module to amortize the cost of allocating and initializing context and dictionary values.

Join in

If you’d like to help improve the code, please read the contribution guidelines. This discusses how to file bugs and submit changes to the code itself.

API documentation

The APIs should be easy to understand and work with, and you can find documentation on Hackage.

Used by 1 package in nightly-2020-09-16(full list with versions):