Struct Router 

pub struct Router { /* private fields */ }

A group of routes sharing a path prefix and a set of tags.

Implementations

impl Router

pub fn new() -> Self

Creates an empty router with no prefix.

pub fn on_request<F, Fut>(self, hook: F) -> Self

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

Registers a scoped, observe-only on_request hook.

Scoped hooks run in addition to the app-global ones, after routing.

pub fn on_response<F, Fut>(self, hook: F) -> Self

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

Registers a scoped, observe-only on_response hook.

pub fn on_error<F, Fut>(self, hook: F) -> Self

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

Registers a scoped, observe-only on_error hook (non-validation errors).

pub fn on_validation_error<F, Fut>(self, hook: F) -> Self

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

Registers a scoped, observe-only on_validation_error hook.

pub fn prefix(self, prefix: impl Into<String>) -> Self

Sets the path prefix applied to every route in this router.

pub fn tags(self, tags: &[&str]) -> Self

Sets the tags applied to every route in this router.

pub fn route(self, route: Route) -> Self

Adds a route whose path is local to this router.

pub fn include(self, child: Router) -> Self

Nests child under this router, composing prefixes and tags.

pub fn into_routes(self) -> Vec<Route>

Flattens the router into fully-resolved routes for this level.

Each route gains this router’s prefix and tags. Calling this on the root router yields the final, fully-qualified route table.

pub fn routes(&self) -> &[Route]

Returns the local (unresolved) routes held by this router.

Trait Implementations

impl Default for Router

fn default() -> Router

Returns the “default value” for a type.