Struct RoomHandle 

pub struct RoomHandle { /* private fields */ }

A cloneable handle to a live room: the broadcast sender for fan-out, the command channel to the actor, and the shared member counter. Obtained from RoomRegistry::get_or_create.

Implementations

impl RoomHandle

pub fn room_id(&self) -> &str

The room id this handle addresses.

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

Subscribe to this room’s fan-out. Multiple receivers are allowed; each sees every frame published after it subscribed.

pub fn member_count(&self) -> usize

Current member count.

pub fn join(&self, member_id: impl Into<String>) -> RoomMembership

Join this room as member_id, returning an RAII RoomMembership guard. Dropping the guard leaves the room.

NOT race-safe against hibernation: the increment happens outside the registry lock, so a room that hibernated between obtaining this handle and this call yields an orphaned membership. Concurrent callers must use RoomRegistry::join instead; this method is for single-threaded tests.

pub fn publish_event(&self, value: Value)

Publish an Events frame to this room.

pub fn publish_presence(&self, member_id: &str, value: Value)

Publish a presence delta for member_id (upsert + TTL + broadcast).

pub fn publish_doc_sync(&self, bytes: Vec<u8>)

Publish an opaque DocSync (binary) frame, passed through untouched. Phase 3 CRDT updates ride this channel.

pub fn broadcast_event(&self, name: impl Into<String>, payload: Value)

Broadcast a typed named event to every subscriber of this room (Rivet’s broadcast(event, payload)). Rides the ordinary Frame::Event channel as an envelope, so raw subscribe() receivers still get it and typed Connections decode it into an Event.

pub fn send_event(&self, conn: ConnId, name: impl Into<String>, payload: Value)

Deliver a typed named event to exactly one connection (Rivet’s conn.send(event, payload)). Unlike broadcast_event, this never touches the shared broadcast, so no other connection and no raw broadcast subscriber observes it. No-op if conn has closed or the room actor has exited.

pub fn open_connection(&self) -> Connection

Open a typed subscriber Connection on this room: it receives both broadcasts and events addressed to its ConnId via send_event, and unregisters itself on Drop (the RAII unsubscribe handle). Distinct from the raw subscribe receiver, which is broadcast-only and cannot be targeted.

pub async fn conn_count(&self) -> usize

Snapshot the number of registered typed connections (diagnostic / test helper). Returns 0 if the actor has already exited.

pub async fn presence_members(&self) -> Vec<String>

Snapshot the live presence member ids (diagnostic / test helper). Returns an empty vec if the actor has already exited.

Trait Implementations

impl Clone for RoomHandle

fn clone(&self) -> RoomHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.