zstd-0.1.1.2: Haskell bindings to the Zstandard compression algorithm

Copyright(c) 2016-present Facebook Inc. All rights reserved.
LicenseBSD3
Maintainerbryano@fb.com
Stabilityexperimental
PortabilityGHC
Safe HaskellNone
LanguageHaskell2010

Codec.Compression.Zstd.Lazy

Description

Lazy compression and decompression support for zstd. Under the hood, these are implemented using the streaming APIs.

Synopsis

Documentation

compress Source #

Arguments

:: Int

Compression level. Must be >= 1 and <= maxCLevel.

-> ByteString

Payload to compress. This will be consumed lazily.

-> ByteString 

Compress a payload. The input will be consumed lazily, and the compressed result generated lazily.

Note: if any error occurs, compression will fail part-way through with a call to error.

decompress :: ByteString -> ByteString Source #

Decompress a payload. The input will be consumed lazily, and the decompressed result generated lazily.

Note: if any error occurs, decompression will fail part-way through with a call to error.

maxCLevel :: Int Source #

The maximum compression level supported by the library.