Struct WebSocketRouter 

pub struct WebSocketRouter { /* private fields */ }

Available on crate feature websockets and native only.

WebSocket router: build-time registration + runtime lookup.

The build-time API (consumer(), reverse(), find_pending()) is used by #[url_patterns(mode = ws)] and UnifiedRouter::websocket(). The async API (register_route(), find_route(), etc.) is used at connection-handling time in reinhardt-websockets.

Implementations

impl WebSocketRouter

pub fn new() -> WebSocketRouter

Creates a new empty router.

pub fn with_namespace(self, namespace: impl Into<String>) -> WebSocketRouter

Set the namespace for this router.

Parallel to ServerRouter::with_namespace, emitted by #[url_patterns(mode = ws)] to pass the AppLabel::path(...). WebSocket route paths are absolute today and are not rewritten with this namespace; the value is stored for parity with other routers and future use. See reinhardt-web#3829.

pub fn namespace(&self) -> Option<&str>

Returns the namespace set via with_namespace, if any.

pub fn consumer<C, F>(self, _f: F) -> WebSocketRouter

where F: Fn() -> C, C: WebSocketEndpointInfo + 'static,

Register a WebSocket consumer by its factory function.

Parallel to ServerRouter::endpoint(). Path and name are derived from C’s WebSocketEndpointInfo impl at compile time.

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

Find a pending consumer route by name.

pub fn reverse(&self, name: &str, params: &[(&str, &str)]) -> Option<String>

Resolve a WebSocket URL by route name, substituting path parameters.

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

Register a route at runtime (async, used by the connection handler).

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

Looks up a registered route by its exact path.

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

Looks up a registered route by its name.

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

Removes the registered route for the given path.

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

Returns all currently registered routes.

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

Returns true if a route is registered for the given path.

pub async fn route_count(&self) -> usize

Returns the number of currently registered routes.

pub async fn clear(&mut self)

Removes all registered routes and name mappings.

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.