Struct actix_web::http::Method

source · [−]

pub struct Method(_);

Expand description

The Request Method (VERB)

This type also contains constants for a number of common HTTP methods such as GET, POST, etc.

Currently includes 8 variants representing the 8 methods defined in RFC 7230, plus PATCH, and an Extension variant for all extensions.

Examples

use http::Method;

assert_eq!(Method::GET, Method::from_bytes(b"GET").unwrap());
assert!(Method::GET.is_idempotent());
assert_eq!(Method::POST.as_str(), "POST");

Implementations

impl Method

pub const GET: Method = Method(Get)

GET

pub const POST: Method = Method(Post)

POST

pub const PUT: Method = Method(Put)

PUT

pub const DELETE: Method = Method(Delete)

DELETE

pub const HEAD: Method = Method(Head)

HEAD

pub const OPTIONS: Method = Method(Options)

OPTIONS

pub const CONNECT: Method = Method(Connect)

CONNECT

pub const PATCH: Method = Method(Patch)

PATCH

pub const TRACE: Method = Method(Trace)

TRACE

pub fn from_bytes(src: &[u8]) -> Result<Method, InvalidMethod>

Converts a slice of bytes to an HTTP method.

pub fn is_safe(&self) -> bool

Whether a method is considered “safe”, meaning the request is essentially read-only.

See the spec for more words.

pub fn is_idempotent(&self) -> bool

Whether a method is considered “idempotent”, meaning the request has the same result if executed multiple times.

See the spec for more words.

pub fn as_str(&self) -> &str

Return a &str representation of the HTTP method

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Method

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

Formats the value using the given formatter. Read more

impl Default for Method

fn default() -> Method

Returns the “default value” for a type. Read more

impl Display for Method

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

Formats the value using the given formatter. Read more

impl<'a> From<&'a Method> for Method

fn from(t: &'a Method) -> Method

Converts to this type from the input type.

impl FromRequest for Method

Extract the request’s method.

Examples

use actix_web::{http::Method, web, App, Responder};

async fn handler(method: Method) -> impl Responder {
    format!("Request method: {}", method)
}

let app = App::new().default_service(web::to(handler));

type Error = Infallible

The associated error which can be returned.

type Future = Ready<Result<Method, <Method as FromRequest>::Error>>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously. Read more

impl FromStr for Method

type Err = InvalidMethod

The associated error which can be returned from parsing.

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

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

impl Hash for Method

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl<'a> PartialEq<&'a Method> for Method

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl<'a> PartialEq<&'a str> for Method

fn eq(&self, other: &&'a str) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl PartialEq<Method> for Method

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl<'a> PartialEq<Method> for &'a Method

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl<'a> PartialEq<Method> for &'a str

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl PartialEq<Method> for str

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl PartialEq<str> for Method

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

impl<'a> TryFrom<&'a [u8]> for Method

type Error = InvalidMethod

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a str> for Method

type Error = InvalidMethod

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Method

impl StructuralEq for Method

impl StructuralPartialEq for Method

Auto Trait Implementations

impl RefUnwindSafe for Method

impl Send for Method

impl Sync for Method

impl Unpin for Method

impl UnwindSafe for Method

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more