Struct salvo::Router

pub struct Router { /* fields omitted */ }

Router struct is used for route request to different handlers.

Implementations

impl Router

pub fn new() -> Router

Create a new Router.

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

Get current router’s children reference.

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

Get current router’s children mutable reference.

pub fn hoops(&self) -> &Vec<Arc<dyn Handler + 'static>, Global>

Get current router’s middlewares reference.

pub fn hoops_mut(&mut self) -> &mut Vec<Arc<dyn Handler + 'static>, Global>

Get current router’s middlewares mutable reference.

pub fn filters(&self) -> &Vec<Box<dyn Filter + 'static, Global>, Global>

Get current router’s filters reference.

pub fn filters_mut(
    &mut self
) -> &mut Vec<Box<dyn Filter + 'static, Global>, Global>

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) -> Router

Push a router as child of current router.

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

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

pub fn with_hoop<H>(handler: H) -> Router where
    H: Handler, 

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

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

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

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

Create a new router and set path filter.

Panics

Panics if path value is not in correct format.

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

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) -> Router

Add a filter for current router.

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

Create a new FnFilter from Fn.

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

Set current router’s handler.

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

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

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

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

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

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

pub fn put<H>(self, handler: 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 delete<H>(self, handler: 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, handler: 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, handler: 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, handler: 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 Default for Router

pub fn default() -> Router

Returns the “default value” for a type.

impl From<Router> for Service

pub fn from(router: Router) -> Service

Performs the conversion.