package ezgzip

  1. Overview
  2. Docs
# ezgzip - Simple gzip (de)compression library

Install

Dune Dependency

Authors

Maintainers

Sources

v0.2.0.tar.gz
md5=22057f2528e282a1af961b36f61d5271

Description

ezgzip is a simple interface focused on string -> string zlib and gzip (de)compression.

Documentation is available here.

An example illustrating how to gzip compress and then decompress a string:

open Rresult

let () =
  let original = "Hello world" in
  let compressed = Ezgzip.compress original in
  let decompressed = R.get_ok (Ezgzip.decompress compressed) in
  assert (original = decompressed)

This library currently uses the zlib bindings provided by camlzip. The gzip header/footer code is based on the upstream specification.

Published: 23 Feb 2018

README

ezgzip - Simple gzip (de)compression library

Documentation is available here.

open Rresult

let () =
  let original = "Hello world" in
  let compressed = Ezgzip.compress original in
  let decompressed = R.get_ok (Ezgzip.decompress compressed) in
  assert (original = decompressed)

Compile

make

Load an interactive environment for testing

make repl

The library will be available from this environment.

Run tests

make test

Run benchmarks

make benchmark

Build documentation

make doc

Upload documentation to github pages

NOTE: This requires push permissions to the repository...

make gh-pages

Dependencies (6)

  1. camlzip
  2. rresult
  3. ocplib-endian
  4. jbuilder >= "1.0+beta13"
  5. astring
  6. ocaml >= "4.03.0"

Dev Dependencies (4)

  1. qcheck with-test & >= "0.7"
  2. odoc with-doc & >= "1.1.1"
  3. benchmark with-test & >= "1.4"
  4. alcotest with-test & >= "0.8.1"

Used by (1)

  1. quests

Conflicts

None

OCaml

Innovation. Community. Security.