Struct Router

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

A zero-copy 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 into the router.

Examples

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

pub fn at<'path>( &self, path: &'path str, ) -> Result<Match<'_, 'path, &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<'path>( &mut self, path: &'path str, ) -> Result<Match<'_, 'path, &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 remove(&mut self, path: impl Into<String>) -> Option<T>

Remove a given route from the router.

Returns the value stored under the route if it was found. If the route was not found or invalid, None is returned.

Examples

let mut router = Router::new();

router.insert("/home", "Welcome!");
assert_eq!(router.remove("/home"), Some("Welcome!"));
assert_eq!(router.remove("/home"), None);

router.insert("/home/{id}/", "Hello!");
assert_eq!(router.remove("/home/{id}/"), Some("Hello!"));
assert_eq!(router.remove("/home/{id}/"), None);

router.insert("/home/{id}/", "Hello!");
// the route does not match
assert_eq!(router.remove("/home/{user}"), None);
assert_eq!(router.remove("/home/{id}/"), Some("Hello!"));

router.insert("/home/{id}/", "Hello!");
// invalid route
assert_eq!(router.remove("/home/{id"), None);
assert_eq!(router.remove("/home/{id}/"), Some("Hello!"));

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: Debug> Debug for Router<T>

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

Formats the value using the given formatter.

impl<T> Default for Router<T>

fn default() -> Self

Returns the “default value” for a type.