Struct salvo_core::Router

pub struct Router { /* fields omitted */ }

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 befores(&self) -> &Vec<Arc<dyn Handler>>

Get current router’s before middlewares reference.

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

Get current router’s before middlewares mutable reference.

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

Get current router’s after middlewares reference.

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

Get current router’s after 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 fn detect(
    &self,
    req: &mut Request,
    path_state: &mut PathState
) -> Option<DetectMatched>

Detect current router is matched for current request.

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

Push a router as child of current router.

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

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

pub fn push_when<F>(self, func: F) -> Self where
    F: Fn(&Router) -> Option<Router>, 

👎 Deprecated since 0.10.4:

Please use then function instead

pub fn before<H: Handler>(self, handler: H) -> Self

Add a handler as middleware, it will run before the handler in current router or it’s descendants handle the request.

pub fn after<H: Handler>(self, handler: H) -> Self

Add a handler as middleware, it will run after the handler in current router or it’s descendants handle the request.

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

Create a new path filter for current router.

Panics

Panics if path value is not in correct format.

pub fn filter(self, filter: impl Filter + Sized) -> Self

Add a filter for current router.

pub fn filter_fn<T>(self, func: T) -> Self where
    T: Fn(&mut Request, &mut PathState) -> bool + Send + Sync + 'static, 

Create a new FnFilter from Fn.

pub fn handle<H: Handler>(self, handler: H) -> Self

Set current router’s handler.

pub fn then<F>(self, func: F) -> Self where
    F: FnOnce(Self) -> Self, 

When you want write router chain, this function will be useful, You can write your custom logic in FnOnce.

pub fn get<H: Handler>(self, handler: H) -> Self

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

pub fn post<H: Handler>(self, handler: H) -> Self

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

pub fn put<H: Handler>(self, handler: H) -> Self

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

pub fn delete<H: Handler>(self, handler: H) -> Self

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

pub fn patch<H: Handler>(self, handler: H) -> Self

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

pub fn head<H: Handler>(self, handler: H) -> Self

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

pub fn options<H: Handler>(self, handler: H) -> Self

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

Trait Implementations

impl Default for Router

fn default() -> Self

Returns the “default value” for a type.