package decompress

  1. Overview
  2. Docs
Implementation of Zlib and GZip in OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (16)

Authors

  1. R
    Romain Calascibetta <romain.calascibetta@gmail.com>

Maintainers

  1. R
    Romain Calascibetta <romain.calascibetta@gmail.com>

Sources

decompress-v1.4.1.tbz
sha256=0130ea6acb61b0a25393fa23148e116d7a17c77558196f7abddaee9e05a1d7a8
sha512=1668df538fba7c96574146a18fcbeef5200ea0e36110ec94c9b9924e368f465447702029fdb00d2749ca55081169b0e7c74e2f0887e4367ec580633e1e2a1c6c

doc/decompress.de/De/Inf/Ns/index.html

Module Inf.NsSource

A non-streamable implementation of the RFC 1951. It considers the input to be whole and is therefore able to save some time

Sourcetype error = [
  1. | `Unexpected_end_of_input
  2. | `Unexpected_end_of_output
  3. | `Invalid_kind_of_block
  4. | `Invalid_dictionary
  5. | `Invalid_complement_of_length
  6. | `Invalid_distance
  7. | `Invalid_distance_code
]

The type for inflation errors.

Sourceval pp_error : Format.formatter -> error -> unit

Pretty-printer of error.

Sourceval inflate : bigstring -> bigstring -> (int * int, [> error ]) result

inflate src dst w inflates the content of src into dst.

In case of sucess, it returns the bytes read and the bytes writen in an Ok result. In case of failure, it returns the error in an Error result. We assume that src is well formed and dst is enough larger to store the result of the inflation. The usual worst case is when dst must be equal (in size) or larger than src. Such case appears for really small objects and in that case, we returns Error `Unexpected_end_of_output.