Stream represents streaming HTTP bodies. This module provides utilities to create and consume streams, while enforcing the invariant that only one consume can read from a stream, and that a stream can only be consumed once.
val sexp_of_t : t -> Sexplib0.Sexp.tval of_pipe : [ `Chunked | `Fixed of int ] -> string Async.Pipe.Reader.t -> tof_pipe is a convenience function that creates a stream from a user provided Async_kernel.Pipe.Reader.t. The pipe will be closed whenever the streaming body is closed, or EOF is reached.
val close : t -> unitclose allows for closing/tearing-down any resources that are used to produce the content for a stream. For servers, this function will be called if the underlying client socket connection is closed, or when the body is fully drained.
val encoding : t -> [ `Chunked | `Fixed of int ]encoding informs whether the body needs to be chunk encoded or not. For servers this function is used to automatically populate the transfer-encoding or content-length headers.
val iter : t -> f:(string -> unit Async.Deferred.t) -> unit Async.Deferred.titer t ~f consumes chunks of data one at a time. The stream can only be iterated on once.
val fold :
t ->
init:'a ->
f:('a -> string -> 'a Async.Deferred.t) ->
'a Async.Deferred.tval drain : t -> unit Async.Deferred.tdrain should consume items one at a time from the stream and discard them. This function raises if its called after a consumer has started reading data from the stream.
val closed : t -> unit Async.Deferred.tclosed is a deferred that should be resolved when the stream is closed/drained.
val read_started : t -> boolread_started indicated whether a user started to consume a stream or not. Servers will use read_started to verify if they should drain before starting the next cycle of the server loop, or if they should wait for the body to be closed by the user.