package cohttp-lwt-unix

You can search for identifiers within the package.

in-package search v0.2.0

cohttp-lwt-unix
- Cohttp_lwt_unix
  - Client
  - Debug
  - IO
  - Net
    
    IO
  - Request
    
    IO
  - Response
    
    IO
  - Server
    
    IO

Legend:
Library
Module
Module type
Parameter
Class
Class type

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

type t = Cohttp.Request.t = {

headers : Cohttp.Header.t;
(*
HTTP request headers
*)
meth : Cohttp.Code.meth;
(*
HTTP request method
*)
scheme : string option;
(*
URI scheme (http or https)
*)
resource : string;
(*
Request path and query
*)
version : Cohttp.Code.version;
(*
HTTP version, usually 1.1
*)
encoding : Cohttp.Transfer.encoding;
(*
transfer encoding of this HTTP request
*)

}

include Sexplib0.Sexpable.S with type t := t

val t_of_sexp : Sexplib0__.Sexp.t -> t

val sexp_of_t : t -> Sexplib0__.Sexp.t

val headers : t -> Cohttp.Header.t

val meth : t -> Cohttp.Code.meth

val scheme : t -> string option

val resource : t -> string

val version : t -> Cohttp.Code.version

val encoding : t -> Cohttp.Transfer.encoding

val compare : t -> t -> int

val make : 
  ?meth:Cohttp.Code.meth ->
  ?version:Cohttp.Code.version ->
  ?encoding:Cohttp.Transfer.encoding ->
  ?headers:Cohttp.Header.t ->
  Uri.t ->
  t

val is_keep_alive : t -> bool

Return true whether the connection should be reused

val uri : t -> Uri.t

val make_for_client : 
  ?headers:Cohttp.Header.t ->
  ?chunked:bool ->
  ?body_length:int64 ->
  Cohttp.Code.meth ->
  Uri.t ->
  t

val pp_hum : Stdlib.Format.formatter -> t -> unit

Human-readable output, used by the toplevel printer

module Make = Cohttp.Request.Make

Functor to construct the IO-specific HTTP request handling functions

include sig ... end

type reader

type writer

module IO : sig ... end

val read : IO.ic -> [ `Eof | `Invalid of string | `Ok of t ] IO.t

val has_body : t -> [ `No | `Unknown | `Yes ]

val make_body_writer : ?flush:bool -> t -> IO.oc -> writer

val make_body_reader : t -> IO.ic -> reader

val read_body_chunk : reader -> Cohttp.Transfer.chunk IO.t

val write_header : t -> IO.oc -> unit IO.t

val write_body : writer -> string -> unit IO.t

val write : ?flush:bool -> (writer -> unit IO.t) -> t -> IO.oc -> unit IO.t