Skip to main content

Match

Enum Match 

Source
#[non_exhaustive]
pub enum Match { Found { handler: BoxHandler, params: HashMap<String, String>, }, MethodNotAllowed { allow: Vec<Method>, }, NotFound, BadPath, }
Expand description

The outcome of routing a (method, path) pair against the Router.

Returned by Router::route. The framework translates each variant into a response: Found runs the handler, MethodNotAllowed yields 405 with an Allow header, and NotFound yields 404.

use churust_core::{boxed, Call, IntoHandler, Router, Match};
use http::Method;

let mut router = Router::new();
router.add(Method::GET, "/users/{id}", boxed((|_c: Call| async { "ok" }).into_handler()));

match router.route(&Method::GET, "/users/7") {
    Match::Found { params, .. } => assert_eq!(params.get("id").unwrap(), "7"),
    _ => panic!("expected a match"),
}
assert!(matches!(router.route(&Method::GET, "/nope"), Match::NotFound));
assert!(matches!(router.route(&Method::POST, "/users/7"), Match::MethodNotAllowed { .. }));

Marked #[non_exhaustive]: a match on this enum outside churust-core must carry a _ arm, so that a future routing outcome is not a breaking change.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Found

A handler matched the path and method. Carries the matched handler and the captured path parameters ({name} -> value).

Fields

§handler: BoxHandler

The handler registered for this (path, method).

§params: HashMap<String, String>

The captured path parameters, keyed by name.

§

MethodNotAllowed

The path matched a route, but not for this method. allow lists the methods that are registered (used to build the Allow header).

Fields

§allow: Vec<Method>

The methods registered for the matched path.

§

NotFound

No route matched the path at all.

§

BadPath

A path segment could not be percent-decoded — a malformed escape or bytes that are not valid UTF-8. The dispatcher turns this into 400 Bad Request.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Match

§

impl !UnwindSafe for Match

§

impl Freeze for Match

§

impl Send for Match

§

impl Sync for Match

§

impl Unpin for Match

§

impl UnsafeUnpin for Match

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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