Struct WebSocketRoutes 

pub struct WebSocketRoutes { /* private fields */ }

The WebSocket routes an application declares — routes/ws.rs.

Separate from the HTTP router because the two answer different things: an HTTP route returns a response and is done, a socket route starts a conversation. Sharing one table would mean one of them pretending.

pub fn routes() -> WebSocketRoutes {
    WebSocketRoutes::new()
        .add("/ws/rooms/{room}", Chat::new(rooms))
        .add("/ws/notifications", Notifications)
}

Implementations

impl WebSocketRoutes

pub fn new() -> Self

No routes. Every upgrade is a 404 until something is declared.

pub fn add( self, pattern: impl Into<String>, handler: impl WebSocketHandler, ) -> Self

Serve handler at pattern.

{name} captures a segment, readable from Socket::param. The first matching pattern wins, so declare the specific before the general.

pub fn add_arc( self, pattern: impl Into<String>, handler: Arc<dyn WebSocketHandler>, ) -> Self

Serve a handler you already share.

pub fn match_path(&self, path: &str) -> Option<Matched>

The handler for path, and whatever its pattern captured.

pub fn patterns(&self) -> Vec<&str>

The declared patterns, for route:list.

pub fn len(&self) -> usize

How many are declared.

pub fn is_empty(&self) -> bool

Whether none are.

Trait Implementations

impl Debug for WebSocketRoutes

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

Formats the value using the given formatter.

impl Default for WebSocketRoutes

fn default() -> Self

Returns the “default value” for a type.