Skip to main content

Room

Struct Room 

Source
pub struct Room<S> { /* private fields */ }
Expand description

A set of peers sharing presence/state — one game world, one lobby, one chat channel. S is app-defined per-peer state (position, name, flags, …); Resuma only stores and returns it.

Extracted from a real multiplayer game’s hand-rolled HashMap<String, PeerLive>

  • broadcast/sweep helpers so future apps do not re-derive the same ~150 lines.

Implementations§

Source§

impl<S> Room<S>

Source

pub fn new(max_peers: usize) -> Self

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn get(&self, id: &str) -> Option<&Peer<S>>

Source

pub fn get_mut(&mut self, id: &str) -> Option<&mut Peer<S>>

Source

pub fn peers(&self) -> impl Iterator<Item = &Peer<S>>

Every peer, in arbitrary order.

Source

pub fn peers_except<'a>( &'a self, except: &'a str, ) -> impl Iterator<Item = &'a Peer<S>>

Every peer except except (pass "" to include everyone).

Source

pub fn join( &mut self, id: PeerId, state: S, tx: UnboundedSender<String>, ) -> Result<Option<Peer<S>>, RoomFull>

Insert a new peer. If id was already connected (e.g. a browser tab refresh reusing a client-generated id), the stale entry is replaced and returned so the caller can broadcast a “left” event for it before announcing the new join.

Errors with RoomFull once max_peers is reached and id is new.

Source

pub fn leave(&mut self, id: &str) -> Option<Peer<S>>

Source

pub fn broadcast_except(&self, except: &str, msg: &str)

Send msg to every peer except except (pass "" to include everyone).

Source

pub fn broadcast(&self, msg: &str)

Source

pub fn sweep_stale(&mut self, timeout: Duration) -> Vec<PeerId>

Remove peers whose Peer::last_seen is older than timeout and return their ids so callers can broadcast a “left” event / clean up app-side state.

Browser tabs get heavily throttled in the background (timers can pause for tens of seconds while the socket stays open), so timeout should be generous — minutes, not seconds — or reconnecting tabs look like churn.

Auto Trait Implementations§

§

impl<S> Freeze for Room<S>
where HashMap<String, Peer<S>>: Freeze,

§

impl<S> RefUnwindSafe for Room<S>

§

impl<S> Send for Room<S>
where HashMap<String, Peer<S>>: Send,

§

impl<S> Sync for Room<S>
where HashMap<String, Peer<S>>: Sync,

§

impl<S> Unpin for Room<S>
where HashMap<String, Peer<S>>: Unpin,

§

impl<S> UnsafeUnpin for Room<S>

§

impl<S> UnwindSafe for Room<S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more