Lz4.Block

Documentation

compress

Arguments

:: Int

Acceleration Factor (Use 1 if uncertain)

-> Bytes

Bytes to compress

-> Bytes

Compress bytes using LZ4. A higher acceleration factor increases speed but decreases compression. This function has undefined behavior on byte sequences larger than 2,113,929,216 bytes. This calls LZ4_compress_default.

compressU

Arguments

:: Int

Acceleration Factor (Use 1 if uncertain)

-> Bytes

Bytes to compress

-> ByteArray

Variant of compress with an unsliced result.

compressHighly

Arguments

:: Int

Compression level (Use 9 if uncertain)

-> Bytes

Bytes to compress

-> Bytes

Compress bytes using LZ4's HC algorithm. This is slower than compress but provides better compression. A higher compression level increases compression but decreases speed. This function has undefined behavior on byte sequences larger than 2,113,929,216 bytes. This calls LZ4_compress_HC.

compressHighlyU

Arguments

:: Int

Compression level (Use 9 if uncertain)

-> Bytes

Bytes to compress

-> ByteArray

Variant of compressHighly with an unsliced result.

decompress

Arguments

:: Int

Expected length of decompressed bytes

-> Bytes

Compressed bytes

-> Maybe Bytes

Decompress a byte sequence. Fails if the actual decompressed result does not match the given expected length.

decompressU

Arguments

:: Int

Expected length of decompressed bytes

-> Bytes

Compressed bytes

-> Maybe ByteArray

Variant of decompress with an unsliced result.