include INFLATE with type error = error_g_inflate and type crc = Window.crc32type error = error_g_inflateInflate error.
type crc = Window.crc32The state of the inflate algorithm. 'i and 'o are the implementation used respectively for the input and the output, see Buffer.bytes and Buffer.bigstring. The typer considers than 'i = 'o.
val pp_error : Stdlib.Format.formatter -> error -> unitPretty-printer of inflate error.
val pp : Stdlib.Format.formatter -> ('i, 'o) t -> unitPretty-printer of inflate state.
val eval :
'a ->
'a ->
('a, 'a) t ->
[ `Await of ('a, 'a) t
| `Flush of ('a, 'a) t
| `End of ('a, 'a) t
| `Error of ('a, 'a) t * error ]eval i o t computes the state t with the input i and the output o. This function returns:
`Await t: the state t waits a new input, may be you use refill.`Flush t: the state t completes the output, may be you use flush.`End t: means that the deflate algorithm is done in your input. May be t writes something in your output. You can check with used_out.`Error (t, exn): the algorithm catches an error exn.refill off len t allows the state t to use an output at off on len byte(s).
flush off len t allows the state t to use an output at off on len byte(s).
val used_in : ('i, 'o) t -> intused_in t returns how many byte(s) was used by t in the input.
val used_out : ('i, 'o) t -> intused_out ŧ returns how many byte(s) was used by t in the output.
val write : ('i, 'o) t -> intwrite t returns the size of the stream decompressed.
val to_result :
'a ->
'a ->
('a -> int) ->
('a -> int -> int) ->
('a, 'a) t ->
(('a, 'a) t, error) Stdlib.resultto_result i o refill flush t is a convenience function to apply the inflate algorithm on the stream refill and call flush when the internal output is full (and need to flush).
If the compute catch an error, we returns Error exn (see INFLATE.error). Otherwise, we returns the state useless t.
val bytes :
Stdlib.Bytes.t ->
Stdlib.Bytes.t ->
(Stdlib.Bytes.t -> int) ->
(Stdlib.Bytes.t -> int -> int) ->
(Stdlib.Bytes.t, Stdlib.Bytes.t) t ->
((Stdlib.Bytes.t, Stdlib.Bytes.t) t, error) Stdlib.resultSpecialization of to_result with Buffer.Bytes.t.
val bigstring :
Buffer.Bigstring.t ->
Buffer.Bigstring.t ->
(Buffer.Bigstring.t -> int) ->
(Buffer.Bigstring.t -> int -> int) ->
(Buffer.Bigstring.t, Buffer.Bigstring.t) t ->
((Buffer.Bigstring.t, Buffer.Bigstring.t) t, error) Stdlib.resultSpecialization of to_result with Buffer.Bigstring.t.
val xfl : ('a, 'b) t -> intval mtime : ('a, 'b) t -> Optint.tval extra : ('a, 'b) t -> string optionval name : ('a, 'b) t -> string optionval comment : ('a, 'b) t -> string option