package ezgzip

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

gzip compression

type error =

| Truncated of string
(*
Extracted size is greater than the allowed maximum size
*)
| Invalid_format
(*
Invalid data format
*)
| Compression_error of string
(*
zlib error
*)
| Size of {
1. got : int;
2. expected : int;
}
(*
Extracted size does not match what was expected based on the source metadata
*)
| Checksum
(*
Extracted content checksum does not match what was expected based on the source metadata
*)

Possible error cases

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

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

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

val pp_gzip_error : Format.formatter -> [ `Gzip of error ] -> unit

module Z : sig ... end