Struct zng::event::EventReceiver

pub struct EventReceiver<A>
where
    A: EventArgs + Send,
{ /* private fields */ }

An event channel receiver.

Use Event::receiver to create a receiver, drop to stop listening.

Implementations

impl<A> EventReceiver<A>

where A: EventArgs + Send,

pub fn recv(&self) -> Result<A, AppDisconnected<()>>

Receives the oldest update, blocks until the event updates.

Note that oldest here refers to send order (FIFO), not the args creation timestamp.

pub fn try_recv(&self) -> Result<A, Option<AppDisconnected<()>>>

Tries to receive the oldest sent update not received, returns Ok(args) if there was at least one update, or returns Err(None) if there was no update or returns Err(AppDisconnected) if the connected app has exited.

pub fn recv_deadline( &self, deadline: Instant, ) -> Result<A, TimeoutOrAppDisconnected>

Receives the oldest send update, blocks until the event updates or until the deadline is reached.

pub fn recv_timeout(&self, dur: Duration) -> Result<A, TimeoutOrAppDisconnected>

Receives the oldest send update, blocks until the event updates or until timeout.

pub async fn recv_async(&self) -> Result<A, AppDisconnected<()>>

Returns a future that receives the oldest send update, awaits until an event update occurs.

pub fn into_recv_async( self, ) -> impl Future<Output = Result<A, AppDisconnected<()>>> + Send + Sync + 'static

Turns into a future that receives the oldest send update, awaits until an event update occurs.

pub fn iter(&self) -> Iter<'_, A>

Creates a blocking iterator over event updates, if there are no updates sent the iterator blocks, the iterator only finishes when the app shuts-down.

pub fn try_iter(&self) -> TryIter<'_, A>

Create a non-blocking iterator over event updates, the iterator finishes if there are no more updates sent.

pub fn event(&self) -> Event<A>

Event that sends to this receiver.

Trait Implementations

impl<A> Clone for EventReceiver<A>

where A: EventArgs + Send,

fn clone(&self) -> EventReceiver<A>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A> Debug for EventReceiver<A>

where A: EventArgs + Send,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a, A> IntoIterator for &'a EventReceiver<A>

where A: EventArgs + Send,

type Item = A

The type of the elements being iterated over.

type IntoIter = Iter<'a, A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a EventReceiver<A> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<A> IntoIterator for EventReceiver<A>

where A: EventArgs + Send,

type Item = A

The type of the elements being iterated over.

type IntoIter = IntoIter<A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <EventReceiver<A> as IntoIterator>::IntoIter

Creates an iterator from a value.