Struct Router 

pub struct Router<S = ()>
where
    S: Clone + Send + Sync + 'static,
{ /* private fields */ }

Main router for the elif.rs framework

Implementations

impl<S> Router<S>

where S: Clone + Send + Sync + 'static,

pub fn new() -> Self

Create a new router

pub fn with_state(state: S) -> Self

Create a new router with state

pub fn use_middleware<M: Middleware + 'static>(self, middleware: M) -> Self

Add global middleware to the router

pub fn extend_middleware( self, external_middleware: MiddlewarePipelineV2, ) -> Self

Extend router middleware with external middleware pipeline External middleware will be executed before the router’s own middleware

pub fn middleware_group( self, name: &str, middleware: Vec<Arc<dyn Middleware>>, ) -> Self

Create a named middleware group for use with route-specific middleware

pub fn route(self, path: &str) -> RouteBuilder<S>

Create a route builder for defining routes with middleware groups

pub fn get<F, Fut, R>(self, path: &str, handler: F) -> Self

where F: Fn(ElifRequest) -> Fut + Send + Clone + 'static, Fut: Future<Output = HttpResult<R>> + Send + 'static, R: IntoElifResponse + Send + 'static,

Add a GET route with elif handler

pub fn post<F, Fut, R>(self, path: &str, handler: F) -> Self

where F: Fn(ElifRequest) -> Fut + Send + Clone + 'static, Fut: Future<Output = HttpResult<R>> + Send + 'static, R: IntoElifResponse + Send + 'static,

Add a POST route with elif handler

pub fn put<F, Fut, R>(self, path: &str, handler: F) -> Self

where F: Fn(ElifRequest) -> Fut + Send + Clone + 'static, Fut: Future<Output = HttpResult<R>> + Send + 'static, R: IntoElifResponse + Send + 'static,

Add a PUT route with elif handler

pub fn delete<F, Fut, R>(self, path: &str, handler: F) -> Self

where F: Fn(ElifRequest) -> Fut + Send + Clone + 'static, Fut: Future<Output = HttpResult<R>> + Send + 'static, R: IntoElifResponse + Send + 'static,

Add a DELETE route with elif handler

pub fn patch<F, Fut, R>(self, path: &str, handler: F) -> Self

where F: Fn(ElifRequest) -> Fut + Send + Clone + 'static, Fut: Future<Output = HttpResult<R>> + Send + 'static, R: IntoElifResponse + Send + 'static,

Add a PATCH route with elif handler

pub fn controller<C>(self, controller: C) -> Self

where C: ElifController + 'static,

Register a controller with automatic route registration

pub fn with_ioc_container(self, container: Arc<IocContainer>) -> Self

Set the IoC container for controller dependency injection

pub fn controller_from_container<C>(self) -> Self

where C: ElifController + IocControllable + 'static,

Register a controller type that will be resolved from the IoC container The controller type must implement both ElifController and IocControllable

pub fn scoped_controller_from_container<C>(self) -> Self

where C: ElifController + IocControllable + 'static,

Register a controller type with request-scoped dependency injection This creates controllers per request with scoped dependencies

pub fn merge(self, other: Router<S>) -> Self

Merge another ElifRouter - the primary method for composing routers

pub fn nest(self, path: &str, router: Router<S>) -> Self

Nest routes under a path prefix

The nested router’s global middleware will be applied only to the nested routes, not to the parent router’s routes. This is achieved by converting the nested router’s middleware pipeline into an Axum Layer before nesting.

pub fn into_axum_router(self) -> AxumRouter<S>

Get the underlying Axum router

pub fn registry(&self) -> Arc<Mutex<RouteRegistry>>

Get route registry for introspection

pub fn url_for( &self, name: &str, params: &HashMap<String, String>, ) -> Option<String>

Generate URL for a named route

pub fn middleware_pipeline(&self) -> &MiddlewarePipelineV2

Get the global middleware pipeline

pub fn middleware_groups(&self) -> &HashMap<String, MiddlewarePipelineV2>

Get available middleware groups

pub fn route_middleware(&self) -> &HashMap<String, Vec<String>>

Get route-specific middleware mappings

pub fn controller_registry(&self) -> Arc<Mutex<ControllerRegistry>>

Get the controller registry for introspection

pub fn ioc_container(&self) -> Option<&Arc<IocContainer>>

Get the IoC container if set

Trait Implementations

impl<S> Debug for Router<S>

where S: Clone + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.

impl<S> Default for Router<S>

where S: Clone + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.