13 releases

0.6.2 Jan 30, 2024
0.6.1 Nov 16, 2023
0.6.0 Oct 24, 2023
0.5.1 Mar 17, 2023
0.1.0 Mar 23, 2022

#45 in WebSocket

Download history 18/week @ 2023-12-24 46/week @ 2023-12-31 162/week @ 2024-01-07 63/week @ 2024-01-14 93/week @ 2024-01-21 108/week @ 2024-01-28 60/week @ 2024-02-04 32/week @ 2024-02-11 175/week @ 2024-02-18 209/week @ 2024-02-25 83/week @ 2024-03-03 228/week @ 2024-03-10 166/week @ 2024-03-17 210/week @ 2024-03-24 325/week @ 2024-03-31 59/week @ 2024-04-07

836 downloads per month
Used in 6 crates (3 directly)

MIT license

125KB
2.5K SLoC

ezsockets

Creating a WebSocket server or a client in Rust can be troublesome. This crate facilitates this process by providing:

  • Traits to allow declarative and event-based programming.
  • Easy concurrency with Tokio and async/await. Server sessions are Clone'able and can be shared between tasks.
  • Heartbeat mechanism to keep the connection alive.
  • Automatic reconnection of WebSocket Clients.
  • Support for arbitrary client back-ends, with built-in native and WASM client connectors.
  • Support for multiple server back-ends such as Axum or Tungstenite.
  • TLS support for servers with rustls and native-tls.

Documentation

View the full documentation at docs.rs/ezsockets

Examples

  • simple-client - a simplest WebSocket client which uses stdin as input.
  • echo-server - server that echoes back every message it receives.
  • echo-server - same as echo-server, but with native-tls.
  • counter-server - server that increments global value every second and shares it with client
  • chat-client - chat client for chat-server and chat-server-axum examples
  • wasm-client - chat client for chat-server and chat-server-axum examples that runs in the browser (only listens to the chat)
  • chat-server - chat server with support of rooms
  • chat-server-axum - same as above, but using axum as a back-end

Client

By default clients use tokio-tungstenite under the hood. Disable default features and enable wasm_client to run clients on WASM targets.

See examples/simple-client for a simple usage and docs.rs/ezsockets/server for documentation.

Server

WebSocket server can use one of the supported back-ends:

  • tokio-tungstenite - the simplest way to get started.
  • axum - ergonomic and modular web framework built with Tokio, Tower, and Hyper
  • actix-web - Work in progress at #22

See examples/echo-server for a simple usage and docs.rs/ezsockets/server for documentation.

License

Licensed under MIT.

Contact

Reach me out on Discord gbaranski#5119, or mail me at me@gbaranski.com.

Dependencies

~4–20MB
~306K SLoC