Safe Haskell	None
Language	Haskell2010

Streaming.Zip

Contents

Streams
Compression levels
Window size

Description

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

Synopsis

decompress :: MonadIO m => WindowBits -> ByteString m r -> ByteString m r
decompress' :: MonadIO m => WindowBits -> ByteString m r -> ByteString m (Either (ByteString m r) r)
compress :: MonadIO m => CompressionLevel -> WindowBits -> ByteString m r -> ByteString m r
gunzip :: MonadIO m => ByteString m r -> ByteString m r
gunzip' :: MonadIO m => ByteString m r -> ByteString m (Either (ByteString m r) r)
gzip :: MonadIO m => CompressionLevel -> ByteString m r -> ByteString m r
data CompressionLevel
defaultCompression :: CompressionLevel
noCompression :: CompressionLevel
bestSpeed :: CompressionLevel
bestCompression :: CompressionLevel
compressionLevel :: Int -> CompressionLevel
defaultWindowBits :: WindowBits
windowBits :: Int -> WindowBits

Streams

decompress Source #

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' Source #

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 Source #

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.

gunzip Source #

Arguments

:: MonadIO m
=> ByteString m r	Compressed stream
-> ByteString m r	Decompressed stream

Decompress a gzipped byte stream.

gunzip' Source #

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 Source #

Arguments

:: MonadIO m
=> CompressionLevel
-> ByteString m r	Decompressed stream
-> ByteString m r	Compressed stream

Compress a byte stream in the gzip format.

Compression levels

data CompressionLevel Source #

How hard should we try to compress?

Instances

Eq CompressionLevel Source #
Instance details Defined in Streaming.Zip Methods (==) :: CompressionLevel -> CompressionLevel -> Bool # (/=) :: CompressionLevel -> CompressionLevel -> Bool #
Ord CompressionLevel Source #
Instance details Defined in Streaming.Zip 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 Source #
Instance details Defined in Streaming.Zip Methods readsPrec :: Int -> ReadS CompressionLevel # readList :: ReadS [CompressionLevel] # readPrec :: ReadPrec CompressionLevel # readListPrec :: ReadPrec [CompressionLevel] #
Show CompressionLevel Source #
Instance details Defined in Streaming.Zip Methods showsPrec :: Int -> CompressionLevel -> ShowS # show :: CompressionLevel -> String # showList :: [CompressionLevel] -> ShowS #

defaultCompression :: CompressionLevel Source #

noCompression :: CompressionLevel Source #

bestSpeed :: CompressionLevel Source #

bestCompression :: CompressionLevel Source #

compressionLevel :: Int -> CompressionLevel Source #

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 Source #