Struct Router 

pub struct Router { /* private fields */ }

Express-style router. Return from modules and app.mount("/blog", routes()).

Implementations

impl Router

pub fn new() -> Self

pub fn use_middleware<M>(&mut self, mw: M) -> &mut Self

where M: IntoMwEntry,

pub fn with<T: RouteValue>(&mut self, value: T) -> &mut Self

Attach a RouteValue to the last HTTP route, or to router defaults.

After get/post/…, writes to that route. Otherwise writes to router/app defaults (inherited by routes: route > router > app).

pub fn with_update<T, F>(&mut self, f: F) -> &mut Self

where T: RouteValue + Clone + Default, F: FnOnce(&mut T),

Update a RouteValue on the last route (insert T::default() if missing).

pub fn route_middleware<M>(&mut self, mw: M) -> &mut Self

where M: IntoMwEntry,

Push middleware onto the last registered HTTP route only.

pub fn route_meta<T: RouteValue>(&mut self, value: T) -> &mut Self

Alias for Self::with (writes to the last route when present).

pub fn state<T>(&mut self, value: T) -> &mut Self

where T: Send + Sync + 'static,

pub fn try_state<T>(&self) -> Option<Arc<T>>

where T: Send + Sync + 'static,

Shared app state inserted via Self::state, if present.

pub fn get<H, T>(&mut self, path: &str, handler: H) -> &mut Self

where H: IntoHandler<T>,

pub fn post<H, T>(&mut self, path: &str, handler: H) -> &mut Self

where H: IntoHandler<T>,

pub fn put<H, T>(&mut self, path: &str, handler: H) -> &mut Self

where H: IntoHandler<T>,

pub fn patch<H, T>(&mut self, path: &str, handler: H) -> &mut Self

where H: IntoHandler<T>,

pub fn delete<H, T>(&mut self, path: &str, handler: H) -> &mut Self

where H: IntoHandler<T>,

pub fn head<H, T>(&mut self, path: &str, handler: H) -> &mut Self

where H: IntoHandler<T>,

Explicit HEAD handler (takes precedence over GET→strip-body).

pub fn options<H, T>(&mut self, path: &str, handler: H) -> &mut Self

where H: IntoHandler<T>,

Explicit OPTIONS handler (takes precedence over auto 204 + Allow).

pub fn redirect( &mut self, from: &str, to: impl Into<String>, status: u16, ) -> &mut Self

GET from → redirect to to with the given HTTP status (e.g. 302, 301, 303).

app.redirect("/health", "/healthz", 302);
app.redirect("/old", "/new", 301);

pub fn raw<H>(&mut self, path: &str, handler: H) -> &mut Self

where H: IntoRawHandler,

Escape hatch: handle a path with a raw Hyper request/response (no Sova middleware).

pub fn mount(&mut self, prefix: &str, other: Router) -> &mut Self

Mount a child router under prefix.

Bakes the child’s middleware stack into its routes. Does not prepend this router’s middleware — the eventual root stack is applied once in compile_router as an outer wrap (so App-level middleware is not doubled).

pub fn group<F>(&mut self, prefix: &str, f: F) -> &mut Self

where F: FnOnce(&mut Router),

Sugar over Self::mount: build a child router in a closure.

pub fn catch<H, T>(&mut self, status: u16, handler: H) -> &mut Self

where H: IntoHandler<T>,

Register a catcher for HTTP status in this router’s mount scope.

At dispatch, the catcher with the longest matching prefix wins. not_found is sugar for catch(404, …).

pub fn not_found<H, T>(&mut self, handler: H) -> &mut Self

where H: IntoHandler<T>,

Sugar for Self::catch(404, handler).

pub fn error_handler<F, Fut>(&mut self, f: F) -> &mut Self

where F: Fn(Error) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Called when a leaf handler returns Err. Request is already consumed.

pub fn route_entries(&self) -> Vec<RouteEntry>

Full introspection: HTTP routes and raw paths.

pub fn explain(&self) -> String

Human-readable route map (method, path, middleware names).

Trait Implementations

impl Default for Router

fn default() -> Self

Returns the “default value” for a type.