Struct Room 

pub struct Room {
    pub id: String,
    /* private fields */
}

A single broadcast room with a participant roster.

Fields

id: String

Room identifier.

Implementations

impl Room

pub fn new(id: impl Into<String>, capacity: usize) -> Self

Create a new room with the given id and broadcast capacity.

pub fn with_stats( id: impl Into<String>, capacity: usize, stats: Option<StatsRecorder>, ) -> Self

Create a new room that records outbound traffic and drops into stats (0.4.0 backpressure hook — see crate::stats).

pub fn subscribe(&self) -> Receiver<Frame>

Subscribe to this room’s messages (text and binary).

pub fn broadcast(&self, msg: impl Into<Frame>) -> Result<usize, WsError>

Broadcast a frame (text or binary) to all participants.

Accepts anything Frame converts from — String, &str, bytes::Bytes, Vec<u8> — with no re-encoding for owned payloads.

Errors

Returns WsError::BroadcastFull when the room has no active receivers; with a StatsRecorder attached this also counts as a drop (backpressure loss).

pub fn join(&self, participant_id: u32, name: String)

Add a participant (or refresh its display name on re-join).

pub fn leave(&self, participant_id: u32) -> bool

Remove a participant. Returns true if it was present.

pub fn contains(&self, participant_id: u32) -> bool

Check if participant is in room.

pub fn participants(&self) -> Vec<(u32, String)>

Snapshot of (participant_id, name) pairs.

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

Snapshot of participant display names.

pub fn participant_count(&self) -> usize

Number of tracked participants.

pub fn receiver_count(&self) -> usize

Number of active broadcast receivers.

pub fn is_empty(&self) -> bool

Returns true if no participants and no receivers.

pub fn sender(&self) -> &Sender<Frame>

Internal sender.

Trait Implementations

impl Debug for Room

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

Formats the value using the given formatter.