Copyright	(c) Dong Han 2017-2020
License	BSD
Maintainer	winterland1989@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Z.IO.BIO.Zlib

Contents

Compression
Decompression
Constants

Description

This module provides zlib bindings, with BIO streaming interface, e.g.

-- add compressor to your BIO chain to compress streaming blocks of Bytes.
(_, zlibCompressor) <- newCompress defaultCompressConfig{compressWindowBits = 31}
runBIO $ src >|> zlibCompressor >|> sink

Synopsis

newCompress :: HasCallStack => CompressConfig -> IO (ZStream, BIO Bytes Bytes)
compressReset :: ZStream -> IO ()
compress :: HasCallStack => CompressConfig -> Bytes -> Bytes
compressBlocks :: HasCallStack => CompressConfig -> [Bytes] -> [Bytes]
data ZStream
data CompressConfig = CompressConfig {
- compressLevel :: CompressLevel
- compressWindowBits :: WindowBits
- compressMemoryLevel :: MemLevel
- compressDictionary :: Bytes
- compressStrategy :: Strategy
- compressBufferSize :: Int
}
defaultCompressConfig :: CompressConfig
newDecompress :: DecompressConfig -> IO (ZStream, BIO Bytes Bytes)
decompressReset :: ZStream -> IO ()
decompress :: HasCallStack => DecompressConfig -> Bytes -> Bytes
decompressBlocks :: HasCallStack => DecompressConfig -> [Bytes] -> [Bytes]
data DecompressConfig = DecompressConfig {
- decompressWindowBits :: WindowBits
- decompressDictionary :: Bytes
- decompressBufferSize :: Int
}
defaultDecompressConfig :: DecompressConfig
type WindowBits = CInt
defaultWindowBits :: WindowBits
type MemLevel = CInt
defaultMemLevel :: MemLevel
type Strategy = CInt
pattern Z_FILTERED :: Strategy
pattern Z_HUFFMAN_ONLY :: Strategy
pattern Z_RLE :: Strategy
pattern Z_FIXED :: Strategy
pattern Z_DEFAULT_STRATEGY :: Strategy
type CompressLevel = CInt
pattern Z_BEST_SPEED :: CompressLevel
pattern Z_BEST_COMPRESSION :: CompressLevel
pattern Z_DEFAULT_COMPRESSION :: CompressLevel

Compression

newCompress :: HasCallStack => CompressConfig -> IO (ZStream, BIO Bytes Bytes) Source #

Make a new compress node.

The returned BIO node can be reused only if you call compressReset on the ZStream.

compressReset :: ZStream -> IO () Source #

Reset compressor's state so that related BIO can be reused.

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

Compress some bytes.

compressBlocks :: HasCallStack => CompressConfig -> [Bytes] -> [Bytes] Source #

Compress some bytes in blocks.

data ZStream Source #

A foreign pointer to a zlib's z_stream_s struct.

data CompressConfig Source #

Constructors

CompressConfig
Fields compressLevel :: CompressLevel compressWindowBits :: WindowBits compressMemoryLevel :: MemLevel compressDictionary :: Bytes compressStrategy :: Strategy compressBufferSize :: Int

Instances

Instances details

