package cohttp-lwt

  1. Overview
  2. Docs

Module Private.String_ioSource

Lwt IO implementation that uses strings to marshal and unmarshal HTTP

IO interface that uses buf for input data and queues output data into a Buffer.t. Never actually blocks despite the Lwt use, although a future revision may yield when parsing large strings.

include Cohttp.S.IO with type 'a t = 'a Lwt.t and type ic = Cohttp.Private.String_io.buf and type oc = Buffer.t
Sourcetype 'a t = 'a Lwt.t

'a t represents a blocking monad state

Sourceval (>>=) : 'a t -> ('a -> 'b t) -> 'b t

a >>= b will pass the result of a to the b function. This is a monadic bind.

Sourceval return : 'a -> 'a t

return a will construct a constant IO value.

ic represents an input channel

Sourcetype oc = Buffer.t

oc represents an output channel

Sourcetype conn

conn represents the underlying network flow

Sourceval refill : ic -> [ `Ok | `Eof ] t
Sourceval with_input_buffer : ic -> f:(string -> pos:int -> len:int -> 'a * int) -> 'a
Sourceval read_line : ic -> string option t

read_line ic will read a single line terminated by CR or CRLF from the input channel ic. It returns None if EOF or other error condition is reached.

Sourceval read : ic -> int -> string t

read ic len will block until a maximum of len characters are read from the input channel ic. It returns an empty string if EOF or some other error condition occurs on the input channel, and can also return fewer than len characters if input buffering is not sufficient to satisfy the request.

Sourceval write : oc -> string -> unit t

write oc s will block until the complete s string is written to the output channel oc.

Sourceval flush : oc -> unit t

flush oc will return when all previously buffered content from calling write have been written to the output channel oc.