Enum rocket::http::Method

#[non_exhaustive]
pub enum Method {
    Get,
    Head,
    Post,
    Put,
    Delete,
    Connect,
    Options,
    Trace,
    Patch,
    Acl,
    BaselineControl,
    Bind,
    CheckIn,
    CheckOut,
    Copy,
    Label,
    Link,
    Lock,
    Merge,
    MkActivity,
    MkCalendar,
    MkCol,
    MkRedirectRef,
    MkWorkspace,
    Move,
    OrderPatch,
    PropFind,
    PropPatch,
    Rebind,
    Report,
    Search,
    Unbind,
    Uncheckout,
    Unlink,
    Unlock,
    Update,
    UpdateRedirectRef,
    VersionControl,
}

An HTTP method.

Each variant corresponds to a method in the HTTP Method Registry. The string form of the method can be obtained via Method::as_str() and parsed via the FromStr or TryFrom<&[u8]> implementations. The parse implementations parse both the case-sensitive string form as well as a lowercase version of the string, but not mixed-case versions.

(De)Serialization

Method is both Serialize and Deserialize.

• Method serializes as the specification-defined string form of the method, equivalent to the value returned from Method::as_str().
• Method deserializes from method’s string form or from a lowercased string, equivalent to the FromStr implementation.

For example, Method::Get serializes to "GET" and deserializes from either "GET" or "get" but not "GeT".

use rocket::http::Method;
use rocket::serde::{Serialize, Deserialize};

