Skip to main content

EventBus

Struct EventBus 

Source
pub struct EventBus { /* private fields */ }
Expand description

A synchronous event bus with subscriptions, filtering, and dispatch.

Subscription IDs are sequential starting at 1.

Implementations§

Source§

impl EventBus

Source

pub fn new() -> Self

Creates an empty event bus.

Source

pub fn subscribe( &mut self, filter: impl Into<Option<EventType>>, callback: impl FnMut(&ObjectEvent) + Send + Sync + 'static, ) -> SubscriptionId

Subscribes a listener.

filter restricts the listener to a single EventType; None subscribes to all events. The returned SubscriptionId unsubscribes the listener.

Source

pub fn unsubscribe(&mut self, id: SubscriptionId)

Removes a subscription. Idempotent: unknown IDs are ignored.

If the listener list is currently detached (a dispatch round in progress on some thread), the removal is recorded and applied when the batch is reattached, so the unsubscribe takes effect for every later event even though the listener still observes the current one.

Source

pub fn dispatch(&mut self, event: &ObjectEvent)

Dispatches an event to all matching listeners, in subscription order.

See the module documentation for reentrancy semantics.

Source

pub fn listener_count(&self) -> usize

The number of active subscriptions.

Trait Implementations§

Source§

impl Default for EventBus

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.