On This Page
package opium
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
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.
val is_safe : standard -> boolRequest 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 -> boolRequest 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 -> boolA 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.
Utilities
val to_string : t -> stringto_string t returns a string representation of the method t.
val of_string : string -> tof_string s returns a method from its string representation s.
val sexp_of_t : t -> Sexplib0.Sexp.tsexp_of_t t converts the request t to an s-expression
val pp : Format.formatter -> t -> unitpp formats the request t as an s-expression
On This Page