Streaming.Zip

This module modifies material in Renzo Carbonara's pipes-zlib package.

Streams

decompress

Arguments

:: MonadIO m

=> WindowBits

-> ByteString m r

Compressed stream

-> ByteString m r

Decompressed stream

Decompress a streaming bytestring. WindowBits is from Codec.Compression.Zlib

decompress defaultWindowBits :: MonadIO m => ByteString m r -> ByteString m r

decompress'

Arguments

:: MonadIO m

=> WindowBits

-> ByteString m r

Compressed byte stream

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

Decompressed byte stream, ending with either leftovers or a result

Decompress a zipped byte stream, returning any leftover input that follows the compressed material.

compress

Arguments

:: MonadIO m

=> CompressionLevel

-> WindowBits

-> ByteString m r

Decompressed stream

-> ByteString m r

Compressed stream

Compress a byte stream.

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

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

gunzip

Arguments

:: MonadIO m

=> ByteString m r

Compressed stream

-> ByteString m r

Decompressed stream

Decompress a gzipped byte stream.

gunzip :: MonadIO m
           => ByteString m r
           -> ByteString m r

gunzip'

Arguments

:: MonadIO m

=> ByteString m r

Compressed byte stream

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

Decompressed bytes stream, returning either a ByteString of the leftover input or the return value from the input ByteString.

Decompress a gzipped byte stream, returning any leftover input that follows the compressed stream.

gzip

Arguments

:: MonadIO m

=> CompressionLevel

-> ByteString m r

Decompressed stream

-> ByteString m r

Compressed stream

Compress a byte stream in the gzip format.

gzip :: MonadIO m
         => CompressionLevel
         -> ByteString m r
         -> 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