Struct WebSocketRouter 

pub struct WebSocketRouter { /* private fields */ }

Available on crate feature websockets and non-WebAssembly only.

WebSocket router for managing routes

Supports an optional middleware chain that is applied to all WebSocket upgrade requests before establishing the connection. This ensures that HTTP-level middleware (authentication, IP filtering, rate limiting) is not bypassed by WebSocket upgrades.

Examples

use reinhardt_websockets::routing::{WebSocketRouter, WebSocketRoute};

let mut router = WebSocketRouter::new();

let route = WebSocketRoute::new(
    "/ws/chat".to_string(),
    Some("websocket:chat".to_string()),
);

router.register_route(route).await.unwrap();

let found = router.find_route("/ws/chat").await;
assert!(found.is_some());
assert_eq!(found.unwrap().name(), Some("websocket:chat"));

Implementations

impl WebSocketRouter

pub fn new() -> WebSocketRouter

Create a new WebSocket router

pub fn with_middleware(self, middleware: MiddlewareChain) -> WebSocketRouter

Set the middleware chain applied to upgrade requests before WebSocket handshake

pub fn middleware(&self) -> Option<&Arc<MiddlewareChain>>

Get a reference to the middleware chain, if configured

pub async fn register_route( &mut self, route: WebSocketRoute, ) -> Result<(), RouteError>

Register a WebSocket route

pub async fn find_route(&self, path: &str) -> Option<WebSocketRoute>

Find a route by path

pub async fn find_route_by_name(&self, name: &str) -> Option<WebSocketRoute>

Find a route by name

pub async fn remove_route(&mut self, path: &str) -> Result<(), RouteError>

Remove a route by path

pub async fn all_routes(&self) -> Vec<WebSocketRoute>

Get all registered routes

pub async fn has_route(&self, path: &str) -> bool

Check if a route exists

pub async fn route_count(&self) -> usize

Get the number of registered routes

pub async fn clear(&mut self)

Clear all routes

Trait Implementations

impl Clone for WebSocketRouter

fn clone(&self) -> WebSocketRouter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for WebSocketRouter

fn default() -> WebSocketRouter

Returns the “default value” for a type.