package shuttle_http

  1. Overview
  2. Docs

Module Shuttle_http.MethSource

Sourcetype t = [
  1. | `GET
  2. | `HEAD
  3. | `POST
  4. | `PUT
  5. | `DELETE
  6. | `CONNECT
  7. | `OPTIONS
  8. | `TRACE
  9. | `PATCH
]

Request method is used to indicate the purpose of a HTTP request.

See https://datatracker.ietf.org/doc/html/rfc7231#section-4.3 for more details.

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval __t_of_sexp__ : Sexplib0.Sexp.t -> t
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval hash_fold_t : t Base__Ppx_hash_lib.hash_fold
Sourceval hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value
include Ppx_enumerate_lib.Enumerable.S with type t := t
Sourceval all : t list
include Ppx_quickcheck_runtime.Quickcheckable.S with type t := t
Sourceval quickcheck_generator : t Base_quickcheck.Generator.t
Sourceval quickcheck_observer : t Base_quickcheck.Observer.t
Sourceval quickcheck_shrinker : t Base_quickcheck.Shrinker.t
Sourceval of_string : string -> t option
Sourceval to_string : t -> string
Sourceval is_safe : t -> bool

is_safe t returns true if the semantics for a HTTP method are essentially read-only, and the client does not expect any state change on the server as a result of the request.

See https://datatracker.ietf.org/doc/html/rfc7231#section-4.2.1 for more details.

Sourceval is_idempotent : t -> bool

is_idempotent t returns true if multiple requests with a HTTP method are intended to have the same effect on the server as a single such request. This function returns true for PUT, DELETE and all safe methods.

See https://datatracker.ietf.org/doc/html/rfc7231#section-4.2.2 for more details.

Sourceval is_cacheable : t -> bool

is_cacheable t indicates that responses to requests with an HTTP method are allowed to be strored for future reuse. This function returns true for GET, HEAD and POST.

See https://datatracker.ietf.org/doc/html/rfc7231#section-4.2.3 for more details.

include Core.Comparable.S with type t := t
include Base.Comparable.S with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

val clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
type comparator_witness
val comparator : (t, comparator_witness) Base__.Comparator.comparator
Sourceval validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
Sourceval validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
Sourceval validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
Sourcemodule Replace_polymorphic_compare : Base.Comparable.Comparisons with type t := t