Struct heph_inbox::oneshot::Receiver

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

The receiving half of the one-shot channel.

This half can only be owned and used by one thread.

Implementations

impl<T> Receiver<T>

pub fn try_recv(&mut self) -> Result<(T, Sender<T>), RecvError>

Attempts to receive a value and reset the channel.

If it succeeds it returns the value and resets the channel, returning a new Sender (which can send a value to this Receiver).

pub fn recv<'r>(&'r mut self) -> RecvValue<'r, T>

Returns a future that receives a value from the channel, waiting if the channel is empty.

If the returned Future returns None it means the Sender is disconnected without sending a value. This is the same error as RecvError::Disconnected. RecvError::NoValue will never be returned, the Future will return Poll::Pending instead.

pub fn recv_once(self) -> RecvOnce<T>

Returns an owned version of Receiver::recv that can only be used once.

See Receiver::recv for more information.

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

Attempt to reset the channel.

If the sender is disconnected this will return a new Sender. If the sender is still connected this will return None.

Notes

If the channel contains a value it will be dropped.

pub fn is_connected(&self) -> bool

Returns true if the Sender is connected.

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: Send> Send for Receiver<T>

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