Crate axum_typed_websockets

axum::extract::ws with type safe messages.

Example

use axum::{
    Router,
    response::IntoResponse,
    routing::get,
};
use axum_typed_websockets::{Message, WebSocket, WebSocketUpgrade};
use serde::{Serialize, Deserialize};
use std::time::Instant;

// Make a regular axum router
let app = Router::new().route("/ws", get(handler));

// Run it!
axum::Server::bind(&"0.0.0.0:3000".parse().unwrap())
    .serve(app.into_make_service())
    .await
    .unwrap();

async fn handler(
    // Upgrade the request to a WebSocket connection where the server sends
    // messages of type `ServerMsg` and the clients sends `ClientMsg`
    ws: WebSocketUpgrade<ServerMsg, ClientMsg>,
) -> impl IntoResponse {
    ws.on_upgrade(ping_pong_socket)
}

// Send a ping and measure how long time it takes to get a pong back
async fn ping_pong_socket(mut socket: WebSocket<ServerMsg, ClientMsg>) {
    let start = Instant::now();
    socket.send(Message::Item(ServerMsg::Ping)).await.ok();

    if let Some(msg) = socket.recv().await {
        match msg {
            Ok(Message::Item(ClientMsg::Pong)) => {
                println!("ping: {:?}", start.elapsed());
            },
            Ok(_) => {},
            Err(err) => {
                eprintln!("got error: {}", err);
            },
        }
    }
}

#[derive(Debug, Serialize)]
enum ServerMsg {
    Ping,
}

#[derive(Debug, Deserialize)]
enum ClientMsg {
    Pong,
}

Feature flags

The following features are available:

• json: Enables JsonCodec which encodes message as JSON using serde_json. Enabled by default.

Structs

JsonCodec

A Codec that serializes messages as JSON using serde_json.

WebSocket

A version of axum::extract::ws::WebSocket with type safe messages.

WebSocketUpgrade

A version of axum::extract::ws::WebSocketUpgrade with type safe messages.

Enums

Error

Errors that can happen when using this library.

Message

A WebSocket message contain a value of a known type.

Traits

Codec

Trait for encoding and decoding WebSocket messages.