Struct Rooms 

pub struct Rooms { /* private fields */ }

Every socket currently connected, grouped by a key you choose.

The thing every non-trivial socket application needs and none of them want to write twice: a chat needs the room’s members, a live dashboard needs everyone watching one account.

rooms.join("lobby", socket.clone());
rooms.send("lobby", Message::text("someone arrived"));
rooms.leave("lobby", socket.id());

Handles to sockets that have gone away are dropped on the next send rather than reaped on a timer, so a client that vanished without a close frame costs one failed send and then nothing.

Implementations

impl Rooms

pub fn new() -> Self

An empty registry.

pub fn join(&self, room: impl Into<String>, socket: Socket)

Add socket to room.

pub fn leave(&self, room: &str, socket: SocketId)

Remove one socket from room.

pub fn leave_all(&self, socket: SocketId)

Remove a socket from every room.

What on_close should call: a handler that tracked which rooms a socket was in would be keeping a second copy of this map.

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

Send to everyone in room. Returns how many received it.

pub fn send_except( &self, room: &str, except: SocketId, message: impl Into<Message>, ) -> usize

Send to everyone in room except one socket — the one that caused the message, which has usually shown it already.

pub fn count(&self, room: &str) -> usize

How many sockets are in room.

pub fn rooms(&self) -> Vec<String>

The rooms that have anyone in them.

Trait Implementations

impl Debug for Rooms

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

Formats the value using the given formatter.

impl Default for Rooms

fn default() -> Self

Returns the “default value” for a type.