Struct Mailbox 

pub struct Mailbox { /* private fields */ }

An agent’s inbound queue plus send handles to its peers.

cache holds messages already pulled off the channel but not yet withdrawn — set aside by a sender-selective recv_from that skipped past them. They are the oldest messages, so plain recv drains the cache before the channel.

Implementations

impl Mailbox

pub fn send_to(&self, to: &str, bytes: impl Into<Vec<u8>>) -> Result<()>

Send bytes to the agent named to.

Fails with TestkitError::UnknownAgent when no such agent exists, or TestkitError::MailboxClosed when the recipient has already finished.

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

Wait for the next message from any sender, or None once every peer has finished. Cached messages (set aside by recv_from) come first, oldest to newest, before anything still on the channel.

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

Take a pending message from any sender without waiting.

pub async fn recv_from_any(&mut self, from: &[&str]) -> Option<Envelope>

Wait for the next message from any of the agents named in from, or None once every peer has finished without one arriving.

Messages from senders outside the set that arrive first are cached in order and remain available to later recv / recv_from* calls, so selecting by sender does not drop anyone else’s messages.

pub fn try_recv_from_any(&mut self, from: &[&str]) -> Option<Envelope>

Take a pending message from any of the agents named in from without waiting. Non-matching messages already waiting are cached, not dropped.

pub async fn recv_from(&mut self, from: &str) -> Option<Envelope>

Wait for the next message from the agent named from, or None once every peer has finished without one arriving.

pub fn try_recv_from(&mut self, from: &str) -> Option<Envelope>

Take a pending message from the agent named from without waiting.

Trait Implementations

impl Debug for Mailbox

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

Formats the value using the given formatter.