package irmin-http

  1. Overview
  2. Docs
HTTP client and server for Irmin

Install 

dune-project
 Dependency

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

Authors

  1. T
    Thomas Gazagnaire
  2. T
    Thomas Leonard

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-3.6.1.tbz
sha256=11fc2570bdbfd48478c89113fc801084a84a9a2c12d9bf8c64e05ce64ae19bd7
sha512=2171699ca24dec5c9c908a2676b272e034c14eb17f7052a794535e52af0be40be68a689e59c0a640ee244b11703320483f4d0c261542e6242ba23a8f1272b9b0

doc/irmin-http.unix/Irmin_http_unix/Http_client/IO/index.html

Module Http_client.IOSource

include Cohttp.S.IO with type 'a t = 'a Lwt.t with type 'a t = 'a Lwt.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.

Sourcetype ic

ic represents an input channel

Sourcetype oc

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.

Sourcetype error
Sourceval catch : (unit -> 'a t) -> ('a, error) result t

catch f is f () >|= Result.ok, unless f fails with an IO error, in which case it returns the error.

Sourceval pp_error : Format.formatter -> error -> unit