EventBus

Struct EventBus 

Source
pub struct EventBus<A: Action, C: ComponentId> { /* private fields */ }
Expand description

Event bus that manages subscriptions and dispatches events

Generic over:

  • A: The action type (must implement Action)
  • C: The component ID type (must implement ComponentId)

Implementations§

Source§

impl<A: Action, C: ComponentId> EventBus<A, C>

Source

pub fn new(action_tx: UnboundedSender<A>) -> Self

Create a new event bus

Source

pub fn subscribe(&mut self, component: C, event_type: EventType)

Subscribe a component to an event type

Source

pub fn subscribe_many(&mut self, component: C, event_types: &[EventType])

Subscribe a component to multiple event types

Source

pub fn unsubscribe(&mut self, component: C, event_type: EventType)

Unsubscribe a component from an event type

Source

pub fn unsubscribe_all(&mut self, component: C)

Unsubscribe a component from all event types

Source

pub fn get_subscribers(&self, event_type: EventType) -> Vec<C>

Get subscribers for an event type

Source

pub fn get_event_subscribers(&self, event: &Event<C>) -> Vec<C>

Get all subscribers that should receive an event

Source

pub fn context_mut(&mut self) -> &mut EventContext<C>

Get mutable reference to context

Source

pub fn context(&self) -> &EventContext<C>

Get reference to context

Source

pub fn create_event(&self, kind: EventKind) -> Event<C>

Create an event with current context

Source

pub fn action_tx(&self) -> &UnboundedSender<A>

Get the action sender

Source

pub fn send(&self, action: A) -> Result<(), SendError<A>>

Send an action through the bus

Source

pub fn update_mouse_position(&mut self, x: u16, y: u16)

Update context from mouse position

Source

pub fn update_modifiers(&mut self, modifiers: KeyModifiers)

Update modifiers from key event

Auto Trait Implementations§

§

impl<A, C> Freeze for EventBus<A, C>
where C: Freeze,

§

impl<A, C> RefUnwindSafe for EventBus<A, C>
where C: RefUnwindSafe,

§

impl<A, C> Send for EventBus<A, C>
where C: Send,

§

impl<A, C> Sync for EventBus<A, C>
where C: Sync,

§

impl<A, C> Unpin for EventBus<A, C>
where C: Unpin,

§

impl<A, C> UnwindSafe for EventBus<A, C>
where C: UnwindSafe,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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