Struct glory_routing::Router

#[non_exhaustive]
pub struct Router {
    pub routers: Vec<Router>,
    pub filters: Vec<Box<dyn Filter>>,
    pub hoops: Vec<Rc<dyn Handler>>,
    pub goal: Option<Rc<dyn Handler>>,
}

Router struct is used for router request to different handlers.

This form of definition can make the definition of router clear and simple for complex projects.

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>

routers is the children of current router.

filters: Vec<Box<dyn Filter>>

filters is the filters of current router.

hoops: Vec<Rc<dyn Handler>>

hoops of current router.

goal: Option<Rc<dyn Handler>>

goal of current router.

Implementations

impl Router

pub fn new() -> Self

Create a new Router.

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

Get current router’s children reference.

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

Get current router’s children mutable reference.

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

Get current router’s middlewares reference.

pub fn hoops_mut(&mut self) -> &mut Vec<Rc<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 fn detect( &self, url: &Url, truck: &Truck, 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: &mut Vec<Router>) -> Self

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

pub fn with_hoop<H: Handler>(handler: H) -> Self

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

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

where H: Handler, F: Fn(&Truck) -> bool + 'static,

Add a handler as middleware, it will run the handler in current router or it’s descendants handle the request. This middleware only effective when the filter return true.

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

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

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

where H: Handler, F: Fn(&Truck) -> bool + 'static,

Add a handler as middleware, it will run the handler in current router or it’s descendants handle the request. This middleware only effective when the filter return true.

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

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

Create a new path filter for current router.

Panics

Panics if path value is not in correct format.

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

Create a new router and set filter.

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

Add a filter for current router.

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

where T: Fn(&Url, &Truck, &mut PathState) -> bool + 'static,

Create a new router and set filter_fn.

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

where T: Fn(&Url, &Truck, &mut PathState) -> bool + 'static,

Create a new FnFilter from Fn.

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

Sets current router’s goal 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.

Trait Implementations

impl Debug for Router

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

Formats the value using the given formatter.

impl Default for Router

fn default() -> Self

Returns the “default value” for a type.