Codec.Lzip

Functions throw LZErrno on failure

Compression functions should work on arbitrary data

Compression

compress :: ByteString -> ByteString

Alias for compressWith Six

compressBest :: ByteString -> ByteString

Alias for compressWith maxBound

Since: 0.3.2.0

compressFast :: ByteString -> ByteString

Alias for compressWith minBound

Since: 0.3.2.0

compressSz

Arguments

:: ByteString

-> Int

Size of input data, in bytes

-> ByteString

Alias for compressWithSz Six

Since: 1.0.2.0

compressSzBest

Arguments

:: ByteString

-> Int

Size of input data, in bytes

-> ByteString

Alias for compressWithSz maxBound

Since: 1.0.2.0

compressSzFast

Arguments

:: ByteString

-> Int

Size of input data, in bytes

-> ByteString

Alias for compressWithSz minBound

Since: 1.0.2.0

compressWith :: CompressionLevel -> ByteString -> ByteString

compressWithSz

Arguments

:: CompressionLevel

-> ByteString

-> Int

Size of data being compressed, in bytes.

-> ByteString

Since: 1.0.0.0

compressFile :: FilePath -> IO ByteString

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

Since: 1.0.0.0

compressFileLevel :: CompressionLevel -> FilePath -> IO ByteString

Since: 1.0.3.0

compressFileBest :: FilePath -> IO ByteString

Since: 1.0.3.0

compressFileFast :: FilePath -> IO ByteString

Since: 1.0.3.0

compressFineTune

Arguments

:: LzOptions

-> ByteString

-> Int

Size of data being compressed, in bytes.

-> ByteString

data CompressionLevel

Constructors

Zero

One

Two

Three

Four

Five

Six

Seven

Eight

Nine

Instances

Bounded CompressionLevel

Defined in Codec.Lzip

Methods

minBound :: CompressionLevel

maxBound :: CompressionLevel

Enum CompressionLevel

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

Constructors

LzOptions

Fields

• dictionarySize :: !Int
• matchLenLimit :: !Int

Decompression

decompress :: ByteString -> ByteString

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

Constructors

LzMemError

LzHeaderError

LzUnexpectedEof

LzDataError

LzLibraryError

Instances

Enum LZErrno

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]

Eq LZErrno

Defined in Codec.Lzip.Raw

Methods

(==) :: LZErrno -> LZErrno -> Bool

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

Show LZErrno

Defined in Codec.Lzip.Raw

Methods

showsPrec :: Int -> LZErrno -> ShowS

show :: LZErrno -> String

showList :: [LZErrno] -> ShowS

Exception LZErrno

Defined in Codec.Lzip.Raw

Methods

toException :: LZErrno -> SomeException

fromException :: SomeException -> Maybe LZErrno

displayException :: LZErrno -> String

Miscellany

lZVersion :: String

lZApiVersion :: Integral a => a

Since: 0.3.1.0