ws-bridge 0.2.1

Strongly-typed WebSocket endpoints for Rust — define once, use everywhere (axum server, yew/gloo browser client, tokio-tungstenite native client)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

mod codec;
mod connection;

pub use codec::{DecodeError, EncodeError, NoMessages, WsCodec, WsMessage};
pub use connection::{RecvError, SendError, WsConnection, WsReceiver, WsSender};

#[cfg(feature = "server")]
pub mod server;

#[cfg(feature = "yew-client")]
pub mod yew_client;

#[cfg(feature = "native-client")]
pub mod native_client;

#[cfg(feature = "reconnect")]
pub mod reconnect;

/// Defines a WebSocket endpoint — its path, and the message types
/// that flow in each direction.
///
/// Implement this on a unit struct in your shared crate. That struct
/// becomes the single source of truth for the endpoint, usable by
/// server, browser client, and native client alike.
pub trait WsEndpoint {
    /// The URL path for this endpoint (e.g., "/ws/session").
    const PATH: &'static str;

    /// Messages sent FROM the server TO the client.
    type ServerMsg: WsCodec + Clone + Send + 'static;

    /// Messages sent FROM the client TO the server.
    type ClientMsg: WsCodec + Clone + Send + 'static;
}