| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Codec.Compression.BZip
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
- decompressErr :: ByteString -> Either BZError ByteString
- data BZError
- bZ2BzlibVersion :: String
High-level functions.
compress :: ByteString -> ByteString Source #
Since: 0.1.1.0
Arguments
| :: CInt | Block size ( |
| -> CInt | Work factor ( |
| -> 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
This does not handle nested streams
Since: 0.1.1.0
decompressErr :: ByteString -> Either BZError ByteString Source #
Return an error rather than throwing an exception.
Since: 1.0.1.0
Errors
Constructors
| BzConfigError | |
| BzOutbuffFull | |
| BzUnexpectedEof | |
| BzIoError | |
| BzDataErrorMagic | |
| BzDataError | |
| BzMemError | |
| BzParamError | |
| BzSequenceError | |
| BzOk | |
| BzRunOk | |
| BzFlushOk | |
| BzFinishOk | |
| BzStreamEnd |
Instances
| Enum BZError Source # | |
Defined in Codec.Compression.BZip.Foreign.Common 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 # | |
| Exception BZError Source # | |
Defined in Codec.Compression.BZip.Foreign.Common Methods toException :: BZError -> SomeException Source # fromException :: SomeException -> Maybe BZError Source # displayException :: BZError -> String Source # | |
| Show BZError Source # | |
| Eq BZError Source # | |