package decompress

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

Install 

dune-project
 Dependency

github.com Edit opam file Versions (17)

Authors

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

Maintainers

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

Sources

decompress-1.6.0.tbz
sha256=aa2e842dc009bcddcbb5c0791f5dbeee2bda5a104ecc7681aa37ac42537e3121
sha512=58e2529fa93f4f671ffd0a69c3542e835868f8c72db9c62b48d207c31f3585101d4d314f7e5922b273c86609b00c87343987b03b568d3e69749d2c7f7fa4089b

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.