Struct pavex::blueprint::router::MethodGuard

source ·
pub struct MethodGuard { /* private fields */ }
Expand description

Used by Blueprint::route to specify which HTTP methods the route should match.

If you want to match a single HTTP method, use the dedicated constants in this module (GET, POST, PATCH, DELETE, etc.).
If you want to match a list of HTTP methods, use either MethodGuard::or or MethodGuard::from_iter.
If you want to match all well-known HTTP methods, use ANY.
If you want to match any HTTP method, including custom ones, use ANY_WITH_EXTENSIONS.

Implementations§

source§

impl MethodGuard

source

pub fn from_iter(allowed_methods: impl IntoIterator<Item = Method>) -> Self

Build a new MethodGuard that matches incoming requests using the given HTTP methods.

use pavex::blueprint::router::{MethodGuard, GET, POST};
use pavex::http::Method;

// Using an array of methods known at compile-time..
let guard = MethodGuard::from_iter([Method::GET, Method::POST]);
// ..or a dynamic vector, built at runtime.
let guard = MethodGuard::from_iter(vec![Method::GET, Method::PUT]);

// As an alternative, you can use the `or` method to combine two or more `MethodGuard`s.
// It's usually shorter and more readable.
let guard = GET.or(POST);

If you want to match any HTTP method, use ANY.
If you want to match a single HTTP method, use the dedicated constants in this module (GET, POST, PATCH, DELETE, etc.).

source

pub fn or(self, other: MethodGuard) -> Self

Combine this MethodGuard with another one, returning a new MethodGuard.

The returned MethodGuard will match requests that match either of the two MethodGuards.

use pavex::blueprint::router::{GET, POST};

// Match requests that use either the `GET` or the `POST` HTTP method.
let guard = GET.or(POST);
source

pub fn allows(&self, method: &Method) -> bool

Returns true if the given HTTP method is allowed by this MethodGuard.

source

pub fn allowed_methods(&self) -> AllowedMethods

Return the methods allowed by this MethodGuard.

Trait Implementations§

source§

impl Clone for MethodGuard

source§

fn clone(&self) -> MethodGuard

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
source§

impl Debug for MethodGuard

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for MethodGuard

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<Method> for MethodGuard

source§

fn from(val: Method) -> Self

Converts to this type from the input type.
source§

impl Serialize for MethodGuard

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

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
source§

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

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.

source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

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

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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

The type returned in the event of a conversion error.
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
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,