Skip to main content

WebSocketUrlResolver

Trait WebSocketUrlResolver 

Source
pub trait WebSocketUrlResolver {
    // Required method
    fn resolve_ws_url(&self, name: &str, params: &[(&str, &str)]) -> String;
}
Available on native only.
Expand description

Trait for resolving WebSocket endpoint URLs by route name.

Parallel to UrlResolver for HTTP routes. Extension traits generated by #[websocket] use this as a supertrait to add named accessor methods via blanket impls.

§Panics

Implementations should panic if the route name is not registered.

§Example

use reinhardt_urls::routers::resolver::WebSocketUrlResolver;

struct MyWsResolver;

impl WebSocketUrlResolver for MyWsResolver {
    fn resolve_ws_url(&self, name: &str, params: &[(&str, &str)]) -> String {
        format!("/ws/{}/", name)
    }
}

let resolver = MyWsResolver;
assert_eq!(resolver.resolve_ws_url("chat", &[]), "/ws/chat/");

Required Methods§

Source

fn resolve_ws_url(&self, name: &str, params: &[(&str, &str)]) -> String

Resolve a WebSocket URL by route name and path parameters.

Implementors§