package lz4

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

Install

Dune Dependency

Authors

Maintainers

Sources

v1.2.0.tar.gz
md5=d2e3d607dbc2961a94312164c309f0fa
sha512=9b817e5446c156abb00acdc3da2925bbe725600bfb2f0761079252d9aabd2abd36ea84b69bdb252cc26419009465bc629f8cc677fb68e0518a844f5c5deed00d

Description

Tags

lz4 compression decompression

Published: 14 Jul 2022

README

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).

Dependencies (4)

  1. ctypes >= "0.4.1" & < "0.21.0"
  2. dune >= "2.0"
  3. conf-liblz4
  4. ocaml >= "4.02"

Dev Dependencies (2)

  1. odoc with-doc
  2. ounit2 with-test

Used by (3)

  1. dokeysto < "2.0.0"
  2. dokeysto_lz4
  3. pardi >= "2.0.2" & < "3.2.2"

Conflicts

None