Data.Conduit.Zlib

Streaming compression and decompression using conduits.

Parts of this code were taken from zlib-enum and adapted for conduits.

Conduits

compress

Arguments

:: (MonadBase base m, PrimMonad base, MonadThrow m)

=> Int

Compression level

-> WindowBits

Zlib parameter (see the zlib-bindings package as well as the zlib C library)

-> Conduit ByteString m ByteString

Compress (deflate) a stream of ByteStrings. The WindowBits also control the format (zlib vs. gzip).

decompress

Arguments

:: (MonadBase base m, PrimMonad base, MonadThrow m)

=> WindowBits

Zlib parameter (see the zlib-bindings package as well as the zlib C library)

-> Conduit ByteString m ByteString

Decompress (inflate) a stream of ByteStrings. For example:

   sourceFile "test.z" $= decompress defaultWindowBits $$ sinkFile "test"

gzip :: (MonadThrow m, MonadBase base m, PrimMonad base) => Conduit ByteString m ByteString

Gzip compression with default parameters.

ungzip :: (MonadBase base m, PrimMonad base, MonadThrow m) => Conduit ByteString m ByteString

Gzip decompression with default parameters.

Flushing

compressFlush

Arguments

:: (MonadBase base m, PrimMonad base, MonadThrow m)

=> Int

Compression level

-> WindowBits

Zlib parameter (see the zlib-bindings package as well as the zlib C library)

-> Conduit (Flush ByteString) m (Flush ByteString)

Same as compress, but allows you to explicitly flush the stream.

decompressFlush

Arguments

:: (MonadBase base m, PrimMonad base, MonadThrow m)

=> WindowBits

Zlib parameter (see the zlib-bindings package as well as the zlib C library)

-> Conduit (Flush ByteString) m (Flush ByteString)

Same as decompress, but allows you to explicitly flush the stream.

Re-exported from zlib-bindings

data WindowBits :: *

Constructors

WindowBits Int

defaultWindowBits :: WindowBits