package lz4

  1. Overview
  2. Docs
Bindings to the LZ4 compression algorithm

Install

dune-project
 Dependency

Authors

Maintainers

Sources

lz4-1.3.0.tbz
sha256=3cbbd2003916442d8ec797e48f0c8433e1a50e98c549777ad0de2e0fb774248e
sha512=54859f27d4b7c9d60be056951f0dd8617fabe7400c0a35842bb65c7f795d1859dbfec678ceea82f9c3d3521f97e7b049d06553a21a70d50d8ba69c83d4031290

doc/lz4/LZ4/module-type-S/index.html

Module type LZ4.SSource

Sourcetype storage
Sourceval compress_into : storage -> storage -> int

compress_into input output places LZ4-compressed input into output and returns the length of compressed output or raises Input_too_large if input is longer than 0x7E000000 bytes or output is not long enough to contain the compressed input.

This function does not allocate.

Sourceval compress : storage -> storage

compress input returns LZ4-compressed input or raises Input_too_large if input is longer than 0x7E000000 bytes.

Sourceval decompress_into : storage -> storage -> int

decompress_into input output places LZ4-decompressed input into output or raises Corrupted if input does not constitute a valid LZ4-compressed stream which uncompresses into the amount of bytes available in output or less.

This function does not allocate.

Sourceval decompress : length:int -> storage -> storage

decompress ~length input returns LZ4-decompressed input or raises Corrupted if input does not constitute a valid LZ4-compressed stream which uncompresses into length bytes or less. Raises Invalid_argument "LZ4.decompress" if length is negative.