The zstd package

[ Tags: benchmark, bsd3, codec, library ] [ Propose Tags ]

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


[Skip to Readme]

Properties

Versions 0.1.0.0
Change log changelog.md
Dependencies base (>=4.8 && <5), bytestring (>=0.9), deepseq, ghc-prim [details]
License BSD3
Copyright (c) 2016-present, Facebook, Inc. All rights reserved.
Author Bryan O'Sullivan
Maintainer bryano@fb.com
Category Codec
Home page https://github.com/facebookexperimental/hs-zstd
Bug tracker https://github.com/facebookexperimental/hs-zstd/issues
Source repository head: git clone https://github.com/facebookexperimental//hs-zstd
Uploaded Tue Feb 7 18:32:08 UTC 2017 by BryanOSullivan
Distributions NixOS:0.1.0.0
Downloads 69 total (2 in the last 30 days)
Rating 0.0 (0 ratings) [clear rating]
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-02-07 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
standalone

Use a built-in copy of the zstd library

EnabledAutomatic

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

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for zstd-0.1.0.0

[back to package description]

Zstandard bindings for Haskell

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.