Skip to main content

EventEmitter

Struct EventEmitter 

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

Callback-based event subscription system.

Embed in MapState and call dispatch each frame with the events drained from InteractionManager.

Implementations§

Source§

impl EventEmitter

Source

pub fn new() -> Self

Create an empty event emitter.

Source

pub fn on<F>(&mut self, kind: InteractionEventKind, callback: F) -> ListenerId
where F: Fn(&InteractionEvent) + Send + Sync + 'static,

Subscribe to events of a given kind.

Returns a ListenerId that can later be passed to off.

Source

pub fn once<F>(&mut self, kind: InteractionEventKind, callback: F) -> ListenerId
where F: Fn(&InteractionEvent) + Send + Sync + 'static,

Subscribe to a single occurrence of an event kind.

The listener is automatically removed after the first dispatch.

Source

pub fn off(&mut self, id: ListenerId) -> bool

Unsubscribe a previously registered listener.

Returns true if the listener was found and removed.

Source

pub fn dispatch(&mut self, events: &[InteractionEvent])

Dispatch a batch of events to all matching listeners.

once listeners are removed after their first invocation.

Source

pub fn listener_count(&self) -> usize

Number of active listeners.

Source

pub fn listener_count_for(&self, kind: InteractionEventKind) -> usize

Number of listeners for a specific event kind.

Trait Implementations§

Source§

impl Default for EventEmitter

Source§

fn default() -> Self

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

impl Send for EventEmitter

Source§

impl Sync for EventEmitter

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