Eq CompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods (==) :: CompressConfig -> CompressConfig -> Bool # (/=) :: CompressConfig -> CompressConfig -> Bool #
Ord CompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods compare :: CompressConfig -> CompressConfig -> Ordering # (<) :: CompressConfig -> CompressConfig -> Bool # (<=) :: CompressConfig -> CompressConfig -> Bool # (>) :: CompressConfig -> CompressConfig -> Bool # (>=) :: CompressConfig -> CompressConfig -> Bool # max :: CompressConfig -> CompressConfig -> CompressConfig # min :: CompressConfig -> CompressConfig -> CompressConfig #
Show CompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods showsPrec :: Int -> CompressConfig -> ShowS # show :: CompressConfig -> String # showList :: [CompressConfig] -> ShowS #
Generic CompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Associated Types type Rep CompressConfig :: Type -> Type # Methods from :: CompressConfig -> Rep CompressConfig x # to :: Rep CompressConfig x -> CompressConfig #
JSON CompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods fromValue :: Value -> Converter CompressConfig # toValue :: CompressConfig -> Value # encodeJSON :: CompressConfig -> Builder () #
Print CompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods toUTF8BuilderP :: Int -> CompressConfig -> Builder () #
type Rep CompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib type Rep CompressConfig = D1 ('MetaData "CompressConfig" "Z.IO.BIO.Zlib" "Z-IO-0.6.4.0-3RdtkLMi3pWlcaS0GimBE" 'False) (C1 ('MetaCons "CompressConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "compressLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CompressLevel) :: (S1 ('MetaSel ('Just "compressWindowBits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WindowBits) :: S1 ('MetaSel ('Just "compressMemoryLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MemLevel))) :: (S1 ('MetaSel ('Just "compressDictionary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bytes) :: (S1 ('MetaSel ('Just "compressStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Strategy) :*: S1 ('MetaSel ('Just "compressBufferSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))))

defaultCompressConfig :: CompressConfig Source #

Decompression

newDecompress :: DecompressConfig -> IO (ZStream, BIO Bytes Bytes) Source #

Make a new decompress node.

The returned BIO node can be reused only if you call decompressReset on the ZStream.

decompressReset :: ZStream -> IO () Source #

Reset decompressor's state so that related BIO can be reused.

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

Decompress some bytes.

decompressBlocks :: HasCallStack => DecompressConfig -> [Bytes] -> [Bytes] Source #

Decompress some bytes in blocks.

data DecompressConfig Source #

Constructors

DecompressConfig
Fields decompressWindowBits :: WindowBits decompressDictionary :: Bytes decompressBufferSize :: Int

Instances

Instances details

Eq DecompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods (==) :: DecompressConfig -> DecompressConfig -> Bool # (/=) :: DecompressConfig -> DecompressConfig -> Bool #
Ord DecompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods compare :: DecompressConfig -> DecompressConfig -> Ordering # (<) :: DecompressConfig -> DecompressConfig -> Bool # (<=) :: DecompressConfig -> DecompressConfig -> Bool # (>) :: DecompressConfig -> DecompressConfig -> Bool # (>=) :: DecompressConfig -> DecompressConfig -> Bool # max :: DecompressConfig -> DecompressConfig -> DecompressConfig # min :: DecompressConfig -> DecompressConfig -> DecompressConfig #
Show DecompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods showsPrec :: Int -> DecompressConfig -> ShowS # show :: DecompressConfig -> String # showList :: [DecompressConfig] -> ShowS #
Generic DecompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Associated Types type Rep DecompressConfig :: Type -> Type # Methods from :: DecompressConfig -> Rep DecompressConfig x # to :: Rep DecompressConfig x -> DecompressConfig #
JSON DecompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods fromValue :: Value -> Converter DecompressConfig # toValue :: DecompressConfig -> Value # encodeJSON :: DecompressConfig -> Builder () #
Print DecompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib Methods toUTF8BuilderP :: Int -> DecompressConfig -> Builder () #
type Rep DecompressConfig Source #
Instance details Defined in Z.IO.BIO.Zlib type Rep DecompressConfig = D1 ('MetaData "DecompressConfig" "Z.IO.BIO.Zlib" "Z-IO-0.6.4.0-3RdtkLMi3pWlcaS0GimBE" 'False) (C1 ('MetaCons "DecompressConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "decompressWindowBits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WindowBits) :: (S1 ('MetaSel ('Just "decompressDictionary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bytes) :: S1 ('MetaSel ('Just "decompressBufferSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))

defaultDecompressConfig :: DecompressConfig Source #

Constants

Windows bits

type WindowBits = CInt Source #

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.

defaultWindowBits :: WindowBits Source #

Memory level

type MemLevel = CInt Source #

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.

defaultMemLevel :: MemLevel Source #

Strategy

type Strategy = CInt Source #

pattern Z_FILTERED :: Strategy Source #

pattern Z_HUFFMAN_ONLY :: Strategy Source #

pattern Z_RLE :: Strategy Source #

pattern Z_FIXED :: Strategy Source #

pattern Z_DEFAULT_STRATEGY :: Strategy Source #

CompressLevel

type CompressLevel = CInt Source #

pattern Z_BEST_SPEED :: CompressLevel Source #

pattern Z_BEST_COMPRESSION :: CompressLevel Source #

pattern Z_DEFAULT_COMPRESSION :: CompressLevel Source #