Skip to main content

EventBus

Struct EventBus 

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

A broadcast event bus that fans out GameEvent values to subscribers.

Wraps a tokio::sync::broadcast channel. The bus owns the sender half; each call to subscribe creates a new receiver that independently tracks its read position.

§Capacity

The channel has a fixed capacity set at construction time (default 256). When the channel is full the oldest message is overwritten, and any subscriber that has not yet read it will receive a lag notification on its next recv().

Implementations§

Source§

impl EventBus

Source

pub fn new(capacity: usize) -> Self

Creates a new event bus with the given channel capacity.

capacity is the maximum number of events that can be buffered before the oldest event is overwritten. Values below 1 are clamped to 1 (the minimum tokio::broadcast allows).

Source

pub fn with_default_capacity() -> Self

Creates a new event bus with the default capacity (256).

Source

pub fn send(&self, event: GameEvent) -> usize

Sends a GameEvent to all current subscribers.

Returns the number of subscribers that received the event. If there are no active subscribers the event is silently dropped and 0 is returned.

Source

pub fn subscribe(&self) -> Subscriber

Creates a new Subscriber that will receive all future events.

Subscribers can be added at any time. A new subscriber starts receiving events from the next send() call; it does not see events that were sent before it subscribed.

Source

pub fn subscriber_count(&self) -> usize

Returns the current number of active subscribers (receivers).

Trait Implementations§

Source§

impl Clone for EventBus

Source§

fn clone(&self) -> EventBus

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EventBus

Source§

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

Formats the value using the given formatter. 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> 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, 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> 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.