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.Internal

Pure and IO stream based interfaces to lower level zlib wrapper

  • 11 types
  • 33 values
  • Packagezlib-0.7.1.0
  • Exports44
  • LanguageHaskell2010
  • LicenceBSD-3-Clause
  • SourceInternal.hs

Pure interface

2 declarations
valuecompress :: Format -> CompressParams -> ByteString -> ByteString
#

Compress a data stream provided as a lazy ByteString.

There are no expected error conditions. All input data streams are valid. It is possible for unexpected errors to occur, such as running out of memory, or finding the wrong version of the zlib C library, these are thrown as exceptions.

Monadic incremental interface

0 declarations

The pure compress and decompress functions are streaming in the sense that they can produce output without demanding all input, however they need the input data stream as a lazy ByteString. Having the input data stream as a lazy ByteString often requires using lazy I/O which is not appropriate in all circumstances.

For these cases an incremental interface is more appropriate. This interface allows both incremental input and output. Chunks of input data are supplied one by one (e.g. as they are obtained from an input source like a file or network source). Output is also produced chunk by chunk.

The incremental input and output is managed via the CompressStream and DecompressStream types. They represents the unfolding of the process of compressing and decompressing. They operates in either the ST or IO monads. They can be lifted into other incremental abstractions like pipes or conduits, or they can be used directly in the following style.

Using incremental compression

In a loop:

  • Inspect the status of the stream

  • When it is CompressInputRequired then you should call the action, passing a chunk of input (or BS.empty when no more input is available) to get the next state of the stream and continue the loop.

  • When it is CompressOutputAvailable then do something with the given chunk of output, and call the action to get the next state of the stream and continue the loop.

  • When it is CompressStreamEnd then terminate the loop.

Note that you cannot stop as soon as you have no more input, you need to carry on until all the output has been collected, i.e. until you get to CompressStreamEnd.

Here is an example where we get input from one file handle and send the compressed output to another file handle.

go :: Handle -> Handle -> CompressStream IO -> IO ()
go inh outh (CompressInputRequired next) = do
   inchunk <- BS.hGet inh 4096
   go inh outh =<< next inchunk
go inh outh (CompressOutputAvailable outchunk next) =
   BS.hPut outh outchunk
   go inh outh =<< next
go _ _ CompressStreamEnd = return ()

The same can be achieved with foldCompressStream:

foldCompressStream
  (\next -> do inchunk <- BS.hGet inh 4096; next inchunk)
  (\outchunk next -> do BS.hPut outh outchunk; next)
  (return ())
datadata CompressStream (m :: Type -> Type)
#

The unfolding of the compression process, where you provide a sequence of uncompressed data chunks as input and receive a sequence of compressed data chunks as output. The process is incremental, in that the demand for input and provision of output are interleaved.

Constructors

Using incremental decompression

The use of DecompressStream is very similar to CompressStream but with a few differences:

Otherwise the same loop style applies, and there are fold functions.

datadata DecompressStream (m :: Type -> Type)
#

The unfolding of the decompression process, where you provide a sequence of compressed data chunks as input and receive a sequence of uncompressed data chunks as output. The process is incremental, in that the demand for input and provision of output are interleaved.

To indicate the end of the input supply an empty input chunk. Note that for gzipFormat with the default decompressAllMembers True you will have to do this, as the decompressor will look for any following members. With decompressAllMembers False the decompressor knows when the data ends and will produce DecompressStreamEnd without you having to supply an empty chunk to indicate the end of the input.

Constructors

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

The compression parameter types

31 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.

Constructors

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.

Constructors

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

The format used for compression or decompression. There are three variations.

Instances7Bounded, Enum, Eq, Ord, Show, Generic, …
valuegzipFormat :: Format
#

The gzip format uses a header with a checksum and some optional meta-data about the compressed file. It is intended primarily for compressing individual files but is also sometimes used for network protocols such as HTTP. The format is described in detail in RFC #1952 http://www.ietf.org/rfc/rfc1952.txt

valuegzipOrZlibFormat :: Format
#

This is not a format as such. It enabled zlib or gzip decoding with automatic header detection. This only makes sense for decompression.

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, …
valuefilteredStrategy :: CompressionStrategy
#

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.