Enum rocket::http::Method

pub enum Method {
    Get,
    Put,
    Post,
    Delete,
    Options,
    Head,
    Trace,
    Connect,
    Patch,
}

Representation of HTTP methods.

(De)serialization

Method is both Serialize and Deserialize, represented as an uncased string. For example, Method::Get serializes to "GET" and deserializes from any casing of "GET" including "get", "GeT", and "GET".

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

#[derive(Deserialize, Serialize)]
struct Foo {
    method: Method,
}

Variants

Get

The GET variant.

Put

The PUT variant.

Post

The POST variant.

Delete

The DELETE variant.

Options

The OPTIONS variant.

Head

The HEAD variant.

Trace

The TRACE variant.

Connect

The CONNECT variant.

Patch

The PATCH variant.

Implementations

impl Method

pub fn supports_payload(self) -> bool

Returns true if an HTTP request with the method represented by self always supports a payload.

The following methods always support payloads:

• PUT, POST, DELETE, PATCH

The following methods do not always support payloads:

• GET, HEAD, CONNECT, TRACE, OPTIONS

Example

use rocket::http::Method;

assert_eq!(Method::Get.supports_payload(), false);
assert_eq!(Method::Post.supports_payload(), true);

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

Returns the string representation of self.

Example

use rocket::http::Method;

assert_eq!(Method::Get.as_str(), "GET");

Trait Implementations

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 = ()

The associated error which can be returned from parsing.

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

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 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<'a> 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 Copy for Method

impl Eq for Method

impl StructuralPartialEq for Method