package httpaf

  1. Overview
  2. Docs

Module Response.BodySource

Sourcetype t
Sourceval write_char : t -> char -> unit

write_char w char copies hcar into an internal buffer. If possible, this write will be combined with previous and/or subsequent writes before transmission.

Sourceval write_string : t -> ?off:int -> ?len:int -> string -> unit

write_string w ?off ?len str copies str into an internal buffer. If possible, this write will be combined with previous and/or subsequent writes before transmission.

Sourceval write_bigstring : t -> ?off:int -> ?len:int -> Bigstring.t -> unit

write_bigstring w ?off ?len bs copies bs into an internal buffer. If possible, this write will be combined with previous and/or subsequent writes before transmission.

Sourceval schedule_bigstring : t -> ?off:int -> ?len:int -> Bigstring.t -> unit

schedule_bigstring w ?off ?len bs schedules bs to be transmitted at the next opportunity without performing a copy. bs should not be modified until a subsequent call to flush has successfully completed.

Sourceval flush : t -> (unit -> unit) -> unit

flush t f

Sourceval close : t -> unit

close t closes t, causing subsequent read or write calls to raise.

Sourceval is_closed : t -> bool

is_closed t is true if close has been called on t and false otherwise. A closed t may still have pending output.