Struct riddle_common::eventpub::EventSub

pub struct EventSub<T> { /* fields omitted */ }

An event subscriber which can filter incoming messages.

Example

#[derive(Clone)]
enum Message {
    Test(u32)
}

fn main() {
    let subscriber: EventSub<Message> = EventSub::new();

    // Attach to publisher
    // ...

    // At a later point consume events
    let events: Vec<Message> = subscriber.collect();
}

Implementations

impl<T> EventSub<T>

pub fn new() -> Self

Create a new EventSub which accepts all events

pub fn new_with_filter<F>(filter: F) -> Self where
    F: Fn(&T) -> bool + Send + Sync + 'static, 

Create a new EventSub which applies a filter on incoming events

Example

// Subscriber only accepts even numbered messages
let subscriber: EventSub<Message> = EventSub::new_with_filter(|Message::Test(v)| {
    v % 2 == 0
});

let publisher: EventPub<Message> = EventPub::new();
publisher.attach(&subscriber);

publisher.dispatch(Message::Test(0));
publisher.dispatch(Message::Test(1));
publisher.dispatch(Message::Test(2));

assert_eq!(vec![Message::Test(0), Message::Test(2)], subscriber.collect());

pub fn collect(&self) -> Vec<T>

Return all received events and clear the subscribers buffer.

Example

let subscriber: EventSub<Message> = EventSub::new();
let publisher: EventPub<Message> = EventPub::new();
publisher.attach(&subscriber);

publisher.dispatch(Message::Test(0));

// First collect consumes all pending events
assert_eq!(1, subscriber.collect().len());
// Leaving none for the second collect
assert_eq!(0, subscriber.collect().len());

Trait Implementations

impl<T: Clone> Default for EventSub<T>

fn default() -> Self

Returns the “default value” for a type.