Skip to main content

EventBus

Struct EventBus 

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

A fan-out event bus backed by a bounded broadcast channel.

Each subscriber receives an independent broadcast::Receiver to drain on its own task. Sending never blocks and no lock is held while receivers handle events. If a receiver falls behind its bounded buffer, Tokio’s broadcast channel reports a lag error to that receiver on its next receive.

Implementations§

Source§

impl EventBus

Source

pub const DEFAULT_CAPACITY: usize = 256

The default event buffer capacity.

Source

pub fn new(capacity: usize) -> Self

Create a bus with the given bounded buffer capacity.

Tokio broadcast channels require a non-zero capacity, so a capacity of zero is treated as one.

Source

pub fn new_default() -> Self

Create a bus with the default buffer capacity.

Source

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

Subscribe to future events.

The caller owns the returned receiver and should drain it, typically on a dedicated task.

Source

pub fn emit(&self, event: RunEvent) -> bool

Emit an event to all current subscribers.

Returns false when there are no active receivers. Sending is non-blocking; slow receivers observe broadcast::error::RecvError::Lagged when they next receive.

Trait Implementations§

Source§

impl Clone for EventBus

Source§

fn clone(&self) -> EventBus

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for EventBus

Source§

fn default() -> Self

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

impl EventSink for EventBus

EventBus satisfies the core EventSink trait so it can be passed to run_agent via RunHooks.

Source§

fn emit(&self, event: RunEvent)

Emit event to all subscribers. Non-blocking; returns immediately.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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