Struct messages::mailbox::Mailbox

pub struct Mailbox<Input> { /* fields omitted */ }

Mailbox is an entity capable of receiving messages. It represents a receiver side of communication, and the sender side is represented using Address.

Implementations

impl<Input> Mailbox<Input>

pub fn new() -> Self

Creates a new Mailbox with a DEFAULT_CAPACITY.

pub fn with_capacity(capacity: usize) -> Self

Creates a new Mailbox with a provided capacity.

pub fn address(&self) -> Address<Input>

Creates an Address object to communicate with this Mailbox.

pub async fn receive<'_>(&'_ mut self) -> Result<Input, ReceiveError>

Awaits for the any message to come and returns it. Returns an error if either this Mailbox has received a stop request, but was not resumed, or if all the senders have disconnected already.

pub async fn run_with<F, Fut>(
    __arg0: Self,
    __arg1: F
) -> Result<(), ReceiveError> where
    F: FnMut(Input) -> Fut,
    Fut: Future<Output = ()>, 

Runs an infinite loop which will handle all the incoming requests. Loop may exit with an Ok(()) value if this Mailbox will receive a stop request, or with an Err value if all the senders will disconnect without providing a stop request.

pub fn resume(&mut self)

Enables a mailbox again after it received a stop request.

Trait Implementations

impl<Input: Debug> Debug for Mailbox<Input>

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

Formats the value using the given formatter.

impl<Input> Default for Mailbox<Input>

fn default() -> Self

Returns the "default value" for a type.