package tiny_httpd

  1. Overview
  2. Docs

Module Tiny_httpd_io.OutputSource

Output channel (byte sink)

Sourcetype t = {
  1. output_char : char -> unit;
    (*

    Output a single char

    *)
  2. output : bytes -> int -> int -> unit;
    (*

    Output slice

    *)
  3. flush : unit -> unit;
    (*

    Flush underlying buffer

    *)
  4. close : unit -> unit;
    (*

    Close the output. Must be idempotent.

    *)
}

An output channel, ie. a place into which we can write bytes.

This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.

Sourceval of_out_channel : ?close_noerr:??? -> out_channel -> t

of_out_channel oc wraps the channel into a Output.t.

  • parameter close_noerr

    if true, then closing the result uses close_out_noerr instead of close_out to close oc

Sourceval of_buffer : Buffer.t -> t

of_buffer buf is an output channel that writes directly into buf. flush and close have no effect.

Sourceval output_char : t -> char -> unit

Output the buffer slice into this channel

Sourceval output : t -> bytes -> int -> int -> unit

Output the buffer slice into this channel

Sourceval output_string : t -> string -> unit
Sourceval close : t -> unit

Close the channel.

Sourceval flush : t -> unit

Flush (ie. force write) any buffered bytes.

Sourceval output_buf : t -> Buf.t -> unit
Sourceval chunk_encoding : ?buf:??? -> close_rec:bool -> t -> t

chunk_encoding oc makes a new channel that outputs its content into oc in chunk encoding form.

  • parameter close_rec

    if true, closing the result will also close oc

  • parameter buf

    a buffer used to accumulate data into chunks. Chunks are emitted when buf's size gets over a certain threshold, or when flush is called.