package ezgzip

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

Install

Dune Dependency

Authors

Maintainers

Sources

ezgzip-v0.2.3.tbz
sha256=8868eedb98f83b2d53f091a827db9b7a5b4e9ba538bbc080c91b4ac4baf679d4
sha512=766d6974057eba53e324f4299af378015024595c8e43bd0f68df5fbb33d98b42b12f7c8a6b815296d74df8eebaf969d79e7244697b918ea7b6a0b5e6f0562d77

Description

ezgzip - Simple gzip (de)compression library

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: 27 Jun 2019

README

ezgzip - Simple gzip (de)compression library

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.

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

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