package cohttp-lwt

You can search for identifiers within the package.

in-package search v0.2.0

cohttp-lwt
- Cohttp_lwt
  - Body
  - Client
    
    Make
    
    Connection
    
    Net
    
    IO
  - Connection
    
    Make
    
    Net
    
    IO
  - Connection_cache
    
    Make
    
    Connection
    
    Net
    
    IO
    
    Sleep
    
    Make_no_cache
    
    Connection
    
    Net
    
    IO
  - Make_client
    
    IO
    
    Net
  - Private
    
    Bytebuffer
    
    String_io
  - S
    
    Client
    
    Connection
    
    Net
    
    IO
    
    Connection_cache
    
    IO
    
    Net
    
    IO
    
    Server
    
    IO
    
    Sleep
  - Server
    
    Make
    
    IO

Legend:
Library
Module
Module type
Parameter
Class
Class type

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 = Stdlib.Buffer.t

type 'a t = 'a Lwt.t

'a t represents a blocking monad state

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

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

val return : 'a -> 'a t

return a will construct a constant IO value.

type ic = Cohttp.Private.String_io.buf

ic represents an input channel

type oc = Stdlib.Buffer.t

oc represents an output channel

type conn

conn represents the underlying network flow

val refill : ic -> [ `Ok | `Eof ] t

val with_input_buffer : 
  ic ->
  f:(string -> pos:int -> len:int -> 'a * int) ->
  'a

val 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.

val 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.

val write : oc -> string -> unit t

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

val flush : oc -> unit t

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