Struct Router

Source

pub struct Router { /* private fields */ }

Expand description

A compiled, trie-based router mapping (method, path) to a handler.

Build one with Router::new, register routes with Router::add, and look them up with Router::route. Inside an application you usually do not touch the Router directly — the RouteBuilder DSL in AppBuilder::routing populates it for you.

Supported pattern syntax (full paths, leading /):

static segments: /users/list
named parameters: /users/{id} (captured as id)
trailing wildcard: /files/{path...} (captures the remaining path, slashes included; must be the last segment)

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

let mut router = Router::new();
router.add(Method::GET, "/files/{path...}", boxed((|_c: Call| async { "" }).into_handler()));
match router.route(&Method::GET, "/files/a/b/c.txt") {
    Match::Found { params, .. } => assert_eq!(params.get("path").unwrap(), "a/b/c.txt"),
    _ => panic!("expected wildcard match"),
}

Implementations§

Source §

impl Router

Source

pub fn new() -> Self

Create an empty router. Equivalent to Router::default.

Source

pub fn add(&mut self, method: Method, pattern: &str, handler: BoxHandler)

Insert handler for method at pattern (the full path, e.g. /users/{id}).

Registering different methods at the same path is fine; registering the same (method, path) twice replaces the earlier handler.

§Panics

Panics if a {name...} wildcard segment is not the final segment of the pattern.

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

let mut router = Router::new();
router.add(Method::GET, "/ping", boxed((|_c: Call| async { "pong" }).into_handler()));
assert!(matches!(router.route(&Method::GET, "/ping"), Match::Found { .. }));

Source

pub fn route(&self, method: &Method, path: &str) -> Match

Route path for method, returning a Match.

Matching prefers static segments over {param} captures, and falls back to a {name...} wildcard at the deepest matchable ancestor. A path that matches a node with no handler for method yields Match::MethodNotAllowed; a path that matches no node yields Match::NotFound.

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

let mut router = Router::new();
router.add(Method::GET, "/", boxed((|_c: Call| async { "home" }).into_handler()));
assert!(matches!(router.route(&Method::GET, "/"), Match::Found { .. }));
assert!(matches!(router.route(&Method::GET, "/missing"), Match::NotFound));