package ezgzip

  1. Overview
  2. Docs
On This Page
  1. gzip compression
# ezgzip - Simple gzip (de)compression library

Install 

dune-project
 Dependency

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

Authors

  1. H
    Hezekiah M. Carty <hez@0ok.org>

Maintainers

  1. H
    Hezekiah M. Carty <hez@0ok.org>

Sources

v0.2.1.tar.gz
sha256=102046af4c64956656e9eb683e4066a5d05ccfefd7f12aaa02243bfeacc405f5
md5=6a0f8aa64541a32691f9884f0ef8737f

doc/ezgzip/Ezgzip/index.html

Module EzgzipSource

gzip compression

Sourcetype error =
  1. | Truncated of string
    (*

    Extracted size is greater than the allowed maximum size

    *)
  2. | Invalid_format
    (*

    Invalid data format

    *)
  3. | Compression_error of string
    (*

    zlib error

    *)
  4. | Size of {
    1. got : int;
    2. expected : int;
    }
    (*

    Extracted size does not match what was expected based on the source metadata

    *)
  5. | Checksum
    (*

    Extracted content checksum does not match what was expected based on the source metadata

    *)

Possible error cases

Sourceval compress : ?level:int -> string -> string

compress src returns a gzip-compressed version of src.

  • parameter level

    can use used to set the compression level from 0 (no compression) to 9 (highest compression).

Sourceval decompress : ?ignore_size:bool -> ?ignore_checksum:bool -> ?max_size:int -> string -> (string, [> `Gzip of error ]) result

decompress src decompresses the content from the gzip-compressed src.

  • parameter ignore_size

    may be set to true if you want to ignore the expected decompressed size information in the gzip footer. Defaults to false.

  • parameter ignore_checksum

    may be set to true if you want to ignore the expected decompressed data checksum in the gzip footer. Defaults to false.

  • parameter max_size

    may be used to specify the maximum number of bytes to decompress. Defaults to Sys.max_string_length. If src decompresses to more than max_size bytes then this function will return Error (`Gzip (Truncated truncated_content)) containing the content which was decompressed.

  • returns

    Ok content if the decompression was successful

  • returns

    Error err if there was a problem during decompression

Sourceval pp_error : Format.formatter -> error -> unit
Sourceval pp_gzip_error : Format.formatter -> [ `Gzip of error ] -> unit
Sourcemodule Z : sig ... end