Enum pavex::router::AllowedMethods

source ·
pub enum AllowedMethods {
    Some(MethodAllowList),
    All,
}
Expand description

The set of HTTP methods that are allowed for a given path.

§Example

use pavex::router::AllowedMethods;
use pavex::response::Response;
use pavex::http::header::{ALLOW, HeaderValue};
use itertools::Itertools;

/// A fallback handler that returns a `404 Not Found` if the request path
/// doesn't match any of the registered routes, or a `405 Method Not Allowed`
/// if the request path matches a registered route but there is no handler
/// for its HTTP method.
pub async fn fallback(allowed_methods: AllowedMethods) -> Response {
    if let Some(header_value) = allowed_methods.allow_header_value() {
        Response::method_not_allowed()
            .insert_header(ALLOW, header_value)
    } else {
        Response::not_found()
    }
}

§Framework primitive

AllowedMethods is a framework primitive—you don’t need to register any constructor with Blueprint to use it in your application.

§Use cases

AllowedMethods comes into the play when implementing fallback handlers: it is necessary to set the Allow header to the correct value when returning a 405 Method Not Allowed response after a routing failure.

Variants§

§

Some(MethodAllowList)

Only a finite set of HTTP methods are allowed for a given path.

§

All

All HTTP methods are allowed for a given path, including custom ones.

Implementations§

source§

impl AllowedMethods

source

pub fn allow_header_value(&self) -> Option<HeaderValue>

The value that should be set for the Allow header in a 405 Method Not Allowed response for this route path.

It returns None if all methods are allowed.
It returns the comma-separated list of accepted HTTP methods otherwise.

Trait Implementations§

source§

impl Clone for AllowedMethods

source§

fn clone(&self) -> AllowedMethods

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 AllowedMethods

source§

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

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

impl From<MethodAllowList> for AllowedMethods

source§

fn from(methods: MethodAllowList) -> Self

Converts to this type from the input type.

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