Skip to main content

EventDispatcher

Struct EventDispatcher 

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

Global event dispatcher.

The dispatcher maintains a registry of listeners for each event type. When an event is dispatched, all registered listeners are called in priority order.

Implementations§

Source§

impl EventDispatcher

Source

pub fn new() -> Self

Create a new event dispatcher.

Source

pub fn listen<E, L>(&self, listener: L)
where E: Event, L: Listener<E>,

Register a listener for an event type.

§Example
use ferro_events::{EventDispatcher, Event, Listener, Error, async_trait};

#[derive(Clone)]
struct MyEvent;
impl Event for MyEvent {
    fn name(&self) -> &'static str { "MyEvent" }
}

struct MyListener;

#[async_trait]
impl Listener<MyEvent> for MyListener {
    async fn handle(&self, _event: &MyEvent) -> Result<(), Error> {
        Ok(())
    }
}

let dispatcher = EventDispatcher::new();
dispatcher.listen(MyListener);
Source

pub fn listen_with_priority<E, L>(&self, listener: L, priority: i32)
where E: Event, L: Listener<E>,

Register a listener with a specific priority.

Higher priority listeners are called first.

Source

pub fn on<E, F, Fut>(&self, handler: F)
where E: Event, F: Fn(E) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), Error>> + Send + 'static,

Register a closure as a listener.

§Example
use ferro_events::{EventDispatcher, Event, Error};

#[derive(Clone)]
struct UserCreated { id: i64 }
impl Event for UserCreated {
    fn name(&self) -> &'static str { "UserCreated" }
}

let dispatcher = EventDispatcher::new();
dispatcher.on(|event: UserCreated| async move {
    println!("User {} created", event.id);
    Ok::<(), Error>(())
});
Source

pub async fn dispatch<E: Event>(&self, event: E) -> Result<(), Error>

Dispatch an event to all registered listeners.

Returns Ok(()) if all listeners succeeded, or the first error encountered.

Source

pub fn dispatch_async<E: Event + 'static>(&self, event: E)

Dispatch an event without waiting for listeners to complete.

This spawns the event handling as a background task.

Source

pub fn has_listeners<E: Event>(&self) -> bool

Check if any listeners are registered for an event type.

Source

pub fn forget<E: Event>(&self)

Remove all listeners for an event type.

Source

pub fn flush(&self)

Remove all listeners.

Trait Implementations§

Source§

impl Default for EventDispatcher

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
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, 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