package cohttp-async

You can search for identifiers within the package.

in-package search v0.2.0

CoHTTP implementation for the Async concurrency library

Install

dune-project

Dependency

github.com Readme Changelog ISC License Edit opam file Versions (12)

Authors

Maintainers

A

anil@recoil.org

Sources

cohttp-v2.4.0.tbz

sha256=b2dc17836e7dd5803bb919aff5dde1b9a071becb874c8a4afc81b2a466c792f4

sha512=73a5ef380ea6aad421870b526e5e1305ad0a0d14cee7ca7fdbf5a94f878c66bc91a9f7c30327caaf235f3e55c678299ad55645ef2899e11b137efb6ecfc5d0be

doc/cohttp-async/Cohttp_async/Io/index.html

Module `Cohttp_async.Io`

include Cohttp.S.IO
  with type 'a t = 'a Async_kernel.Deferred.t
   and type ic = Async_unix.Reader.t
   and type oc = Async_unix.Writer.t

type 'a t = 'a Async_kernel.Deferred.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 = Async_unix.Reader.t

ic represents an input channel

type oc = Async_unix.Writer.t

oc represents an output channel

type conn

conn represents the underlying network flow

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.