Struct Router 

#[non_exhaustive]
pub struct Router {
    pub routers: Vec<Router>,
    pub filters: Vec<Box<dyn Filter>>,
    pub hoops: Vec<Arc<dyn Handler>>,
    pub goal: Option<Arc<dyn Handler>>,
    /* private fields */
}

Route request to different handlers.

View module level documentation for more details.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

routers: Vec<Router>

The children of current router.

filters: Vec<Box<dyn Filter>>

The filters of current router.

hoops: Vec<Arc<dyn Handler>>

The middlewares of current router.

goal: Option<Arc<dyn Handler>>

The final handler to handle request of current router.

Implementations

impl Router

pub fn new() -> Router

Create a new Router.

pub fn routers(&self) -> &Vec<Router>

Get current router’s children reference.

pub fn routers_mut(&mut self) -> &mut Vec<Router>

Get current router’s children mutable reference.

pub fn hoops(&self) -> &Vec<Arc<dyn Handler>>

Get current router’s middlewares reference.

pub fn hoops_mut(&mut self) -> &mut Vec<Arc<dyn Handler>>

Get current router’s middlewares mutable reference.

pub fn filters(&self) -> &Vec<Box<dyn Filter>>

Get current router’s filters reference.

pub fn filters_mut(&mut self) -> &mut Vec<Box<dyn Filter>>

Get current router’s filters mutable reference.

pub async fn detect( &self, req: &mut Request, path_state: &mut PathState<'_>, ) -> Option<DetectMatched>

Detect current router is matched for current request.

pub fn unshift(self, router: Router) -> Router

Insert a router at the beginning of current router, shifting all routers after it to the right.

pub fn insert(self, index: usize, router: Router) -> Router

Insert a router at position index within current router, shifting all routers after it to the right.

pub fn push(self, router: Router) -> Router

Push a router as child of current router.

pub fn append(self, others: &mut Vec<Router>) -> Router

Append all routers in a Vec as children of current router.

pub fn with_hoop<H>(hoop: H) -> Router

where H: Handler,

Add a handler as middleware. It runs the handler in the current router or its descendants when handling the request.

pub fn with_hoop_when<H, F>(hoop: H, filter: F) -> Router

where H: Handler, F: Fn(&Request, &Depot) -> bool + Send + Sync + 'static,

Add a handler as middleware. It runs the handler in the current router or its descendants when handling the request, but only when the filter returns true.

pub fn hoop<H>(self, hoop: H) -> Router

where H: Handler,

Add a handler as middleware. It runs the handler in the current router or its descendants when handling the request.

pub fn hoop_when<H, F>(self, hoop: H, filter: F) -> Router

where H: Handler, F: Fn(&Request, &Depot) -> bool + Send + Sync + 'static,

Add a handler as middleware. It runs the handler in the current router or its descendants when handling the request, but only when the filter returns true.

pub fn with_path(path: impl Into<String>) -> Router

Create a new router and set path filter.

Invalid path patterns are logged and converted into a filter that never matches. Use Router::try_with_path to handle malformed patterns explicitly.

pub fn try_with_path(path: impl Into<String>) -> Result<Router, String>

Try creating a new router and set path filter.

Errors

Returns an error when the path pattern is malformed.

pub fn path(self, path: impl Into<String>) -> Router

Create a new path filter for current router.

Invalid path patterns are logged and converted into a filter that never matches. Use Router::try_path to handle malformed patterns explicitly.

pub fn try_path(self, path: impl Into<String>) -> Result<Router, String>

Try creating a new path filter for current router.

Errors

Returns an error when the path pattern is malformed.

pub fn with_filter(filter: impl Filter) -> Router

Create a new router and set filter.

pub fn filter(self, filter: impl Filter) -> Router

Add a filter for current router.

pub fn with_filter_fn<T>(func: T) -> Router

where T: for<'a> Fn(&mut Request, &mut PathState<'a>) -> bool + Send + Sync + 'static,

Create a new router and set filter_fn.

pub fn filter_fn<T>(self, func: T) -> Router

where T: for<'a> Fn(&mut Request, &mut PathState<'a>) -> bool + Send + Sync + 'static,

Create a new FnFilter from Fn.

pub fn goal<H>(self, goal: H) -> Router

where H: Handler,

Sets current router’s handler.

Calling goal on a router that already has one replaces the previous handler (a warning is logged, since this usually indicates route-building code overwriting itself by accident). Note that the method helpers (get, post, …) do not set this router’s goal — each pushes a filtered child router with its own goal.

pub fn then<F>(self, func: F) -> Router

where F: FnOnce(Router) -> Router,

Runs a closure with this router and returns the closure result. Useful for composing router chains conditionally.

pub fn scheme(self, scheme: Scheme) -> Router

Add a SchemeFilter to current router.

pub fn host(self, host: impl Into<String>) -> Router

Add a HostFilter to current router.

pub fn with_host(host: impl Into<String>) -> Router

Create a new HostFilter and set host filter.

pub fn port(self, port: u16) -> Router

Add a PortFilter to current router.

pub fn with_port(port: u16) -> Router

Create a new PortFilter and set port filter.

pub fn get<H>(self, goal: H) -> Router

where H: Handler,

Creates a new child router with MethodFilter to filter GET method and set this child router’s handler.

Each method helper (get, post, …) pushes a filtered child router; it does not set the goal of self. Two consequences worth knowing:

• Router::with_path("x").get(a).post(b) builds one path router with two method children — the usual pattern.
• .get(a).get(b) registers two sibling GET routes rather than replacing a; the first match wins, so b is unreachable.

pub fn post<H>(self, goal: H) -> Router

where H: Handler,

Create a new child router with MethodFilter to filter post method and set this child router’s handler.

See get for how method helpers compose as child routers.

pub fn put<H>(self, goal: H) -> Router

where H: Handler,

Create a new child router with MethodFilter to filter put method and set this child router’s handler.

pub fn query<H>(self, goal: H) -> Router

where H: Handler,

Create a new child router with MethodFilter to filter QUERY method and set this child router’s handler.

QUERY is a safe, idempotent method that can carry request content, making it suitable for complex queries that do not fit well in a URI query string.

pub fn delete<H>(self, goal: H) -> Router

where H: Handler,

Create a new child router with MethodFilter to filter delete method and set this child router’s handler.

pub fn patch<H>(self, goal: H) -> Router

where H: Handler,

Create a new child router with MethodFilter to filter patch method and set this child router’s handler.

pub fn head<H>(self, goal: H) -> Router

where H: Handler,

Create a new child router with MethodFilter to filter head method and set this child router’s handler.

pub fn options<H>(self, goal: H) -> Router

where H: Handler,

Create a new child router with MethodFilter to filter options method and set this child router’s handler.

Trait Implementations

impl Debug for Router

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

Formats the value using the given formatter.

impl Default for Router

fn default() -> Router

Returns the “default value” for a type.

impl RouterExt for Router

fn oapi_security(self, security: SecurityRequirement) -> Router

Add security requirement to the router.

fn oapi_securities<I>(self, iter: I) -> Router

where I: IntoIterator<Item = SecurityRequirement>,

Add security requirements to the router.

fn oapi_tag(self, tag: impl Into<String>) -> Router

Add tag to the router.

fn oapi_tags<I, V>(self, iter: I) -> Router

where I: IntoIterator<Item = V>, V: Into<String>,

Add tags to the router.

impl SendTarget for Router

async fn call(self, req: Request) -> Response

Send request to target, such as Router, Service, Handler.