Struct eventador::AsyncSubscriber

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

A handle to subscribe to events and receive them asynchronously.

Implements the [Stream] trait to offer subscribed events from the event-bus as an asynchronous stream.

Example

Basic usage:

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

let subscriber = eventbus.async_subscriber::<usize>();
let mut publisher: AsyncPublisher<usize> = eventbus.async_publisher();

let mut i: usize = 1234;
publisher.send(i).await?;

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

Implementations

impl<'a, T> AsyncSubscriber<'a, T> where
    T: Send, 

pub fn sequence(&self) -> u64

This is supported on crate feature async only.

Get the current internal sequence number for the AsyncSubscriber.

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.

Trait Implementations

impl<'a, T: 'static> Stream for AsyncSubscriber<'a, T>

This is supported on crate feature async only.

type Item = EventRead<'a, T>

Values yielded by the stream.

fn poll_next(
    mut self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.