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.3.0.tbz
sha256=de149896939be13fedec46a4581121d5ab74850a2241d08e6aa8ae4bb18c52c4
sha512=324b4c2daef6ddaae2d28edcdadec8e29ebcc408eed2fed3fe4a3cb298cd78864d9ac939ae794c6ff8d9f5233a7cfa6feee62aa683ed3eb73f53ab8ea74cbffb

doc/decompress.lzo/Lzo/index.html

Module LzoSource

Sourcetype error = [
  1. | `Malformed of string
  2. | `Invalid_argument of string
  3. | `Invalid_dictionary
]
Sourceval pp_error : Format.formatter -> error -> unit
Sourceval uncompress : bigstring -> bigstring -> (bigstring, [> error ]) result

uncompress input output returns a sub-layout of output which is the inflated contents of input. Otherwise, it returns:

  • `Malformed if the input is not recognized as a LZO contents.
  • `Invalid_argument if output is not large enough to contain inflated contents.
  • `Invalid_dictionary if an op-code of input refers to an unbound location.
Sourceval uncompress_with_buffer : ?chunk:int -> bigstring -> (string, [> error ]) result

uncompress ?chunk input returns a fresh-allocated string which is the inflated contents of input. An internal Buffer.t is used and it can be initialized with chunk (default to 0x1000). Otherwise, it returns same errors as uncompress.

Sourcetype wrkmem

Type of an internal hash-table used by compress.

Sourceval make_wrkmem : unit -> wrkmem

make_wrkmem () returns a fresh-allocated wrkmem.

Sourceval compress : bigstring -> bigstring -> wrkmem -> int

compress input output wrkmem deflates input and produces a LZO contents into output. It uses wrkmem to do the deflation. It returns the number of bytes wrotes into output such as:

  let len = compress input output wrkmem in
  Bigarray.Array1.sub output 0 len

is the deflated contents of input.

  • raises Invalid_argument

    if output is not large enough to contain the deflated contents.