HORIZON HASKELLDocslts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulezlib-0.7.1.0Haskell2010

Codec.Compression.Zlib.Raw

Compression and decompression of data streams in the raw deflate format.

The format is described in detail in RFC #1951: http://www.ietf.org/rfc/rfc1951.txt

See also the zlib home page: http://zlib.net/

  • 8 types
  • 23 values
  • Packagezlib-0.7.1.0
  • Exports31
  • LanguageHaskell2010
  • LicenceBSD-3-Clause
  • SourceRaw.hs

Simple compression and decompression

3 declarations
datadata DecompressError
#

The possible error cases when decompressing a stream.

This can be shown to give a human readable error message.

Constructors

  • TruncatedInput

    The compressed data stream ended prematurely. This may happen if the input data stream was truncated.

  • DictionaryRequired

    It is possible to do zlib compression with a custom dictionary. This allows slightly higher compression ratios for short files. However such compressed streams require the same dictionary when decompressing. This error is for when we encounter a compressed stream that needs a dictionary, and it's not provided.

  • DictionaryMismatch

    If the stream requires a dictionary and you provide one with the wrong DictionaryHash then you will get this error.

  • DataFormatError String

    If the compressed data stream is corrupted in any way then you will get this error, for example if the input data just isn't a compressed zlib data stream. In particular if the data checksum turns out to be wrong then you will get all the decompressed data but this error at the end, instead of the normal successful StreamEnd.

Instances6Eq, Ord, Show, Generic, Exception, Rep

Extended API with control over compression parameters

6 declarations
datadata CompressParams
#

The full set of parameters for compression. The defaults are defaultCompressParams.

The compressBufferSize is the size of the first output buffer containing the compressed data. If you know an approximate upper bound on the size of the compressed data then setting this parameter can save memory. The default compression output buffer size is 16k. If your estimate is wrong it does not matter too much, the default buffer size will be used for the remaining chunks.

Instances5Eq, Ord, Show, Generic, Rep
datadata DecompressParams
#

The full set of parameters for decompression. The defaults are defaultDecompressParams.

The decompressBufferSize is the size of the first output buffer, containing the uncompressed data. If you know an exact or approximate upper bound on the size of the decompressed data then setting this parameter can save memory. The default decompression output buffer size is 32k. If your estimate is wrong it does not matter too much, the default buffer size will be used for the remaining chunks.

One particular use case for setting the decompressBufferSize is if you know the exact size of the decompressed data and want to produce a strict ByteString. The compression and decompression functions use lazy ByteStrings but if you set the decompressBufferSize correctly then you can generate a lazy ByteString with exactly one chunk, which can be converted to a strict ByteString in O(1) time using concat . toChunks.

Instances5Eq, Ord, Show, Generic, Rep

The compression parameter types

newtypenewtype CompressionLevel
#

The compression level parameter controls the amount of compression. This is a trade-off between the amount of compression and the time required to do the compression.

Constructors

Instances5Eq, Ord, Show, Generic, Rep
datadata Method
#

The compression method

Instances7Bounded, Enum, Eq, Ord, Show, Generic, …
  • Bounded MethodDefined in zlib-0.7.1.0 · Codec.Compression.Zlib.Stream
  • Enum MethodDefined in zlib-0.7.1.0 · Codec.Compression.Zlib.Stream
  • Eq MethodDefined in zlib-0.7.1.0 · Codec.Compression.Zlib.Stream
  • Ord MethodDefined in zlib-0.7.1.0 · Codec.Compression.Zlib.Stream
  • Show MethodDefined in zlib-0.7.1.0 · Codec.Compression.Zlib.Stream
  • Generic MethodDefined in zlib-0.7.1.0 · Codec.Compression.Zlib.Stream
  • type Rep Method = D1 ('MetaData "Method" "Codec.Compression.Zlib.Stream" "zlib-0.7.1.0-FdzQBN8c1mMLTBR17egTes" 'False) (C1 ('MetaCons "Deflated" 'PrefixI 'False) U1)Defined in zlib-0.7.1.0 · Codec.Compression.Zlib.Stream
valuedeflateMethod :: Method
#

The only method supported in this version of zlib. Indeed it is likely to be the only method that ever will be supported.

newtypenewtype WindowBits
#

This specifies the size of the compression window. Larger values of this parameter result in better compression at the expense of higher memory usage.

The compression window size is the value of the the window bits raised to the power 2. The window bits must be in the range 9..15 which corresponds to compression window sizes of 512b to 32Kb. The default is 15 which is also the maximum size.

The total amount of memory used depends on the window bits and the MemoryLevel. See the MemoryLevel for the details.

Constructors

Instances5Eq, Ord, Show, Generic, Rep
valuewindowBits :: Int -> WindowBits
#

A specific compression window size, specified in bits in the range 9..15. Throws an error for arguments outside of this range.

newtypenewtype MemoryLevel
#

The MemoryLevel parameter specifies how much memory should be allocated for the internal compression state. It is a trade-off between memory usage, compression ratio and compression speed. Using more memory allows faster compression and a better compression ratio.

The total amount of memory used for compression depends on the WindowBits and the MemoryLevel. For decompression it depends only on the WindowBits. The totals are given by the functions:

compressTotal windowBits memLevel = 4 * 2^windowBits + 512 * 2^memLevel
decompressTotal windowBits = 2^windowBits

For example, for compression with the default windowBits = 15 and memLevel = 8 uses 256Kb. So for example a network server with 100 concurrent compressed streams would use 25Mb. The memory per stream can be halved (at the cost of somewhat degraded and slower compression) by reducing the windowBits and memLevel by one.

Decompression takes less memory, the default windowBits = 15 corresponds to just 32Kb.

Constructors

Instances5Eq, Ord, Show, Generic, Rep
valuememoryLevel :: Int -> MemoryLevel
#

A specific memory level in the range 1..9. Throws an error for arguments outside of this range.

datadata CompressionStrategy
#

The strategy parameter is used to tune the compression algorithm.

The strategy parameter only affects the compression ratio but not the correctness of the compressed output even if it is not set appropriately.

Instances7Bounded, Enum, Eq, Ord, Show, Generic, …

Use the filtered compression strategy for data produced by a filter (or predictor). Filtered data consists mostly of small values with a somewhat random distribution. In this case, the compression algorithm is tuned to compress them better. The effect of this strategy is to force more Huffman coding and less string matching; it is somewhat intermediate between defaultStrategy and huffmanOnlyStrategy.