Struct Mailbox

pub struct Mailbox<M> { /* private fields */ }

Shared single-threaded multi-sender multi-receiver message queue.

An instance of Mailbox is considered ‘authoritative’. You can use it to create senders, and register actors that should be notified.

You are not actually required to a mailbox, if your actor has a different mechanism for being notified.

Implementations

impl<M> Mailbox<M>

pub fn register(&self, id: Id)

Register an actor to be notified when this mailbox receives a message.

Only one actor can be registered at a time, setting this will remove the previous registration.

pub fn next(&self) -> Option<M>

Get the next message, if any is available.

pub fn sender(&self) -> Sender<M>

Create a sender for sending messages to this mailbox.

Trait Implementations

impl<M> Clone for Mailbox<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M> Default for Mailbox<M>

fn default() -> Self

Returns the “default value” for a type.