Struct flume::Receiver

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

The receiving end of a channel.

Methods

impl<T> Receiver<T>

pub fn recv(&self) -> Result<T, RecvError>

Wait for an incoming value on this receiver, returning an error if all channel senders have been dropped.

pub fn recv_timeout(&self, timeout: Duration) -> Result<T, RecvTimeoutError>

Wait for an incoming value on this receiver, returning an error if all channel senders have been dropped or the timeout has expired.

pub fn recv_deadline(&self, deadline: Instant) -> Result<T, RecvTimeoutError>

Wait for an incoming value on this receiver, returning an error if all channel senders have been dropped or the deadline has passed.

pub fn try_recv(&self) -> Result<T, TryRecvError>

Attempt to fetch an incoming value on this receiver, returning an error if the channel is empty or all channel senders have been dropped.

pub fn iter(&self) -> impl Iterator<Item = T> + '_

A blocking iterator over the values received on the channel that finishes iteration when all receivers of the channel have been dropped.

pub fn try_iter(&self) -> impl Iterator<Item = T> + '_

A non-blocking iterator over the values received on the channel that finishes iteration when all receivers of the channel have been dropped or the channel is empty.

Trait Implementations

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> IntoIterator for Receiver<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.