Module Gz.InfSource

Sourcetype decoder

The type for decoders.

Sourcetype src = [
  1. | `Channel of in_channel
  2. | `String of string
  3. | `Manual
]

The type for input sources. With a `Manual source the client must provide input with src. With `String or `Channel source the client can safely discard `Await case (with assert false).

Sourcetype signal = [
  1. | `Await of decoder
  2. | `Flush of decoder
  3. | `End of decoder
  4. | `Malformed of string
]
Sourceval decoder : src -> o:bigstring -> decoder

decoder src ~o is a decoder that inputs from src.

Output buffer.

gz, as de, uses o buffer as internal buffer to store output. We recommend to allocate an io_buffer_size buffer as output buffer. Then, dst_rem decoder tells you how many unused bytes remain in o.

Sourceval decode : decoder -> signal

decode d0 is:

  • `Await d1 if d0 has a `Manual input source and awaits for more input. The client must use a src with d1 to provide it.
  • `Flush d1 if given output buffer o (see decoder) needs to be drained before work can be resumed. The client must use flush with d1 to completely flush o. Usually o will be full and consist fully of bytes that need to be copied from the buffer, but sometimes only the first part of the buffer is used. In those cases dst_rem will give you the amount of free/unused bytes remain in o. These should not be copied since their contents are not part of the output. Instead, the first bigstring_length o - Inf.dst_rem d1 bytes should be copied when flushing o.
  • `Malformed err if given input is malformed. err is a human-readable error message.
  • `End d1 if given input notify end of flow. o is possibly not empty (it can be check with dst_rem).
Sourceval reset : decoder -> decoder

reset d is a d in its original state, as it was initialized by decoder.

Sourceval src : decoder -> bigstring -> int -> int -> decoder

src d s j l provides d with l bytes to read, starting at j in s. This byte range is read by calls to decode with d until `Await is returned. To signal the end of input call the function with l = 0.

Sourceval dst_rem : decoder -> int

dst_rem d is how many unused bytes remain in the output buffer of d.

Sourceval src_rem : decoder -> int

src_rem d is how many unprocessed bytes remain in the input buffer of d.

Sourceval write : decoder -> int

write d is how many bytes d emitted since it was created.

Sourceval flush : decoder -> decoder

flush d is a decoder where internal output buffer o is completely free to store bytes.

Sourceval filename : decoder -> string option

filename d returns the filename of the flow if it exists. This can be called anytime but should be called when the `End case appears (and ensure that the GZIP header was computed).

Sourceval comment : decoder -> string option

comment d returns the comment of the flow if it exists. This can be called anytime but should be called when the `End case appears (and ensure that the GZIP header was computed).

Sourceval os : decoder -> os

os d returns the os where the flow was compressed. It should be called when the `End case appears (and ensure that the GZIP header was computed).

Sourceval extra : key:string -> decoder -> string option

extra ~key d returns extra field key if it exists. This can be called anytime but should be called when the `End case appears (and ensure that the GZIP header was computed).