Struct Socket 

pub struct Socket { /* private fields */ }

One connected client.

Cheap to clone and safe to keep: sending goes through a channel, so a handle stored in a room registry does not hold the connection’s task or its buffers. Sending to a socket that has gone away is an error, not a panic.

socket.send("hello").await?;
socket.send_json(&Update { count: 3 }).await?;
socket.close().await;

Implementations

impl Socket

pub fn new( id: SocketId, path: impl Into<Arc<str>>, params: Vec<(String, String)>, outbound: UnboundedSender<Outbound>, ) -> Self

Build a handle over outbound.

The transport owns the receiving half; a handler is only ever given this side.

pub fn id(&self) -> SocketId

This connection’s id.

pub fn identity(&self) -> String

This connection’s id, qualified so it is unique across replicas.

This is what to send the browser, and what it should echo back in X-Socket-ID so to_others can skip it:

async fn on_connect(&self, socket: &Socket) -> Result<()> {
    socket.send_json(&json!({ "socket_id": socket.identity() })).await
}

Sending the bare id instead works on one replica and fails quietly on two: every replica has a socket 7, so “everyone except 7” would silence an unrelated browser on each of the others.

pub fn path(&self) -> &str

The path it connected to.

pub fn param(&self, name: &str) -> Option<&str>

A route parameter captured from the path — rooms/{room} gives room.

pub fn parse_param<T>(&self, name: &str) -> Result<T>

where T: FromStr, T::Err: Display,

A route parameter, parsed.

A bad request when it will not parse: the value came from the URL the client asked for.

pub fn params(&self) -> &[(String, String)]

Every captured parameter.

pub fn send(&self, message: impl Into<Message>) -> Result<()>

Send a frame.

Queued rather than written: a handler that awaited the socket would block on a slow client, and one slow client must not hold up the task reading everyone else’s messages.

pub fn send_json(&self, value: &impl Serialize) -> Result<()>

Send a value as a JSON text frame.

pub fn close(&self) -> Result<()>

Close the connection.

Idempotent: closing twice is not an error, because two halves of a handler deciding to close at once is normal.

pub fn close_with(&self, reason: impl Into<String>) -> Result<()>

Close with a reason the peer will see.

pub fn is_closed(&self) -> bool

Whether this handle has been asked to close, or the connection has gone.

Trait Implementations

impl Clone for Socket

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Socket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.