Skip to main content

EventBus

Struct EventBus 

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

Async event bus for broadcasting execution events to multiple subscribers.

Uses tokio’s broadcast channel internally. Subscribers receive all events emitted after they subscribe. Events are cloned for each subscriber.

Two delivery paths with different guarantees:

  • Sinks (add_sink) are invoked synchronously on the emitting thread before the broadcast — lossless and ordered. Trackers persist events through this path.
  • Subscribers (subscribe) receive via the broadcast channel — live but lossy under lag. Display/relay only.

Implementations§

Source§

impl EventBus

Source

pub fn new(capacity: usize) -> Self

Create a new event bus with the given channel capacity.

Source

pub fn add_sink(&self, sink: Arc<dyn EventSink>)

Register a lossless sink, called synchronously on every emit.

Source

pub fn remove_sink(&self, sink: &Arc<dyn EventSink>)

Unregister a previously added sink (matched by identity). The sink is flushed before removal.

Source

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

Emit an event: sinks first (lossless), then all subscribers. Returns the number of broadcast receivers that received the event. If there are no subscribers, the broadcast is silently dropped.

Source

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

Subscribe to receive events.

Source

pub fn subscriber_count(&self) -> usize

Number of active subscribers.

Source

pub fn flush_sinks(&self)

Flush all registered sinks.

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
§

impl<T> AsAny for T
where T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

The receiver as &dyn Any, ready for downcast_ref.
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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more