Struct Router 

pub struct Router { /* private fields */ }

HTTP Router with Laravel-like route registration

Implementations

impl Router

pub fn group<F>(self, prefix: &str, builder_fn: F) -> GroupBuilder

where F: FnOnce(GroupRouter) -> GroupRouter,

Create a route group with a shared prefix

Routes defined within the group will have the prefix prepended to their paths. Middleware applied to the group will be applied to all routes within it.

Example

Router::new()
    .group("/api", |r| {
        r.get("/users", list_users)      // -> GET /api/users
         .post("/users", create_user)    // -> POST /api/users
         .get("/users/{id}", show_user)  // -> GET /api/users/{id}
    })
    .middleware(ApiMiddleware)

impl Router

pub fn new() -> Self

Create an empty router with no routes registered.

pub fn get_route_middleware(&self, path: &str) -> Vec<BoxedMiddleware>

Get middleware for a specific route path

pub fn get_fallback(&self) -> Option<(Arc<BoxedHandler>, Vec<BoxedMiddleware>)>

Get the fallback handler and its middleware

pub fn get<H, Fut>(self, path: &str, handler: H) -> RouteBuilder

where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a GET route

pub fn post<H, Fut>(self, path: &str, handler: H) -> RouteBuilder

where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a POST route

pub fn put<H, Fut>(self, path: &str, handler: H) -> RouteBuilder

where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a PUT route

pub fn patch<H, Fut>(self, path: &str, handler: H) -> RouteBuilder

where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a PATCH route

pub fn delete<H, Fut>(self, path: &str, handler: H) -> RouteBuilder

where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a DELETE route

pub fn match_route( &self, method: &Method, path: &str, ) -> Option<(Arc<BoxedHandler>, HashMap<String, String>, String)>

Match a request and return the handler with extracted params and route pattern

Returns (handler, params, route_pattern) where route_pattern is the original pattern like “/users/{id}” for metrics grouping.

OPTIONS requests are dispatched through match_preflight: any path registered under any other verb returns a synthetic 204 handler so route-level middleware (CORS in particular) still runs. The CORS middleware then short-circuits the preflight with the configured ACAO / ACAH / ACAM headers. Without this, OPTIONS would 404 before the middleware chain ran.

Trait Implementations

impl Default for Router

fn default() -> Self

Returns the “default value” for a type.

impl From<GroupBuilder> for Router

fn from(builder: GroupBuilder) -> Self

Converts to this type from the input type.

impl From<RouteBuilder> for Router

fn from(builder: RouteBuilder) -> Self

Converts to this type from the input type.