hs-zstd: Haskell bindings to the Zstandard compression algorithm

[ bsd3, codec, deprecated, library ] [ Propose Tags ]
Deprecated in favor of zstd

A fast lossless compression algorithm, targeting real-time compression scenarios at zlib-level and better compression ratios.


[Skip to Readme]

Flags

Automatic Flags
NameDescriptionDefault
standalone

Use a built-in copy of the zstd library

Enabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1.1.0, 0.1.1.1
Change log changelog.md
Dependencies base (>=4.8 && <5), bytestring (>=0.9), deepseq, ghc-prim [details]
License BSD-3-Clause
Copyright (c) 2016-present, Facebook, Inc. All rights reserved.; 2019 Luis Pedro Coelho
Author Bryan O'Sullivan
Maintainer luis@luispedro.org
Category Codec
Home page https://github.com/facebookexperimental/hs-zstd
Bug tracker https://github.com/facebookexperimental/hs-zstd/issues
Source repo head: git clone https://github.com/luispedro/hs-zstd
Uploaded by luispedro at 2019-05-18T10:53:32Z
Distributions NixOS:0.1.1.1
Downloads 1041 total (7 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2019-05-18 [all 1 reports]

Readme for hs-zstd-0.1.1.1

[back to package description]

Zstandard bindings for Haskell

Travis

This is a fork of the original Facebook project which is unmaintained and produces incorrectly compressed files. This repository fixes these. If the original maintainers want to take the project back, I am happy to delete this one.

This library provides Haskell bindings to the Zstandard compression library.

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. This can also be used as a building block for adapting to streaming libraries such as pipes and conduit. (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.