vthemelis / ocaml-lz4

OCaml bindings for LZ4, a very fast lossless compression algorithm

OCaml LZ4 bindings

This package contains bindings for LZ4, a very fast lossless compression algorithm.

Installation

The bindings are available via OPAM:

$ opam install lz4

Alternatively, you can do it manually:

$ opam install dune ctypes
$ make all install

Usage

The bindings are contained in findlib package lz4.

To roundtrip some data:

let data         = "wild wild fox" in
let compressed   = LZ4.Bytes.compress (Bytes.of_string data) in
let decompressed = LZ4.Bytes.decompress ~length:(String.length data) compressed in
Printf.printf "%S\n" (Bytes.to_string decompressed) (* => "wild wild fox" *)

Documentation

The API documentation is available at GitHub pages.

License

3-clause BSD (same as LZ4).