Struct Method 

pub struct Method(/* private fields */);

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

GET

pub const POST: Method

POST

pub const PUT: Method

PUT

pub const DELETE: Method

DELETE

pub const HEAD: Method

HEAD

pub const OPTIONS: Method

OPTIONS

pub const CONNECT: Method

CONNECT

pub const PATCH: Method

PATCH

pub const TRACE: Method

TRACE

pub const QUERY: Method

QUERY

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 duplicate 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 Default for Method

fn default() -> Method

Returns the “default value” for a type.

impl Display for Method

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

Formats the value using the given formatter.

impl Eq for Method

impl From<&Method> for Method

fn from(t: &Method) -> Method

Converts to this type from the input type.

impl FromRequestParts for Method

The request method.

async fn from_request_parts(parts: &mut Parts) -> Result<Self, ApiError>

Perform the extraction.

const BACKGROUND_TASKS: bool = false

Whether extraction needs a request-owned background queue. Custom wrappers delegating to BackgroundTasks must propagate this.

fn describe(_op: &mut Operation, _registry: &mut SchemaRegistry)

Document this extractor on op (parameters, security, …).

impl<S> FromRequestParts<S> for Method

where S: Send + Sync,

type Rejection = Infallible

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, _: &S, ) -> Result<Method, <Method as FromRequestParts<S>>::Rejection>

Perform the extraction.

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.

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 Ord for Method

fn cmp(&self, other: &Method) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Method

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&Method> for Method

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for Method

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Method> for &Method

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for Method

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Method

fn partial_cmp(&self, other: &Method) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Method

impl TryFrom<&[u8]> for Method

type Error = InvalidMethod

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for Method

type Error = InvalidMethod

The type returned in the event of a conversion error.

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

Performs the conversion.