Codec.Compression.Lzlib.FFI

Primitive unsafe low-level FFI bindings to lzlib

Parameter limits

See also chapter "4 Parameter limits" in the lzlib manual.

c'LZ_min_dictionary_bits :: CInt

c'LZ_min_dictionary_size :: CInt

c'LZ_max_dictionary_size :: CInt

c'LZ_max_dictionary_bits :: CInt

c'LZ_min_match_len_limit :: CInt

c'LZ_max_match_len_limit :: CInt

Compression functions

See also chapter "5 Compression functions" in the lzlib manual.

data LzEncoder

lzlib compressor handle.

c'LZ_compress_open :: CInt -> CInt -> CULLong -> IO (Ptr LzEncoder)

c'LZ_compress_close :: Ptr LzEncoder -> IO CInt

cp'LZ_compress_close :: FunPtr (Ptr LzEncoder -> IO ())

c'LZ_compress_finish :: Ptr LzEncoder -> IO CInt

c'LZ_compress_restart_member :: Ptr LzEncoder -> CULLong -> IO CInt

c'LZ_compress_sync_flush :: Ptr LzEncoder -> IO CInt

c'LZ_compress_read :: Ptr LzEncoder -> Ptr Word8 -> CInt -> IO CInt

c'LZ_compress_write :: Ptr LzEncoder -> Ptr Word8 -> CInt -> IO CInt

c'LZ_compress_write_size :: Ptr LzEncoder -> IO CInt

c'LZ_compress_errno :: Ptr LzEncoder -> IO C'LZ_Errno

c'LZ_compress_finished :: Ptr LzEncoder -> IO CInt

c'LZ_compress_member_finished :: Ptr LzEncoder -> IO CInt

c'LZ_compress_data_position :: Ptr LzEncoder -> IO CULLong

c'LZ_compress_member_position :: Ptr LzEncoder -> IO CULLong

c'LZ_compress_total_in_size :: Ptr LzEncoder -> IO CULLong

c'LZ_compress_total_out_size :: Ptr LzEncoder -> IO CULLong

Decompression functions

See also chapter "6 Decompression functions" in the lzlib manual.

data LzDecoder

lzlib decompressor handle.

c'LZ_decompress_open :: IO (Ptr LzDecoder)

c'LZ_decompress_close :: Ptr LzDecoder -> IO CInt

cp'LZ_decompress_close :: FunPtr (Ptr LzDecoder -> IO ())

c'LZ_decompress_finish :: Ptr LzDecoder -> IO CInt

c'LZ_decompress_reset :: Ptr LzDecoder -> IO CInt

c'LZ_decompress_sync_to_member :: Ptr LzDecoder -> IO CInt

c'LZ_decompress_read :: Ptr LzDecoder -> Ptr Word8 -> CInt -> IO CInt

c'LZ_decompress_write :: Ptr LzDecoder -> Ptr Word8 -> CInt -> IO CInt

c'LZ_decompress_write_size :: Ptr LzDecoder -> IO CInt

c'LZ_decompress_errno :: Ptr LzDecoder -> IO C'LZ_Errno

c'LZ_decompress_finished :: Ptr LzDecoder -> IO CInt

c'LZ_decompress_member_finished :: Ptr LzDecoder -> IO CInt

c'LZ_decompress_member_version :: Ptr LzDecoder -> IO CInt

c'LZ_decompress_dictionary_size :: Ptr LzDecoder -> IO CInt

c'LZ_decompress_data_crc :: Ptr LzDecoder -> IO CUInt

c'LZ_decompress_data_position :: Ptr LzDecoder -> IO CULLong

c'LZ_decompress_member_position :: Ptr LzDecoder -> IO CULLong

c'LZ_decompress_total_in_size :: Ptr LzDecoder -> IO CULLong

c'LZ_decompress_total_out_size :: Ptr LzDecoder -> IO CULLong

Error codes

See also chapter "7 Error codes" in the lzlib manual.

type C'LZ_Errno = Word32

data LzErrno

lzlib error codes

See lzlib manual for more details.

Constructors

LzOk

LzBadArgument

LzMemError

LzSequenceError

LzHeaderError

LzUnexpectedEof

LzDataError

LzLibraryError

LzUnknown

not defined by lzlib

Instances

Eq LzErrno

Defined in Codec.Compression.Lzlib.FFI

Methods

(==) :: LzErrno -> LzErrno -> Bool

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

Show LzErrno

Defined in Codec.Compression.Lzlib.FFI

Methods

showsPrec :: Int -> LzErrno -> ShowS

show :: LzErrno -> String

showList :: [LzErrno] -> ShowS

Exception LzErrno

Defined in Codec.Compression.Lzlib.FFI

Methods

toException :: LzErrno -> SomeException

fromException :: SomeException -> Maybe LzErrno

displayException :: LzErrno -> String

toLzErrno :: C'LZ_Errno -> LzErrno

Convert FFI enum LZ_Errno into the Haskell enum type LzErrno.

Internal

c'lzlib_version_check :: CInt