Struct Router

Source

pub struct Router { /* private fields */ }

Expand description

Main router

Implementations§

Source §

impl Router

Source

pub fn new() -> Router

Create a new router

Source

pub fn route(self, path: &str, method_router: MethodRouter) -> Router

Add a route

Source

pub fn state<S>(self, state: S) -> Router
where S: Clone + Send + Sync + 'static,

Add application state

Source

pub fn has_state<S>(&self) -> bool
where S: 'static,

Check if state of a given type exists

Source

pub fn state_type_ids(&self) -> &[TypeId]

Get state type IDs (for testing and debugging)

Source

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

Nest another router under a prefix

All routes from the nested router will be registered with the prefix prepended to their paths. State from the nested router is merged into the parent router (parent state takes precedence for type conflicts).

§State Merging

When nesting routers with state:

If the parent router has state of type T, it is preserved (parent wins)
If only the nested router has state of type T, it is added to the parent
State type tracking is merged to enable proper conflict detection

Note: Due to limitations of http::Extensions, automatic state merging requires using the merge_state method for specific types.

§Example

use rustapi_core::{Router, get};

async fn list_users() -> &'static str { "List users" }
async fn get_user() -> &'static str { "Get user" }

let users_router = Router::new()
    .route("/", get(list_users))
    .route("/{id}", get(get_user));

let app = Router::new()
    .nest("/api/users", users_router);

// Routes are now:
// GET /api/users/
// GET /api/users/{id}

Source

pub fn merge_state<S>(self, other: &Router) -> Router
where S: Clone + Send + Sync + 'static,

Merge state from another router into this one

This method allows explicit state merging when nesting routers. Parent state takes precedence - if the parent already has state of type S, the nested state is ignored.

§Example

#[derive(Clone)]
struct DbPool(String);

let nested = Router::new().state(DbPool("nested".to_string()));
let parent = Router::new()
    .merge_state::<DbPool>(&nested); // Adds DbPool from nested

Source