package decompress

You can search for identifiers within the package.

in-package search v0.2.0

Implementation of Zlib and GZip in OCaml

Install

dune-project

Dependency

github.com Edit opam file Versions (17)

Authors

R

Romain Calascibetta <romain.calascibetta@gmail.com>

Maintainers

R

Romain Calascibetta <romain.calascibetta@gmail.com>

Sources

decompress-1.6.0.tbz

sha256=aa2e842dc009bcddcbb5c0791f5dbeee2bda5a104ecc7681aa37ac42537e3121

sha512=58e2529fa93f4f671ffd0a69c3542e835868f8c72db9c62b48d207c31f3585101d4d314f7e5922b273c86609b00c87343987b03b568d3e69749d2c7f7fa4089b

doc/decompress.lzo/Lzo/index.html

Module `Lzo`Source

Source

type bigstring =
  (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t

Sourcetype error = [

| `Malformed of string
| `Invalid_argument of string
| `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.

Source

val 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.