lzip-0.0.0.0: Lzip compression / Lzlib bindings

Safe Haskell	Unsafe
Language	Haskell2010

Codec.Compression.Lzlib.FFI

Contents

Parameter limits
Compression functions
Decompression functions
Error codes
Internal

Description

Primitive unsafe low-level FFI bindings to lzlib

Synopsis

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
data LzEncoder
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
data LzDecoder
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
type C'LZ_Errno = Word32
data LzErrno
- = LzOk
- | LzBadArgument
- | LzMemError
- | LzSequenceError
- | LzHeaderError
- | LzUnexpectedEof
- | LzDataError
- | LzLibraryError
- | LzUnknown
toLzErrno :: C'LZ_Errno -> LzErrno
c'lzlib_version_check :: CInt

Parameter limits

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

c'LZ_min_dictionary_bits :: CInt Source #

c'LZ_min_dictionary_size :: CInt Source #

c'LZ_max_dictionary_size :: CInt Source #

c'LZ_max_dictionary_bits :: CInt Source #

c'LZ_min_match_len_limit :: CInt Source #

c'LZ_max_match_len_limit :: CInt Source #

Compression functions

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

data LzEncoder Source #

lzlib compressor handle.

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

c'LZ_compress_close :: Ptr LzEncoder -> IO CInt Source #

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

c'LZ_compress_finish :: Ptr LzEncoder -> IO CInt Source #

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

c'LZ_compress_sync_flush :: Ptr LzEncoder -> IO CInt Source #

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

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

c'LZ_compress_write_size :: Ptr LzEncoder -> IO CInt Source #

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

c'LZ_compress_finished :: Ptr LzEncoder -> IO CInt Source #

c'LZ_compress_member_finished :: Ptr LzEncoder -> IO CInt Source #

c'LZ_compress_data_position :: Ptr LzEncoder -> IO CULLong Source #

c'LZ_compress_member_position :: Ptr LzEncoder -> IO CULLong Source #

c'LZ_compress_total_in_size :: Ptr LzEncoder -> IO CULLong Source #

c'LZ_compress_total_out_size :: Ptr LzEncoder -> IO CULLong Source #

Decompression functions

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

data LzDecoder Source #

lzlib decompressor handle.

c'LZ_decompress_open :: IO (Ptr LzDecoder) Source #

c'LZ_decompress_close :: Ptr LzDecoder -> IO CInt Source #

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

c'LZ_decompress_finish :: Ptr LzDecoder -> IO CInt Source #

c'LZ_decompress_reset :: Ptr LzDecoder -> IO CInt Source #

c'LZ_decompress_sync_to_member :: Ptr LzDecoder -> IO CInt Source #

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

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

c'LZ_decompress_write_size :: Ptr LzDecoder -> IO CInt Source #

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

c'LZ_decompress_finished :: Ptr LzDecoder -> IO CInt Source #

c'LZ_decompress_member_finished :: Ptr LzDecoder -> IO CInt Source #

c'LZ_decompress_member_version :: Ptr LzDecoder -> IO CInt Source #

c'LZ_decompress_dictionary_size :: Ptr LzDecoder -> IO CInt Source #

c'LZ_decompress_data_crc :: Ptr LzDecoder -> IO CUInt Source #

c'LZ_decompress_data_position :: Ptr LzDecoder -> IO CULLong Source #

c'LZ_decompress_member_position :: Ptr LzDecoder -> IO CULLong Source #

c'LZ_decompress_total_in_size :: Ptr LzDecoder -> IO CULLong Source #

c'LZ_decompress_total_out_size :: Ptr LzDecoder -> IO CULLong Source #

Error codes

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

type C'LZ_Errno = Word32 Source #

data LzErrno Source #

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 Source #
Instance details Defined in Codec.Compression.Lzlib.FFI Methods (==) :: LzErrno -> LzErrno -> Bool # (/=) :: LzErrno -> LzErrno -> Bool #
Show LzErrno Source #
Instance details Defined in Codec.Compression.Lzlib.FFI Methods showsPrec :: Int -> LzErrno -> ShowS # show :: LzErrno -> String # showList :: [LzErrno] -> ShowS #
Exception LzErrno Source #
Instance details Defined in Codec.Compression.Lzlib.FFI Methods toException :: LzErrno -> SomeException # fromException :: SomeException -> Maybe LzErrno # displayException :: LzErrno -> String #

toLzErrno :: C'LZ_Errno -> LzErrno Source #

Convert FFI enum LZ_Errno into the Haskell enum type LzErrno.

Internal

c'lzlib_version_check :: CInt Source #