hs-zstd: Haskell bindings to the Zstandard compression algorithm

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

'ghc-options: -O2' is rarely needed. Check that it is giving a real benefit and not just imposing longer compile times on your users.

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

[Skip to Readme]

Properties

Versions	0.1.1.0, 0.1.1.1, 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:49:49Z

Modules

[Index] [Quick Jump]

Codec
- Compression
  - Codec.Compression.Zstd

Flags

Automatic Flags

Name	Description	Default
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

hs-zstd-0.1.1.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

luispedro

For package maintainers and hackage trustees

edit package information

Readme for hs-zstd-0.1.1.1

[back to package description]

Zstandard bindings for Haskell

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.