Struct Event 

pub struct Event { /* private fields */ }

Event type emitted by an Awareness struct.

Implementations

impl Event

pub fn new( added: Vec<ClientID>, updated: Vec<ClientID>, removed: Vec<ClientID>, ) -> Self

pub fn summary(&self) -> &AwarenessUpdateSummary

pub fn added(&self) -> &[ClientID]

Collection of new clients that have been added to an Awareness struct, that was not known before. Actual client state can be accessed via awareness.clients().get(client_id).

pub fn updated(&self) -> &[ClientID]

Collection of new clients that have been updated within an Awareness struct since the last update. Actual client state can be accessed via awareness.clients().get(client_id).

pub fn removed(&self) -> &[ClientID]

Collection of new clients that have been removed from Awareness struct since the last update.

pub fn all_changes(&self) -> Vec<ClientID>

Returns all the changed client IDs (added, updated and removed) combined.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl PartialEq for Event

fn eq(&self, other: &Event) -> 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 StructuralPartialEq for Event