Struct Router 

pub struct Router { /* private fields */ }

Radix trie router.

Implementations

impl Router

pub fn new() -> Self

Create an empty router.

pub fn add(&mut self, route: Route) -> Result<(), RouteAddError>

Add a route, returning an error if it conflicts with existing routes or the path pattern is invalid.

Conflict rules:

• Same HTTP method + structurally identical path patterns conflict
• Static segments take priority over parameter segments (no conflict)
• Parameter names/converters do not disambiguate conflicts (one param slot per segment)
• {param:path} converters are only valid as the final segment

pub fn lookup<'a>(&'a self, path: &'a str, method: Method) -> RouteLookup<'a>

Match a path and method with 404/405 distinction.

pub fn match_path<'a>( &'a self, path: &'a str, method: Method, ) -> Option<RouteMatch<'a>>

Match a path and method.

pub fn routes(&self) -> &[Route]

Get all routes.

pub fn mount(self, prefix: &str, child: Router) -> Result<Self, RouteAddError>

Mount a child router at a path prefix.

All routes from the child router will be accessible under the given prefix. This is useful for organizing routes into modules or API versions.

Arguments

• prefix - Path prefix for all child routes (e.g., “/api/v1”)
• child - The router to mount

Example

use fastapi_router::Router;
use fastapi_core::Method;

let api = Router::new()
    .route(get_users)   // /users
    .route(get_items);  // /items

let app = Router::new()
    .mount("/api/v1", api);  // /api/v1/users, /api/v1/items

Errors

Returns an error if any mounted route conflicts with existing routes.

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

Mount a child router at a path prefix (builder pattern).

Same as mount but panics on conflict. Use for static route definitions.

Panics

Panics if any mounted route conflicts with existing routes.

Trait Implementations

impl Default for Router

fn default() -> Self

Returns the “default value” for a type.