Z.Compression.Zlib

This module provides zlib bindings.

Compression

data CompressConfig

Constructors

CompressConfig

Fields

• compressLevel :: CompressLevel
• compressWindowBits :: WindowBits
• compressMemoryLevel :: MemLevel
• compressDictionary :: CBytes
• compressStrategy :: Strategy

defaultCompressConfig :: CompressConfig

compress :: HasCallStack => CompressConfig -> Bytes -> Bytes

Compress some bytes.

compressSink :: HasCallStack => CompressConfig -> Sink Bytes -> IO (Sink Bytes)

Compress all the data written to a output.

data Strategy where

Bundled Patterns

pattern Z_FILTERED :: Strategy

pattern Z_HUFFMAN_ONLY :: Strategy

pattern Z_RLE :: Strategy

pattern Z_FIXED :: Strategy

pattern Z_DEFAULT_STRATEGY :: Strategy

Instances

Eq Strategy

Defined in Z.Compression.Zlib

Methods

(==) :: Strategy -> Strategy -> Bool

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

Ord Strategy

Defined in Z.Compression.Zlib

Methods

compare :: Strategy -> Strategy -> Ordering

(<) :: Strategy -> Strategy -> Bool

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

(>) :: Strategy -> Strategy -> Bool

(>=) :: Strategy -> Strategy -> Bool

max :: Strategy -> Strategy -> Strategy

min :: Strategy -> Strategy -> Strategy

Show Strategy

Defined in Z.Compression.Zlib

Methods

showsPrec :: Int -> Strategy -> ShowS

show :: Strategy -> String

showList :: [Strategy] -> ShowS

data CompressLevel where

Bundled Patterns

pattern Z_BEST_SPEED :: CompressLevel

pattern Z_BEST_COMPRESSION :: CompressLevel

pattern Z_DEFAULT_COMPRESSION :: CompressLevel

Instances

Eq CompressLevel

Defined in Z.Compression.Zlib

Methods

(==) :: CompressLevel -> CompressLevel -> Bool

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

Ord CompressLevel

Defined in Z.Compression.Zlib

Methods

compare :: CompressLevel -> CompressLevel -> Ordering

(<) :: CompressLevel -> CompressLevel -> Bool

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

(>) :: CompressLevel -> CompressLevel -> Bool

(>=) :: CompressLevel -> CompressLevel -> Bool

max :: CompressLevel -> CompressLevel -> CompressLevel

min :: CompressLevel -> CompressLevel -> CompressLevel

Show CompressLevel

Defined in Z.Compression.Zlib

Methods

showsPrec :: Int -> CompressLevel -> ShowS

show :: CompressLevel -> String

showList :: [CompressLevel] -> ShowS

data WindowBits

The WindowBits is the base two logarithm of the maximum window size (the size of the history buffer). It should be in the range 8..15 for this version of the library. The defaultWindowBits value is 15. Decompressing windowBits must be greater than or equal to the compressing windowBits. If a compressed stream with a larger window size is given as input, decompress will throw ZDataError windowBits can also be –8..–15 for raw inflate. In this case, -windowBits determines the window size. inflate() will then process raw deflate data, not looking for a zlib or gzip header, not generating a check value, and not looking for any check values for comparison at the end of the stream. windowBits can also be greater than 15 for optional gzip decoding. Add 32 to windowBits to enable zlib and gzip decoding with automatic header detection, or add 16 to decode only the gzip format.

Instances

Eq WindowBits

Defined in Z.Compression.Zlib

Methods

(==) :: WindowBits -> WindowBits -> Bool

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

Num WindowBits

Defined in Z.Compression.Zlib

Methods

(+) :: WindowBits -> WindowBits -> WindowBits

(-) :: WindowBits -> WindowBits -> WindowBits

(*) :: WindowBits -> WindowBits -> WindowBits

negate :: WindowBits -> WindowBits

abs :: WindowBits -> WindowBits

signum :: WindowBits -> WindowBits

fromInteger :: Integer -> WindowBits

Ord WindowBits

Defined in Z.Compression.Zlib

Methods

compare :: WindowBits -> WindowBits -> Ordering

(<) :: WindowBits -> WindowBits -> Bool

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

(>) :: WindowBits -> WindowBits -> Bool

(>=) :: WindowBits -> WindowBits -> Bool

max :: WindowBits -> WindowBits -> WindowBits

min :: WindowBits -> WindowBits -> WindowBits

Read WindowBits

Defined in Z.Compression.Zlib

Methods

readsPrec :: Int -> ReadS WindowBits

readList :: ReadS [WindowBits]

readPrec :: ReadPrec WindowBits

readListPrec :: ReadPrec [WindowBits]

Show WindowBits

Defined in Z.Compression.Zlib

Methods

showsPrec :: Int -> WindowBits -> ShowS

show :: WindowBits -> String

showList :: [WindowBits] -> ShowS

defaultWindowBits :: WindowBits

data MemLevel

The MemLevel specifies how much memory should be allocated for the internal compression state. 1 uses minimum memory but is slow and reduces compression ratio; 9 uses maximum memory for optimal speed. The default value is 8.

Instances

Eq MemLevel

Defined in Z.Compression.Zlib

Methods

(==) :: MemLevel -> MemLevel -> Bool

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

Num MemLevel

Defined in Z.Compression.Zlib

Methods

(+) :: MemLevel -> MemLevel -> MemLevel

(-) :: MemLevel -> MemLevel -> MemLevel

(*) :: MemLevel -> MemLevel -> MemLevel

negate :: MemLevel -> MemLevel

abs :: MemLevel -> MemLevel

signum :: MemLevel -> MemLevel

fromInteger :: Integer -> MemLevel

Ord MemLevel

Defined in Z.Compression.Zlib

Methods

compare :: MemLevel -> MemLevel -> Ordering

(<) :: MemLevel -> MemLevel -> Bool

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

(>) :: MemLevel -> MemLevel -> Bool

(>=) :: MemLevel -> MemLevel -> Bool

max :: MemLevel -> MemLevel -> MemLevel

min :: MemLevel -> MemLevel -> MemLevel

Read MemLevel

Defined in Z.Compression.Zlib

Methods

readsPrec :: Int -> ReadS MemLevel

readList :: ReadS [MemLevel]

readPrec :: ReadPrec MemLevel

readListPrec :: ReadPrec [MemLevel]

Show MemLevel

Defined in Z.Compression.Zlib

Methods

showsPrec :: Int -> MemLevel -> ShowS

show :: MemLevel -> String

showList :: [MemLevel] -> ShowS

defaultMemLevel :: MemLevel

Decompression

data DecompressConfig

Constructors

DecompressConfig

Fields

• decompressWindowBits :: WindowBits
• decompressDictionary :: CBytes

defaultDecompressConfig :: DecompressConfig

decompress :: HasCallStack => DecompressConfig -> Bytes -> Bytes

Decompress some bytes.

decompressSource :: DecompressConfig -> Source Bytes -> IO (Source Bytes)

Decompress bytes from source.