| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Codec.Lz4
Description
The functions in this module throw exceptions on error.
decompress and compress are fully lazy, i.e. memory efficient.
Synopsis
- compressBlock :: ByteString -> ByteString
- compressBlockSingleThreaded :: ByteString -> ByteString
- decompressBlockSz :: ByteString -> Int -> ByteString
- decompressBlockSzSingleThreaded :: ByteString -> Int -> ByteString
- lZ4MaxInputSize :: Integral a => a
- compressBlockHC :: Int -> ByteString -> ByteString
- compressBlockHCSingleThreaded :: Int -> ByteString -> ByteString
- lZ4HCClevelMax :: Integral a => a
- compress :: ByteString -> ByteString
- compressSz :: Int -> ByteString -> ByteString
- decompress :: ByteString -> ByteString
- decompressBufSz :: Int -> ByteString -> ByteString
- lZ4VersionNumber :: CInt
- lZ4VersionString :: String
Functions for working with blocks
compressBlock :: ByteString -> ByteString Source #
compressBlockSingleThreaded :: ByteString -> ByteString Source #
Like compressBlock but uses unsafeDupablePerformIO under the hood.
Since: 0.1.5.0
Arguments
| :: ByteString | |
| -> Int | Decompressed size |
| -> ByteString |
Decompress a block. The size of the uncompressed data must be known.
decompressBlockSzSingleThreaded Source #
Arguments
| :: ByteString | |
| -> Int | Decompressed size |
| -> ByteString |
Decompress a block. Like decompressBlockSz but uses unsafeDupablePerformIO under the hood.
Since: 0.1.5.0
lZ4MaxInputSize :: Integral a => a Source #
Since: 0.1.1.0
Arguments
| :: Int | Compression level (must be less than |
| -> ByteString | |
| -> ByteString |
Since: 0.1.1.0
compressBlockHCSingleThreaded Source #
Arguments
| :: Int | Compression level (must be less than |
| -> ByteString | |
| -> ByteString |
Like compressBlockHC except uses unsafeDupablePerformIO under the hood.
Since: 0.1.5.0
lZ4HCClevelMax :: Integral a => a Source #
Since: 0.1.1.0
Functions for working with frames
compress :: ByteString -> ByteString Source #
Lazily compress a frame.
decompress :: ByteString -> ByteString Source #
Lazily decompress a frame
Arguments
| :: Int | Size of the output buffer |
| -> ByteString | |
| -> ByteString |
Since: 0.1.3.0
Version info
lZ4VersionNumber :: CInt Source #
Since: 0.1.1.0