Struct matchit::Router

pub struct Router<T> { /* private fields */ }

A URL router.

See the crate documentation for details.

Implementations

impl<T> Router<T>

pub fn new() -> Self

Construct a new router.

pub fn insert(
    &mut self,
    route: impl Into<String>,
    value: T
) -> Result<(), InsertError>

Insert a route.

Examples

let mut router = Router::new();
router.insert("/home", "Welcome!")?;
router.insert("/users/:id", "A User")?;

pub fn at<'m, 'p>(
    &'m self,
    path: &'p str
) -> Result<Match<'m, 'p, &'m T>, MatchError>

Tries to find a value in the router matching the given path.

Examples

let mut router = Router::new();
router.insert("/home", "Welcome!")?;

let matched = router.at("/home").unwrap();
assert_eq!(*matched.value, "Welcome!");

pub fn at_mut<'m, 'p>(
    &'m mut self,
    path: &'p str
) -> Result<Match<'m, 'p, &'m mut T>, MatchError>

Tries to find a value in the router matching the given path, returning a mutable reference.

Examples

let mut router = Router::new();
router.insert("/", 1)?;

*router.at_mut("/").unwrap().value += 1;
assert_eq!(*router.at("/").unwrap().value, 2);

pub fn fix_path(&self, path: &str) -> Option<String>

Performs a case-insensitive lookup of the given path, returning the case corrected path if successful.

Missing/extra trailing slashes are also corrected.

let mut router = Router::new();
router.insert("/home", "Welcome!")?;

let path = router.fix_path("/HoMe/").unwrap();
assert_eq!(path, "/home");

Trait Implementations

impl<T: Clone> Clone for Router<T>

fn clone(&self) -> Router<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for Router<T>

fn default() -> Self

Returns the “default value” for a type.