Struct Overlay 

pub struct Overlay {
    pub channels: BTreeMap<ChannelId, Channel>,
    pub users: BTreeMap<SessionId, User>,
}

Elements visible to exactly one connection.

This is the mechanism for individual exceptions - an admin in vanish, a private channel, a per-observer placement - as opposed to scopes, which describe groups. A scope with a single observer is an overlay in disguise.

Overlays are recomputed from scratch each turn and diffed against what the connection was last sent, which is why they never need journalling.

Fields

channels: BTreeMap<ChannelId, Channel>

users: BTreeMap<SessionId, User>

Implementations

impl Overlay

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for Overlay

fn clone(&self) -> Overlay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Overlay

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

Formats the value using the given formatter.

impl Default for Overlay

fn default() -> Overlay

Returns the “default value” for a type.

impl PartialEq for Overlay

fn eq(&self, other: &Overlay) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Overlay

impl StructuralPartialEq for Overlay