Struct pathmaker::router::Router

pub struct Router<Method, Handler> { /* fields omitted */ }

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.

Methods

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

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

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

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.

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

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

Trait Implementations

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

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

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M: Debug, H: Debug> Debug for Router<M, H>

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

Formats the value using the given formatter.