Pipes.Zlib

This module exports utilities to compress and decompress pipes streams using the zlib compression codec.

If you want to compress or decompress GZip streams, use the Pipes.GZip module instead.

Streams

decompress

Arguments

:: MonadIO m

=> WindowBits

-> Proxy x' x () ByteString m r

Compressed stream

-> Proxy x' x () ByteString m r

Decompressed stream

Decompress bytes flowing from a Producer.

See the Codec.Compression.Zlib module for details about WindowBits.

decompress :: MonadIO m
           => WindowBits
           => Producer ByteString m r
           -> Producer ByteString m r

decompress'

Arguments

:: MonadIO m

=> WindowBits

-> Producer ByteString m r

Compressed stream

-> Producer ByteString m (Either (Producer ByteString m r) r)

Decompressed stream, ending with either leftovers or a result

Decompress bytes flowing from a Producer, returning any leftover input that follows the compressed stream.

compress

Arguments

:: MonadIO m

=> CompressionLevel

-> WindowBits

-> Proxy x' x () ByteString m r

Decompressed stream

-> Proxy x' x () ByteString m r

Compressed stream

Compress bytes flowing from a Producer.

See the Codec.Compression.Zlib module for details about CompressionLevel and WindowBits.

compress :: MonadIO m
         => CompressionLevel
         -> WindowBits
         -> Producer ByteString m r
         -> Producer ByteString m r

Compression levels

data CompressionLevel

How hard should we try to compress?

Instances

Eq CompressionLevel

Methods

(==) :: CompressionLevel -> CompressionLevel -> Bool

(/=) :: CompressionLevel -> CompressionLevel -> Bool

Ord CompressionLevel

Methods

compare :: CompressionLevel -> CompressionLevel -> Ordering

(<) :: CompressionLevel -> CompressionLevel -> Bool

(<=) :: CompressionLevel -> CompressionLevel -> Bool

(>) :: CompressionLevel -> CompressionLevel -> Bool

(>=) :: CompressionLevel -> CompressionLevel -> Bool

max :: CompressionLevel -> CompressionLevel -> CompressionLevel

min :: CompressionLevel -> CompressionLevel -> CompressionLevel

Read CompressionLevel

Methods

readsPrec :: Int -> ReadS CompressionLevel

readList :: ReadS [CompressionLevel]

readPrec :: ReadPrec CompressionLevel

readListPrec :: ReadPrec [CompressionLevel]

Show CompressionLevel

Methods

showsPrec :: Int -> CompressionLevel -> ShowS

show :: CompressionLevel -> String

showList :: [CompressionLevel] -> ShowS

defaultCompression :: CompressionLevel

noCompression :: CompressionLevel

bestSpeed :: CompressionLevel

bestCompression :: CompressionLevel

compressionLevel :: Int -> CompressionLevel

A specific compression level between 0 and 9.

Window size

The following are re-exported from Codec.Compression.Zlib for your convenience.

defaultWindowBits :: WindowBits

The default WindowBits is 15 which is also the maximum size.

windowBits :: Int -> WindowBits