package dream-httpaf

You can search for identifiers within the package.

in-package search v0.2.0

dream-httpaf
- Dream_httpaf
  - Websocket
dream-httpaf.gluten
- Gluten
  - Client
  - RUNTIME
  - Reqd
  - Server
dream-httpaf.gluten-lwt
- Gluten_lwt
  - Client
    
    Io
  - IO
  - Server
    
    Io
dream-httpaf.gluten-lwt-unix
- Gluten_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
dream-httpaf.h2
- H2
  - Body
  - Client_connection
  - Config
  - Error_code
  - Headers
  - IOVec
  - Method
  - Reqd
  - Request
  - Response
  - Server_connection
  - Settings
  - Status
dream-httpaf.h2-lwt
- H2_lwt
  - Client
    
    Client_runtime
  - Server
    
    Server_runtime
dream-httpaf.h2-lwt-unix
- H2_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
dream-httpaf.hpack
- Hpack
  - Decoder
  - Encoder
dream-httpaf.httpaf
- Httpaf
  - Body
    
    Reader
    
    Writer
  - Client_connection
  - Config
  - Headers
  - IOVec
  - Method
  - Reqd
  - Request
    
    Body_length
  - Response
    
    Body_length
  - Server_connection
  - Status
  - Version
dream-httpaf.httpaf-lwt
- Httpaf_lwt
  - Client
    
    Client_runtime
  - Server
    
    Server_runtime
dream-httpaf.httpaf-lwt-unix
- Httpaf_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
dream-httpaf.websocketaf
- Websocketaf
  - Client_connection
  - Handshake
  - Payload
  - Server_connection
  - Websocket
    
    Close_code
    
    Frame
    
    Opcode
  - Wsd
dream-httpaf.websocketaf-lwt
- Websocketaf_lwt
  - Client
    
    Client_runtime
  - Server
    
    Server_runtime
dream-httpaf.websocketaf-lwt-unix
- Websocketaf_lwt_unix
  - Client
  - Server

Legend:
Library
Module
Module type
Parameter
Class
Class type

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.

type 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.
*)

]

type t = [

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

]

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

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

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

val to_string : t -> string

val of_string : string -> t

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