Skip to content

Cancellation safety for WebSocket's async methods is not documented #3282

Open
@ProgramCrafter

Description

@ProgramCrafter

Docs don't say if the following code is correct or may produce unexpected results:

  let update_receiver: tokio::sync::broadcast::Receiver;
  let sock: axum::extract::ws::WebSocket;
  
  let (mut ws_write, mut ws_read) = sock.split();

  tokio::select! {
    // Cancel-safe. https://docs.rs/tokio/1.43.0/tokio/sync/broadcast/struct.Receiver.html#cancel-safety
    clientbound = update_receiver.recv() => {...}
    // ??? https://docs.rs/axum/0.8.1/axum/extract/ws/struct.WebSocket.html#method.recv
    serverbound = ws_read.recv() => {...}
  }

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions