Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Module Gz
GZIP layer.
GZIP is a standard on top of RFC1951 according RFC1952. It uses the De implementation with the LZ77 compression algorithm. Module provides non-blocking streaming codec to decode and encode GZIP encoding. It can efficiently work payload by payload without blocking IO.
equal_os a b returns true if a is exactly the same os than b. Otherwise, it returns false.
GZIP Decoder.
Unlike de, gz provides a referentially transparent Inf.decoder. The client must use a Inf.decoder given byInf.decode instead of a decoder given toInf.decode. A common use of gz is:
let rec go d0 = match Inf.decode d0 with
| `Await d1 -> ... go d1
| `Flush d1 -> ... go d1
| _ -> .... in
GZIP encoder is glue between the LZ77 algorithm and the DEFLATE encoder, prefixed with a GZIP header. Any deal with compression algorithm is not possible on this layer (see De for more details). As Inf, and unlike De, Gz provides a referentially transparent encoder.