lzlib-1.0.7.4: lzlib bindings

Safe Haskell	Safe-Inferred
Language	Haskell2010

Codec.Lzip

Contents

Compression
Decompression
Miscellany

Description

Functions throw LZErrno on failure

Compression functions should work on arbitrary data

Synopsis

compress :: ByteString -> ByteString
compressBest :: ByteString -> ByteString
compressFast :: ByteString -> ByteString
compressSz :: ByteString -> Int -> ByteString
compressSzBest :: ByteString -> Int -> ByteString
compressSzFast :: ByteString -> Int -> ByteString
compressWith :: CompressionLevel -> ByteString -> ByteString
compressWithSz :: CompressionLevel -> ByteString -> Int -> ByteString
compressFile :: FilePath -> IO ByteString
compressFileLevel :: CompressionLevel -> FilePath -> IO ByteString
compressFileBest :: FilePath -> IO ByteString
compressFileFast :: FilePath -> IO ByteString
compressFineTune :: LzOptions -> ByteString -> Int -> ByteString
data CompressionLevel
- = Zero
- | One
- | Two
- | Three
- | Four
- | Five
- | Six
- | Seven
- | Eight
- | Nine
data LzOptions = LzOptions {
- dictionarySize :: !Int
- matchLenLimit :: !Int
}
decompress :: ByteString -> ByteString
data LZErrno
- = LzMemError
- | LzHeaderError
- | LzUnexpectedEof
- | LzDataError
- | LzLibraryError
lZVersion :: String
lZApiVersion :: Integral a => a

Compression

compress :: ByteString -> ByteString Source #

Alias for compressWith Six

compressBest :: ByteString -> ByteString Source #

Alias for compressWith maxBound

Since: 0.3.2.0

compressFast :: ByteString -> ByteString Source #

Alias for compressWith minBound

Since: 0.3.2.0

compressSz Source #

Arguments

:: ByteString
-> Int	Size of input data, in bytes
-> ByteString

Alias for compressWithSz Six

Since: 1.0.2.0

compressSzBest Source #

Arguments

:: ByteString
-> Int	Size of input data, in bytes
-> ByteString

Alias for compressWithSz maxBound

Since: 1.0.2.0

compressSzFast Source #

Arguments

:: ByteString
-> Int	Size of input data, in bytes
-> ByteString

Alias for compressWithSz minBound

Since: 1.0.2.0

compressWith :: CompressionLevel -> ByteString -> ByteString Source #

compressWithSz Source #

Arguments

:: CompressionLevel
-> ByteString
-> Int	Size of data being compressed, in bytes.
-> ByteString

Since: 1.0.0.0

compressFile :: FilePath -> IO ByteString Source #

Use this to avoid forcing the whole file into memory at once

Since: 1.0.0.0

compressFileLevel :: CompressionLevel -> FilePath -> IO ByteString Source #

Since: 1.0.3.0

compressFileBest :: FilePath -> IO ByteString Source #

Since: 1.0.3.0

compressFileFast :: FilePath -> IO ByteString Source #

Since: 1.0.3.0

compressFineTune Source #

Arguments

:: LzOptions
-> ByteString
-> Int	Size of data being compressed, in bytes.
-> ByteString

data CompressionLevel Source #

Constructors

Zero
One
Two
Three
Four
Five
Six
Seven
Eight
Nine

Instances

Instances details

Bounded CompressionLevel Source #
Instance details Defined in Codec.Lzip Methods minBound :: CompressionLevel # maxBound :: CompressionLevel #
Enum CompressionLevel Source #
Instance details Defined in Codec.Lzip Methods succ :: CompressionLevel -> CompressionLevel # pred :: CompressionLevel -> CompressionLevel # toEnum :: Int -> CompressionLevel # fromEnum :: CompressionLevel -> Int # enumFrom :: CompressionLevel -> [CompressionLevel] # enumFromThen :: CompressionLevel -> CompressionLevel -> [CompressionLevel] # enumFromTo :: CompressionLevel -> CompressionLevel -> [CompressionLevel] # enumFromThenTo :: CompressionLevel -> CompressionLevel -> CompressionLevel -> [CompressionLevel] #

data LzOptions Source #

Constructors

LzOptions
Fields dictionarySize :: !Int matchLenLimit :: !Int

Decompression

decompress :: ByteString -> ByteString Source #

This does not do any error recovery; for that you should use lziprecover.

Doesn't work on empty ByteStrings

Throws LZErrno on error

data LZErrno Source #

Constructors

LzMemError
LzHeaderError
LzUnexpectedEof
LzDataError
LzLibraryError

Instances

Instances details

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

Miscellany

lZVersion :: String Source #

lZApiVersion :: Integral a => a Source #

Since: 0.3.1.0