Struct suspend_channel::Receiver

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

Created by channel() and used to receive a stream of values from an associated Sender.

Implementations

impl<T> Receiver<T>

pub fn cancel(self) -> Option<T>

Safely cancel the receive operation, consuming the Receiver.

pub fn try_recv(&mut self) -> Poll<Option<T>>

Try to receive the next value from the stream.

pub fn wait_next(&mut self) -> Option<T>

Block the current thread on the next result from the Sender, returning None if the sender has been dropped.

pub fn wait_next_timeout(
    &mut self,
    timeout: impl Expiry
) -> Result<Option<T>, TimedOut>

Block the current thread on the next result from the Sender, returning Ok(None)] if the sender has been dropped and Err(Incomplete) if the provided timeout is reached.

Trait Implementations

impl<T: Debug> Debug for Receiver<T>

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

Formats the value using the given formatter.

impl<T> Drop for Receiver<T>

pub fn drop(&mut self)

Executes the destructor for this type.

impl<T> FusedStream for Receiver<T>

pub fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T: Send> Send for Receiver<T>

impl<T> Stream for Receiver<T>

type Item = T

Values yielded by the stream.

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

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.

impl<T: Send> Sync for Receiver<T>