package cohttp-lwt-unix

  1. Overview
  2. Docs

Module Cohttp_lwt_unix.RequestSource

include module type of struct include Cohttp.Request end

This contains the metadata for a HTTP/1.1 request header, including the headers, version, meth and uri. The body is handled by the separate S module type, as it is dependent on the IO implementation.

The interface exposes a fieldslib interface which provides individual accessor functions for each of the records below. It also provides sexp serializers to convert to-and-from an Core.Std.Sexp.t.

include Cohttp.S.Request
Sourcetype t = Cohttp.Request.t = {
  1. headers : Cohttp.Header.t;
    (*

    HTTP request headers

    *)
  2. meth : Cohttp.Code.meth;
    (*

    HTTP request method

    *)
  3. resource : string;
    (*

    Request path and query

    *)
  4. version : Cohttp.Code.version;
    (*

    HTTP version, usually 1.1

    *)
  5. encoding : Cohttp.Transfer.encoding;
    (*

    transfer encoding of this HTTP request

    *)
}
Sourceval version : t -> Cohttp.Code.version
Sourceval resource : t -> string
Sourceval headers : t -> Cohttp.Header.t
include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval make : ?meth:Cohttp.Code.meth -> ?version:Cohttp.Code.version -> ?encoding:Cohttp.Transfer.encoding -> ?headers:Cohttp.Header.t -> Uri.t -> t

Return true whether the connection should be reused

Sourceval is_keep_alive : t -> bool

Return true whether the connection should be reused

Sourceval uri : t -> Uri.t
Sourceval make_for_client : ?headers:Cohttp.Header.t -> ?chunked:bool -> ?body_length:int64 -> Cohttp.Code.meth -> Uri.t -> t
Sourceval pp_hum : Format.formatter -> t -> unit

Human-readable output, used by the toplevel printer

Functor to construct the IO-specific HTTP request handling functions

include sig ... end
Sourcetype reader
Sourcetype writer
Sourcemodule IO : sig ... end
Sourceval read : IO.ic -> [ `Eof | `Invalid of string | `Ok of t ] IO.t
Sourceval has_body : t -> [ `No | `Unknown | `Yes ]
Sourceval make_body_writer : ?flush:bool -> t -> IO.oc -> writer
Sourceval make_body_reader : t -> IO.ic -> reader
Sourceval read_body_chunk : reader -> Cohttp.Transfer.chunk IO.t
Sourceval write_header : t -> IO.oc -> unit IO.t
Sourceval write_body : writer -> string -> unit IO.t
Sourceval write : ?flush:bool -> (writer -> unit IO.t) -> t -> IO.oc -> unit IO.t