Struct safina_executor::Receiver

pub struct Receiver<T> where
    T: Send,  { /* private fields */ }

The receiving half of a channel. This half can only be owned by one thread.

To receive messages sent to the channel, call async_recv or one of the blocking receive methods.

Implementations

impl<T> Receiver<T> where
    T: Send, 

pub async fn async_recv(&'_ mut self) -> Result<T, RecvError>

Attempts to wait for a value on this receiver, returning an error if the corresponding channel has hung up.

The future returned by this function completes when there is data available or it’s not possible for more data to be sent (because all senders were dropped). Once a message is sent to the corresponding sender, this receiver will wake up and return that message.

If the corresponding sender has disconnected, or it disconnects while this call is blocking, this call will wake up and return Err to indicate that no more messages can ever be received on this channel. However, since channels are buffered, messages sent before the disconnect will still be properly received.

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

Attempts to return a pending value on this receiver without blocking.

This method will never block the caller in order to wait for data to become available. Instead, this will always return immediately with a possible option of pending data on the channel.

This is useful for a flavor of “optimistic check” before deciding to block on a receiver.

Compared with recv, this function has two failure cases instead of one (one for disconnection, one for an empty buffer).

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

Attempts to wait for a value on this receiver, returning an error if the corresponding channel has hung up.

This function will always block the current thread if there is no data available and it’s possible for more data to be sent (at least one sender still exists). Once a message is sent to the corresponding sender, this receiver will wake up and return that message.

If the corresponding sender has disconnected, or it disconnects while this call is blocking, this call will wake up and return Err to indicate that no more messages can ever be received on this channel. However, since channels are buffered, messages sent before the disconnect will still be properly received.

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

Attempts to wait for a value on this receiver, returning an error if the corresponding channel has hung up, or if it waits more than timeout.

This function will always block the current thread if there is no data available and it’s possible for more data to be sent (at least one sender still exists). Once a message is sent to the corresponding sender, this receiver will wake up and return that message.

If the corresponding sender has disconnected, or it disconnects while this call is blocking, this call will wake up and return Err to indicate that no more messages can ever be received on this channel. However, since channels are buffered, messages sent before the disconnect will still be properly received.

Known Issues

There is currently a known issue in the inner std::sync::mpsc::Receiver that can cause recv_timeout to panic unexpectedly. See the explanation at std::sync::mpsc::Receiver::recv_timeout.

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

Returns an iterator that will block waiting for messages, but never panic. It will return None when the channel has hung up.

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

Returns an iterator that will attempt to yield all pending values. It will return None if there are no more pending values or if the channel has hung up. The iterator will never panic or block the user by waiting for values.

Trait Implementations

impl<T> Debug for Receiver<T> where
    T: Send, 

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

Formats the value using the given formatter.

impl<T> Drop for Receiver<T> where
    T: Send, 

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> IntoIterator for &'a Receiver<T> where
    T: Send, 

type Item = T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<T> IntoIterator for Receiver<T> where
    T: Send, 

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) -> IntoIter<T>

Creates an iterator from a value.