piaf
  1. Overview
  2. Docs
package piaf
Legend:
Library
Module
Module type
Parameter
Class
Class type

Request Descriptor

type t
type error = [
  1. | `Bad_request
  2. | `Bad_gateway
  3. | `Internal_server_error
  4. | `Exn of exn
]
val request : t -> Request.t
val request_body : t -> [ `read ] Body.t
val response : t -> Response.t option
val response_exn : t -> Response.t

Responding

The following functions will initiate a response for the corresponding request in t. Depending on the state of the current connection, and the header values of the response, this may cause the connection to close or to persist for reuse by the client.

See RFC7230§6.3 for more details.

val respond_with_string : t -> Response.t -> string -> unit
val respond_with_bigstring : t -> Response.t -> Bigstringaf.t -> unit
val respond_with_streaming : ?flush_headers_immediately:bool -> t -> Response.t -> [ `write ] Body.t
val respond_with_upgrade : t -> Headers.t -> (unit -> unit) -> unit

Exception Handling

val error_code : t -> error option
val report_exn : t -> exn -> unit
val try_with : t -> (unit -> unit) -> (unit, exn) Result.result