Struct Mailbox 

pub struct Mailbox { /* private fields */ }

The receiving end of a process mailbox.

This is held by the process and used to receive messages.

Implementations

impl Mailbox

pub fn new() -> (Self, MailboxSender)

Creates a new mailbox, returning the mailbox and its sender.

pub async fn recv(&mut self) -> Option<Envelope>

Receives the next message, blocking until one is available.

Returns None if all senders have been dropped.

pub async fn recv_timeout( &mut self, duration: Duration, ) -> Result<Option<Envelope>, ()>

Receives the next message with a timeout.

Returns Ok(Some(envelope)) if a message was received, Ok(None) if all senders were dropped, or Err(()) if the timeout elapsed.

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

Tries to receive a message without blocking.

Returns Ok(envelope) if a message was available, Err(TryRecvError::Empty) if no message was available, or Err(TryRecvError::Disconnected) if all senders were dropped.

pub fn close(&mut self)

Closes the mailbox, preventing any further messages from being sent.