Struct Router

Source
pub struct Router<Method, Handler> { /* private fields */ }
Expand description

The main router. This contains a set of routes that can be taken, as well as a default hnadler for when the request matches none of those routes. We make no requirements on the Method type here; this is the type used by the HTTP library to represent the HTTP method (e.g. GET, POST, etc.). When routes are created, they’re created with this Method type, and when we do a lookup, we make sure the route matches the method.

We also make no restrictions on the Handler; all that’s returned upon lookup is an immutable reference to the handler, if one exists.

Implementations§

Source§

impl<M: Eq, H> Router<M, H>

Source

pub fn build() -> Build<M, H>

Create a builder for the router. See type Build for more information.

Source

pub fn lookup<'s, 'p>( &'s self, method: &M, path: &'p str, ) -> Option<(&'s H, Vec<&'p str>)>

This performs the actual lookup. We take a reference to the method, and a reference to the path, and return the handler and the url parameters, if they exist. Note that the path must be URL decoded, and only contain the path - it must not contain any query parameters.

Source

pub fn set_default(&mut self, default: H)

Sets the default of the router. This is similar to [Build::set_default].

Trait Implementations§

Source§

impl<Method: Clone, Handler: Clone> Clone for Router<Method, Handler>

Source§

fn clone(&self) -> Router<Method, Handler>

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<M: Debug, H: Debug> Debug for Router<M, H>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Method, Handler> Freeze for Router<Method, Handler>
where Handler: Freeze,

§

impl<Method, Handler> RefUnwindSafe for Router<Method, Handler>
where Handler: RefUnwindSafe, Method: RefUnwindSafe,

§

impl<Method, Handler> Send for Router<Method, Handler>
where Handler: Send, Method: Send,

§

impl<Method, Handler> Sync for Router<Method, Handler>
where Handler: Sync, Method: Sync,

§

impl<Method, Handler> Unpin for Router<Method, Handler>
where Handler: Unpin, Method: Unpin,

§

impl<Method, Handler> UnwindSafe for Router<Method, Handler>
where Handler: UnwindSafe, Method: UnwindSafe,

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, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.