Struct peta::Router

pub struct Router { /* private fields */ }

Generates map between path and method which returns ResponseFut supports * and : operators.

Example

let mut router = Router::new();

router.get("/", |req: Request| {
  // do not forget to return ResponseFut
});

router.post("/home", |req: Request| {
  // do not forget to return ResponseFut
});

// It is important to add default route
// can be simple 404 which will be called if nothing found
router.add_default(|req: Request| {});

let router = router.build();

Implementations

impl Router

pub fn new() -> Router

Create instance of Router.

let router = Router::new();

pub fn build(self) -> Arc<Self>

Wrap router in Arc to be able to pass it across threads/components.

let mut router = Router::new();
// do some things with router variable

let router = router.build();

// now we can simply clone and call any functions from router instance
let ref_router = router.clone();

pub fn add<F>(&mut self, method: &str, path: &'static str, func: F)where
    F: Fn(Request) -> ResponseFut + Send + Sync + 'static,

Adds new path -> method map to the Router.

router.add(method::GET, "/", |req: Request| {});
router.add(method::POST, "/", |req: Request| {});
// and so on

pub fn find(&self, req: Request) -> ResponseFut

Searches for appropriate method which is mapped to specific path

let req: request::Request;
// it will automatically extract path from `req`
router.find(req)

pub fn add_default<F>(&mut self, func: F)where
    F: Fn(Request) -> ResponseFut + Send + Sync + 'static,

Set default function for routes which were not mapped can be simple 404 response.

router.add_default(|req: Request| {});

impl Router

Abstracts add method by removing method::* param

pub fn get<F>(&mut self, path: &'static str, func: F)where
    F: Fn(Request) -> ResponseFut + Send + Sync + 'static,

pub fn put<F>(&mut self, path: &'static str, func: F)where
    F: Fn(Request) -> ResponseFut + Send + Sync + 'static,

pub fn post<F>(&mut self, path: &'static str, func: F)where
    F: Fn(Request) -> ResponseFut + Send + Sync + 'static,

pub fn head<F>(&mut self, path: &'static str, func: F)where
    F: Fn(Request) -> ResponseFut + Send + Sync + 'static,

pub fn patch<F>(&mut self, path: &'static str, func: F)where
    F: Fn(Request) -> ResponseFut + Send + Sync + 'static,

pub fn delete<F>(&mut self, path: &'static str, func: F)where
    F: Fn(Request) -> ResponseFut + Send + Sync + 'static,

pub fn options<F>(&mut self, path: &'static str, func: F)where
    F: Fn(Request) -> ResponseFut + Send + Sync + 'static,

Trait Implementations

impl Debug for Router

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

Formats the value using the given formatter.