package piaf

You can search for identifiers within the package.

in-package search v0.2.0

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

Install

Dune Dependency

github.com Readme Changelog 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.h2/H2/Method/index.html

Module `H2.Method`Source

Request Method

The request method token is the primary source of request semantics; it indicates the purpose for which the client has made this request and what is expected by the client as a successful result.

See RFC7231§4 for more details.

This module is a proxy to Httpaf.Method and is included in h2 for convenience.

Request Method

The request method token is the primary source of request semantics; it indicates the purpose for which the client has made this request and what is expected by the client as a successful result.

See RFC7231§4 for more details.

Sourcetype standard = [

| `GET
(*
RFC7231§4.3.1. Safe, Cacheable.
*)
| `HEAD
(*
RFC7231§4.3.2. Safe, Cacheable.
*)
| `POST
(*
RFC7231§4.3.3. Cacheable.
*)
| `PUT
(*
RFC7231§4.3.4. Idempotent.
*)
| `DELETE
(*
RFC7231§4.3.5. Idempotent.
*)
| `CONNECT
(*
RFC7231§4.3.6.
*)
| `OPTIONS
(*
RFC7231§4.3.7. Safe.
*)
| `TRACE
(*
RFC7231§4.3.8. Safe.
*)

]

Sourcetype t = [

| standard
| `Other of string
(*
Methods defined outside of RFC7231, or custom methods.
*)

]

Sourceval is_safe : standard -> bool

Request methods are considered "safe" if their defined semantics are essentially read-only; i.e., the client does not request, and does not expect, any state change on the origin server as a result of applying a safe method to a target resource. Likewise, reasonable use of a safe method is not expected to cause any harm, loss of property, or unusual burden on the origin server.

See RFC7231§4.2.1 for more details.

Sourceval is_cacheable : standard -> bool

Request methods can be defined as "cacheable" to indicate that responses to them are allowed to be stored for future reuse.

See RFC7234 for more details.

Sourceval is_idempotent : standard -> bool

A request method is considered "idempotent" if the intended effect on the server of multiple identical requests with that method is the same as the effect for a single such request. Of the request methods defined by this specification, PUT, DELETE, and safe request methods are idempotent.

See RFC7231§4.2.2 for more details.

Sourceval to_string : t -> string

Sourceval of_string : string -> t

Sourceval pp_hum : Format.formatter -> t -> unit