Struct eventador::Subscriber

pub struct Subscriber<'a, T> { /* fields omitted */ }

A handle to receive events that were subscribed to from the event-bus

The Subscriber will not receive intended events that were published to the event-bus before time of subscription. It will only receive intended events that are published after the time of subscription, as they will have a higher sequence number than the Subscriber's internal sequence value.

Example

Basic usage:

let eventbus = Eventador::new(4)?;

// subscribe first, before publishing!
let subscriber = eventbus.subscribe::<usize>();

let mut i: usize = 1234;
eventbus.publish(i);

let mut msg = subscriber.recv().unwrap();
assert_eq!(i, *msg);

Implementations

impl<'a, T> Subscriber<'a, T> where
    T: 'static + Send, 

pub fn sequence(&self) -> u64

Get the current internal sequence number for the Subscriber

This sequence number signifies what events the Subscriber may have already read, and any events with a sequence value higher than this are events that are still unread.

pub fn recv<'b>(&self) -> Option<EventRead<'b, T>>

Synchronously read an event of the correct type from the event-bus

Example

Basic usage:

let eventbus = Eventador::new(4)?;
let subscriber = eventbus.subscribe::<usize>();

let mut i: usize = 1234;
eventbus.publish(i);

let mut msg = subscriber.recv().unwrap();
assert_eq!(i, *msg);