simple_event_bus 0.0.4

A basic, simple event bus in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

use super::Event;

/// # Subscriber
/// 
/// A subscriber is a listener that is linked to an event bus.
/// This is defined by the Subscriber trait, which can be implemented
/// by any type that wants to subscribe to an event bus.
/// 
/// The subscriber will receive an event when the event bus is run.
/// It will be called through the on_event method, where it
/// will also recieve an event (and the data that is held by the event).
/// 
/// ## Type Parameters
/// 
/// * `Input` - The type of data that is held by the event.
/// 
/// ## Methods
/// 
/// * `on_event` - Called when the event bus is run.
pub trait Subscriber {
    /// The type of data that is held by the event.
    type Input;

    /// Called when the event bus is run.
    fn on_event(&mut self, event: &Event<Self::Input>);
}