Struct EventMap

pub struct EventMap { /* private fields */ }

An event map which allows sending messages to a set of channels

Implementations

impl EventMap

pub fn new() -> Self

Create a new EventMap

pub fn register_stream<T: Clone + 'static>(&mut self) -> EventStream<T>

Register this type with the EventMap, returning a clonable Receiver end

pub fn register_iter<T: Clone + 'static>(&mut self) -> EventIter<T>

Register this type with the EventMap, returning a clonable Receiver end

pub fn send<T: Clone + 'static>(&mut self, msg: T) -> bool

Send this message to anything listening for it

This will automatically clean up any stale senders after it fails to send

pub fn active<T: 'static>(&self) -> usize

Get the number of potential listeners for this message

pub fn is_empty<T: 'static>(&self) -> bool

Determine whether there are any listeners for this message

pub fn get_senders<T: 'static>(&self) -> Option<Senders<'_, T>>

Get an iterator of all senders for this type

The iterator will be over the (Id, Sender<T>)

This returns None if no active senders are available

pub fn reset(&mut self)

Reset this EventMap, causing all pending Receivers to end.

After doing this, you’ll need to re-register all subscriptions

Trait Implementations

impl Default for EventMap

fn default() -> EventMap

Returns the “default value” for a type.