package piaf

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Request Descriptor
1. Exception Handling

An HTTP library with HTTP/2 support written entirely in OCaml

Install

dune-project

Dependency

github.com Edit opam file Versions (2)

Authors

A

Antonio Monteiro <anmonteiro@gmail.com>

Maintainers

A

Antonio Monteiro <anmonteiro@gmail.com>

Sources

piaf-0.1.0.tbz

sha256=00c3bea6d1a8c77dc18bbbbf1f449a78253cf17391ad153751b2e87f71307265

sha512=0f35e88b78ec1f1cd06a972ee69e29a8983b4c07dbc0268cc9764d8df5d9c2402cc3710874f54a111095fb57a08fe582d99d1b7e070e141e260af6ced50172aa

doc/piaf.httpaf/Httpaf/Reqd/index.html

Module `Httpaf.Reqd`Source

Request Descriptor

Sourcetype t

Sourcetype error = [

| `Bad_request
| `Bad_gateway
| `Internal_server_error
| `Exn of exn

]

Sourceval request : t -> Request.t

Sourceval request_body : t -> [ `read ] Body.t

Sourceval response : t -> Response.t option

Sourceval 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.

Sourceval respond_with_string : t -> Response.t -> string -> unit

Sourceval respond_with_bigstring : t -> Response.t -> Bigstringaf.t -> unit

Source

val respond_with_streaming : 
  ?flush_headers_immediately:bool ->
  t ->
  Response.t ->
  [ `write ] Body.t

Sourceval respond_with_upgrade : t -> Headers.t -> (unit -> unit) -> unit

Exception Handling

Sourceval error_code : t -> error option

Sourceval report_exn : t -> exn -> unit

Sourceval try_with : t -> (unit -> unit) -> (unit, exn) Result.result