Struct heph_inbox::Receiver

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

Receiving side of the channel.

Implementations

impl<T> Receiver<T>

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

Attempts to receive a value from this channel.

pub fn recv(&mut self) -> RecvValue<'_, 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 all Senders are disconnected. This is the same error as RecvError::Disconnected. RecvError::Empty will never be returned, the Future will return Poll::Pending instead.

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

Attempts to peek a value from this channel.

pub fn peek(&mut self) -> PeekValue<'_, T>

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

If the returned Future returns None it means all Senders are disconnected. This is the same error as RecvError::Disconnected. RecvError::Empty will never be returned, the Future will return Poll::Pending instead.

pub fn new_sender(&self) -> Sender<T>

Create a new Sender that sends to this channel.

Safety

The same restrictions apply to this function as they do to Sender::clone.

pub fn capacity(&self) -> usize

Returns the capacity of the channel.

pub fn is_connected(&self) -> bool

Returns false if all Senders are disconnected.

Notes

Unlike Sender::is_connected this method doesn’t take the Manager into account. This means that this method can return false and later true (if the Manager created another Sender), which might be unexpected.

pub fn has_manager(&self) -> bool

Returns true if the Manager is connected.

pub fn register_waker(&mut self, waker: &Waker) -> bool

Set the receiver’s waker to waker, if they are different. Returns true if the waker is changed, false otherwise.

This is useful if you can’t call Receiver::recv but still want a wake-up notification once messages are added to the inbox.

pub fn id(&self) -> Id

Returns the id of this receiver.

Trait Implementations

impl<T: Debug> 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> Sync for Receiver<T>

impl<T> Unpin for Receiver<T>