Codec.Compression.BZip.Foreign

This module uses exceptions behind the scenes

Consult the upstream documentation for how to use this library.

For struct accessors, I recommend using c2hs.

Types

data BZAction

Constructors

BzRun

BzFlush

BzFinish

Instances

Enum BZAction

Defined in Codec.Compression.BZip.Foreign

Methods

succ :: BZAction -> BZAction

pred :: BZAction -> BZAction

toEnum :: Int -> BZAction

fromEnum :: BZAction -> Int

enumFrom :: BZAction -> [BZAction]

enumFromThen :: BZAction -> BZAction -> [BZAction]

enumFromTo :: BZAction -> BZAction -> [BZAction]

enumFromThenTo :: BZAction -> BZAction -> BZAction -> [BZAction]

data BZError

Constructors

BzConfigError

BzOutbuffFull

BzUnexpectedEof

BzIoError

BzDataErrorMagic

BzDataError

BzMemError

BzParamError

BzSequenceError

BzOk

BzRunOk

BzFlushOk

BzFinishOk

BzStreamEnd

Instances

Enum BZError

Defined in Codec.Compression.BZip.Foreign

Methods

succ :: BZError -> BZError

pred :: BZError -> BZError

toEnum :: Int -> BZError

fromEnum :: BZError -> Int

enumFrom :: BZError -> [BZError]

enumFromThen :: BZError -> BZError -> [BZError]

enumFromTo :: BZError -> BZError -> [BZError]

enumFromThenTo :: BZError -> BZError -> BZError -> [BZError]

Eq BZError

Defined in Codec.Compression.BZip.Foreign

Methods

(==) :: BZError -> BZError -> Bool

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

Show BZError

Defined in Codec.Compression.BZip.Foreign

Methods

showsPrec :: Int -> BZError -> ShowS

show :: BZError -> String

showList :: [BZError] -> ShowS

Exception BZError

Defined in Codec.Compression.BZip.Foreign

Methods

toException :: BZError -> SomeException

fromException :: SomeException -> Maybe BZError

displayException :: BZError -> String

data BzStream

Abstract type

type BzStreamPtr = Ptr BzStream

data BzFile

Abstract type

type BzFilePtr = Ptr BzFile

data FilePtr

FILE* in C.

Low-level functions

bZ2BzCompressInit :: BzStreamPtr -> CInt -> CInt -> CInt -> IO ()

bZ2BzCompress :: BzStreamPtr -> BZAction -> IO BZError

bZ2BzCompressEnd :: BzStreamPtr -> IO ()

bZ2BzDecompressInit :: BzStreamPtr -> CInt -> Bool -> IO ()

bZ2BzDecompress :: BzStreamPtr -> IO BZError

bZ2BzDecompressEnd :: BzStreamPtr -> IO ()

High-level functions

bZ2BzReadOpen :: FilePtr -> CInt -> Bool -> Ptr a -> CInt -> IO (BzFilePtr, BZError)

bZ2BzReadClose :: BzFilePtr -> IO BZError

bZ2BzReadGetUnused :: BzFilePtr -> IO (BZError, Ptr a, CInt)

bZ2BzRead :: BzFilePtr -> Ptr a -> CInt -> IO (CInt, BZError)

bZ2BzWriteOpen :: FilePtr -> CInt -> CInt -> CInt -> IO (BzFilePtr, BZError)

bZ2BzWrite :: BzFilePtr -> Ptr a -> CInt -> IO BZError

bZ2BzWriteClose :: BzFilePtr -> Bool -> IO (BZError, CUInt, CUInt)

bZ2BzWriteClose64 :: BzFilePtr -> Bool -> IO (BZError, CUInt, CUInt, CUInt, CUInt)

Macros

bZMaxUnused :: Integral a => a

Utility functions

bZ2BzBuffToBuffCompress :: Ptr a -> Ptr a -> CUInt -> CInt -> CInt -> CInt -> IO CUInt

bZ2BzBuffToBuffDecompress :: Ptr a -> Ptr a -> CUInt -> Bool -> CInt -> IO (BZError, CUInt)

Contributed functions

bZ2BzlibVersion :: String