#[derive(Deserialize, Serialize)]
#[serde(crate = "rocket::serde")]
struct Foo {
    method: Method,
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Get

The GET method. Defined in RFC9110 §9.3.1.

• safe: yes
• idempotent: yes
• request body: maybe

Head

The HEAD method. Defined in RFC9110 §9.3.2.

• safe: yes
• idempotent: yes
• request body: maybe

Post

The POST method. Defined in RFC9110 §9.3.3.

• safe: no
• idempotent: no
• request body: yes

Put

The PUT method. Defined in RFC9110 §9.3.4.

• safe: no
• idempotent: yes
• request body: yes

Delete

The DELETE method. Defined in RFC9110 §9.3.5.

• safe: no
• idempotent: yes
• request body: maybe

Connect

The CONNECT method. Defined in RFC9110 §9.3.6.

• safe: no
• idempotent: no
• request body: maybe

Options

The OPTIONS method. Defined in RFC9110 §9.3.7.

• safe: yes
• idempotent: yes
• request body: maybe

Trace

The TRACE method. Defined in RFC9110 §9.3.8.

• safe: yes
• idempotent: yes
• request body: no

Patch

The PATCH method. Defined in RFC5789 §2.

• safe: no
• idempotent: no
• request body: yes

Acl

The ACL method. Defined in RFC3744 §8.1.

• safe: no
• idempotent: yes
• request body: yes

BaselineControl

The BASELINE-CONTROL method. Defined in RFC3253 §12.6.

• safe: no
• idempotent: yes
• request body: yes

Bind

The BIND method. Defined in RFC5842 §4.

• safe: no
• idempotent: yes
• request body: yes

CheckIn

The CHECKIN method. Defined in RFC3253 §4.4.

• safe: no
• idempotent: yes
• request body: yes

CheckOut

The CHECKOUT method. Defined in RFC3253 §4.3.

• safe: no
• idempotent: yes
• request body: maybe

Copy

The COPY method. Defined in RFC4918 §9.8.

• safe: no
• idempotent: yes
• request body: maybe

Label

The LABEL method. Defined in RFC3253 §8.2.

• safe: no
• idempotent: yes
• request body: yes

Link

The LINK method. Defined in RFC2068 §19.6.1.2.

• safe: no
• idempotent: yes
• request body: maybe

Lock

The LOCK method. Defined in RFC4918 §9.10.

• safe: no
• idempotent: no
• request body: yes

Merge

The MERGE method. Defined in RFC3253 §11.2.

• safe: no
• idempotent: yes
• request body: yes

MkActivity

The MKACTIVITY method. Defined in RFC3253 §13.5.

• safe: no
• idempotent: yes
• request body: yes

MkCalendar

The MKCALENDAR method. Defined in RFC4791 §5.3.1, RFC8144 §2.3.

• safe: no
• idempotent: yes
• request body: yes

MkCol

The MKCOL method. Defined in RFC4918 §9.3, RFC5689 §3, RFC8144 §2.3.

• safe: no
• idempotent: yes
• request body: yes

MkRedirectRef

The MKREDIRECTREF method. Defined in RFC4437 §6.

• safe: no
• idempotent: yes
• request body: yes

MkWorkspace

The MKWORKSPACE method. Defined in RFC3253 §6.3.

• safe: no
• idempotent: yes
• request body: yes

Move

The MOVE method. Defined in RFC4918 §9.9.

• safe: no
• idempotent: yes
• request body: maybe

OrderPatch

The ORDERPATCH method. Defined in RFC3648 §7.

• safe: no
• idempotent: yes
• request body: yes

PropFind

The PROPFIND method. Defined in RFC4918 §9.1, RFC8144 §2.1.

• safe: yes
• idempotent: yes
• request body: yes

PropPatch

The PROPPATCH method. Defined in RFC4918 §9.2, RFC8144 §2.2.

• safe: no
• idempotent: yes
• request body: yes

Rebind

The REBIND method. Defined in RFC5842 §6.

• safe: no
• idempotent: yes
• request body: yes

Report

The REPORT method. Defined in RFC3253 §3.6, RFC8144 §2.1.

• safe: yes
• idempotent: yes
• request body: yes

Search

The SEARCH method. Defined in RFC5323 §2.

• safe: yes
• idempotent: yes
• request body: yes

Unbind

The UNBIND method. Defined in RFC5842 §5.

• safe: no
• idempotent: yes
• request body: yes

Uncheckout

The UNCHECKOUT method. Defined in RFC3253 §4.5.

• safe: no
• idempotent: yes
• request body: maybe

Unlink

The UNLINK method. Defined in RFC2068 §19.6.1.3.

• safe: no
• idempotent: yes
• request body: maybe

Unlock

The UNLOCK method. Defined in RFC4918 §9.11.

• safe: no
• idempotent: yes
• request body: maybe

Update

The UPDATE method. Defined in RFC3253 §7.1.

• safe: no
• idempotent: yes
• request body: yes

UpdateRedirectRef

The UPDATEREDIRECTREF method. Defined in RFC4437 §7.

• safe: no
• idempotent: yes
• request body: yes

VersionControl

The VERSION-CONTROL method. Defined in RFC3253 §3.5.

• safe: no
• idempotent: yes
• request body: yes

Implementations

impl Method

pub const fn is_safe(&self) -> bool

Whether the method is considered “safe”.

From RFC9110 §9.2.1:

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. Of the request methods defined by this specification, the GET, HEAD, OPTIONS, and TRACE methods are defined to be safe.

Example

use rocket::http::Method;

assert!(Method::Get.is_safe());
assert!(Method::Head.is_safe());

assert!(!Method::Put.is_safe());
assert!(!Method::Post.is_safe());

pub const fn is_idempotent(&self) -> bool

Whether the method is considered “idempotent”.

From RFC9110 §9.2.2:

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.

Example

use rocket::http::Method;

assert!(Method::Get.is_idempotent());
assert!(Method::Head.is_idempotent());
assert!(Method::Put.is_idempotent());

assert!(!Method::Post.is_idempotent());
assert!(!Method::Patch.is_idempotent());

pub const fn allows_request_body(self) -> Option<bool>

Whether requests with this method are allowed to have a body.

Returns:

• Some(true) if a request body is always allowed.
• Some(false) if a request body is never allowed.
• None if a request body is discouraged or has no defined semantics.

Example

use rocket::http::Method;

assert_eq!(Method::Post.allows_request_body(), Some(true));
assert_eq!(Method::Put.allows_request_body(), Some(true));

assert_eq!(Method::Trace.allows_request_body(), Some(false));

assert_eq!(Method::Get.allows_request_body(), None);
assert_eq!(Method::Head.allows_request_body(), None);

pub const fn as_str(self) -> &'static str

Returns the method’s string representation.

Example

use rocket::http::Method;

assert_eq!(Method::Get.as_str(), "GET");
assert_eq!(Method::Put.as_str(), "PUT");
assert_eq!(Method::BaselineControl.as_str(), "BASELINE-CONTROL");

pub const fn as_ref(self) -> &'static Method

Returns a static reference to the method.

Example

use rocket::http::Method;

assert_eq!(Method::Get.as_ref(), &Method::Get);

impl Method

pub const fn supports_payload(self) -> bool

👎Deprecated since 0.6.0: use Self::allows_request_body()

Deprecated. Returns self.allows_request_body() == Some(true).

Use Method::allows_request_body() instead.

Trait Implementations

impl AsRef<str> for Method

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Method

fn clone(&self) -> Method

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Method

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Method

fn deserialize<D>( deserializer: D, ) -> Result<Method, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Method

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'r> FromRequest<'r> for Method

type Error = Infallible

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>( request: &'r Request<'life0>, ) -> Pin<Box<dyn Future<Output = Outcome<Self, Infallible>> + Send + 'async_trait>>

where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,

Derives an instance of Self from the incoming request metadata.

impl FromStr for Method

type Err = ParseMethodError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Method, <Method as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Method

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<&Method> for Method

fn eq(&self, other: &&Method) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Method> for &Method

fn eq(&self, other: &Method) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Method

fn eq(&self, other: &Method) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Method

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Method

type Error = ParseMethodError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Method, <Method as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl TryFrom<&str> for Method

type Error = ParseMethodError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Method, <Method as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for Method

impl Eq for Method

impl StructuralPartialEq for Method