bz2-0.1.1.1: Bindings to libbz2

Safe Haskell	None
Language	Haskell2010

Codec.Compression.BZip.Foreign

Contents

Types
Low-level functions
High-level functions
Macros
Utility functions
Contributed functions

Description

This module uses exceptions behind the scenes

Consult the upstream documentation for how to use this library.

For struct accessors, I recommend using c2hs.

Synopsis

data BZAction
- = BzRun
- | BzFlush
- | BzFinish
data BZError
- = BzConfigError
- | BzOutbuffFull
- | BzUnexpectedEof
- | BzIoError
- | BzDataErrorMagic
- | BzDataError
- | BzMemError
- | BzParamError
- | BzSequenceError
- | BzOk
- | BzRunOk
- | BzFlushOk
- | BzFinishOk
- | BzStreamEnd
data BzStream
type BzStreamPtr = Ptr BzStream
data BzFile
type BzFilePtr = Ptr BzFile
data FilePtr
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 ()
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)
bZMaxUnused :: Integral a => a
bZ2BzBuffToBuffCompress :: Ptr a -> Ptr a -> CUInt -> CInt -> CInt -> CInt -> IO CUInt
bZ2BzBuffToBuffDecompress :: Ptr a -> Ptr a -> CUInt -> Bool -> CInt -> IO (BZError, CUInt)
bZ2BzlibVersion :: String

Types

data BZAction Source #

Constructors

BzRun
BzFlush
BzFinish

Instances

Enum BZAction Source #

Instance details

Defined in Codec.Compression.BZip.Foreign

Methods

succ :: BZAction -> BZAction Source #

pred :: BZAction -> BZAction Source #

toEnum :: Int -> BZAction Source #

fromEnum :: BZAction -> Int Source #

enumFrom :: BZAction -> [BZAction] Source #

enumFromThen :: BZAction -> BZAction -> [BZAction] Source #

enumFromTo :: BZAction -> BZAction -> [BZAction] Source #

enumFromThenTo :: BZAction -> BZAction -> BZAction -> [BZAction] Source #

data BZError Source #

Constructors

BzConfigError
BzOutbuffFull
BzUnexpectedEof
BzIoError
BzDataErrorMagic
BzDataError
BzMemError
BzParamError
BzSequenceError
BzOk
BzRunOk
BzFlushOk
BzFinishOk
BzStreamEnd

Instances

Enum BZError Source #
Instance details Defined in Codec.Compression.BZip.Foreign Methods succ :: BZError -> BZError Source # pred :: BZError -> BZError Source # toEnum :: Int -> BZError Source # fromEnum :: BZError -> Int Source # enumFrom :: BZError -> [BZError] Source # enumFromThen :: BZError -> BZError -> [BZError] Source # enumFromTo :: BZError -> BZError -> [BZError] Source # enumFromThenTo :: BZError -> BZError -> BZError -> [BZError] Source #
Eq BZError Source #
Instance details Defined in Codec.Compression.BZip.Foreign Methods (==) :: BZError -> BZError -> Bool Source # (/=) :: BZError -> BZError -> Bool Source #
Show BZError Source #
Instance details Defined in Codec.Compression.BZip.Foreign Methods showsPrec :: Int -> BZError -> ShowS Source # show :: BZError -> String Source # showList :: [BZError] -> ShowS Source #
Exception BZError Source #
Instance details Defined in Codec.Compression.BZip.Foreign Methods toException :: BZError -> SomeException Source # fromException :: SomeException -> Maybe BZError Source # displayException :: BZError -> String Source #

data BzStream Source #

Abstract type

type BzStreamPtr = Ptr BzStream Source #

data BzFile Source #

Abstract type

type BzFilePtr = Ptr BzFile Source #

data FilePtr Source #

FILE* in C.

Low-level functions

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

bZ2BzCompress :: BzStreamPtr -> BZAction -> IO BZError Source #

bZ2BzCompressEnd :: BzStreamPtr -> IO () Source #

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

bZ2BzDecompress :: BzStreamPtr -> IO BZError Source #

bZ2BzDecompressEnd :: BzStreamPtr -> IO () Source #

High-level functions

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

bZ2BzReadClose :: BzFilePtr -> IO BZError Source #

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

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

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

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

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

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

Macros

bZMaxUnused :: Integral a => a Source #

Utility functions

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

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

Contributed functions

bZ2BzlibVersion :: String Source #