bz2-1.0.0.1: Bindings to libbz2

Safe Haskell	None
Language	Haskell2010

Codec.Compression.BZip

Contents

High-level functions.
Errors
Miscellany

Description

High-level functions throw BZError on error.

Since: 0.1.1.0

Synopsis

compress :: ByteString -> ByteString
compressWith :: CInt -> CInt -> ByteString -> ByteString
decompress :: ByteString -> ByteString
data BZError
- = BzConfigError
- | BzOutbuffFull
- | BzUnexpectedEof
- | BzIoError
- | BzDataErrorMagic
- | BzDataError
- | BzMemError
- | BzParamError
- | BzSequenceError
- | BzOk
- | BzRunOk
- | BzFlushOk
- | BzFinishOk
- | BzStreamEnd
bZ2BzlibVersion :: String

High-level functions.

compress :: ByteString -> ByteString Source #

Since: 0.1.1.0

compressWith Source #

Arguments

:: CInt	Block size (`1-9`)
-> CInt	Work factor (`0-250`)
-> ByteString
-> ByteString

See bzlib manual for information on compression parameters.

Since: 0.1.1.0

decompress :: ByteString -> ByteString Source #

Don't use this on pathological input; it may not be secure

Since: 0.1.1.0

Errors

data BZError Source #

Constructors

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

Instances

Instances details

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

Miscellany

bZ2BzlibVersion :: String Source #