package ezgzip
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=102046af4c64956656e9eb683e4066a5d05ccfefd7f12aaa02243bfeacc405f5
md5=6a0f8aa64541a32691f9884f0ef8737f
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: 05 Mar 2018
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