Struct Event 

pub struct Event<T> {
    pub data: T,
}

Event

An event is a struct that can hold any data type. It is then published to the event bus. Once published, the event is then passed to each subscriber when the event bus runs.

Fields

• data - The data that is held by the event.

Methods

• new - Creates a new event.

• get_data - Returns the data held by the event.

Fields

data: T

The data that is held by the event.

Implementations

impl<T> Event<T>

pub fn new(data: T) -> Event<T>

New

Creates a new event.

Examples found in repository

examples/01.rs (line 29)

fn main() {
    let mut event_bus = EventBus::new();

    // We have to manually create and add each subscriber to the event bus.
    event_bus.subscribe_listener(ExampleSubscriber::new("Subscriber 1".to_string()));
    event_bus.subscribe_listener(ExampleSubscriber::new("Subscriber 2".to_string()));

    // We can manually define an event and publish it to the event bus.
    event_bus.publish(Event::new("hello".to_string()));
    event_bus.publish(Event::new("world".to_string()));

    // Alternatively, we can use the From trait to define an event and publish it to the event bus.
    // This is as simple as using ".into()" on the data (so long as it matches the event bus's type parameter).
    event_bus.publish("!".to_string().into());

    // Here we show another example, this time directly from a String instead of using &str.
    let test_string = String::from("Hello, World!");
    event_bus.publish(test_string.into());

    // Runs through each event, and calls each listener's on_event method.
    event_bus.run();
}

pub fn get_data(&self) -> &T

Get Data

Returns the data held by the event.

Examples found in repository

examples/01.rs (line 17)

    fn on_event(&mut self, event: &Event<Self::Input>) {
        println!("{} received message: {}", self.name, event.get_data());
    }

Trait Implementations

impl<T> From<T> for Event<T>

fn from(data: T) -> Self

Converts to this type from the input type.