Struct Router 

pub struct Router { /* private fields */ }

HTTP router for dispatching requests to handlers.

Example

let router = Router::new()
    .get("/", || "Hello, World!")
    .get("/users", list_users)
    .get("/users/:id", get_user)
    .post("/users", create_user)
    .put("/users/:id", update_user)
    .delete("/users/:id", delete_user);

Implementations

impl Router

pub fn new() -> Self

Creates a new empty router.

pub fn route<H, Args>(self, pattern: &str, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Adds a route that matches any HTTP method.

pub fn get<H, Args>(self, pattern: &str, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Adds a GET route.

pub fn post<H, Args>(self, pattern: &str, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Adds a POST route.

pub fn put<H, Args>(self, pattern: &str, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Adds a PUT route.

pub fn delete<H, Args>(self, pattern: &str, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Adds a DELETE route.

pub fn patch<H, Args>(self, pattern: &str, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Adds a PATCH route.

pub fn head<H, Args>(self, pattern: &str, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Adds a HEAD route.

pub fn options<H, Args>(self, pattern: &str, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Adds an OPTIONS route.

pub fn not_found<H, Args>(self, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Sets a custom 404 Not Found handler.

pub fn method_not_allowed<H, Args>(self, handler: H) -> Self

where H: Handler<Args> + 'static, H::Output: IntoResponse,

Sets a custom 405 Method Not Allowed handler.

pub fn nest(self, prefix: &str, nested: Router) -> Self

Nests another router under a path prefix.

Example

let api_router = Router::new()
    .get("/users", list_users)
    .get("/users/:id", get_user);

let main_router = Router::new()
    .get("/", home)
    .nest("/api", api_router);

pub fn handle(&self, req: &mut Request) -> Response

Handles a request and returns a response.

pub fn run(self)

Runs the router, handling the current request.

This is the main entry point for using the router.

Example

#[unsafe(no_mangle)]
pub extern "C" fn _start() {
    Router::new()
        .get("/", || "Hello!")
        .run();
}

Trait Implementations

impl Default for Router

fn default() -> Self

Returns the “default value” for a type.