Struct flume::Receiver

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

The receiving end of a channel.

Implementations

impl<T> Receiver<T>

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

Wait for an incoming value from the channel associated with 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 from the channel associated with 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 from the channel associated with this receiver, returning an error if all channel senders have been dropped or the deadline has passed.

pub fn recv_async(&mut self) -> RecvFuture<T>ⓘ

Important traits for RecvFuture<'a, T>

impl<'a, T> Future for RecvFuture<'a, T> type Output = Result<T, RecvError>;

Create a future that may be used to wait asynchronously for an incoming value on the channel associated with this receiver.

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

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

pub fn iter(&self) -> Iter<T>ⓘ

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> type 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) -> TryIter<T>ⓘ

Important traits for TryIter<'a, T>

impl<'a, T> Iterator for TryIter<'a, T> type 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.

pub fn drain(&self) -> Drain<T>ⓘ

Important traits for Drain<'a, T>

impl<'a, T> Iterator for Drain<'a, T> type Item = T;

Take all items currently sitting in the channel and produce an iterator over them. Unlike try_iter, the iterator will not attempt to fetch any more values from the channel once the function has been called.

Trait Implementations

impl<T> Debug for Receiver<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> FusedStream for Receiver<T>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

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.

impl<T> Stream for Receiver<T>

type Item = T

Values yielded by the stream.

fn poll_next(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.

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

Returns the bounds on the remaining length of the stream.