Struct EventBus 

pub struct EventBus { /* private fields */ }

Multi-producer, multi-consumer event hub.

EventBus is Clone because it is meant to be handed to as many tasks as need to publish or subscribe; clones share the same underlying channel.

Implementations

impl EventBus

pub fn new(capacity: usize) -> Self

Creates a new bus with the given channel capacity.

A capacity of zero is silently raised to one so the underlying broadcast channel does not panic.

pub fn publish(&self, event: Event) -> usize

Publishes an event to all current subscribers.

Returns the number of subscribers that received the event, or 0 if none were attached. Unlike broadcast::Sender::send, a missing subscriber is not treated as an error: events are best-effort and callers should not block their own work because nobody is listening.

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

Returns a fresh subscription that yields every event published from this point on.

pub fn receiver_count(&self) -> usize

Returns the current number of active subscribers.

Trait Implementations

impl Clone for EventBus

fn clone(&self) -> EventBus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventBus

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

Formats the value using the given formatter.

impl Default for EventBus

fn default() -> Self

Returns the “default value” for a type.