Struct Mailbox

pub struct Mailbox<A: Actor> { /* private fields */ }

A mailbox is the object that makes it possible to send a message to an actor.

It is lightweight to clone.

The actor holds its Inbox counterpart.

The mailbox can accept:

• Regular messages wrapped in envelopes. Their type depend on the actor and is defined when implementing the actor trait. (See [Envelope])
• Commands (See Command). Commands have a higher priority than messages: whenever a command is available, it is guaranteed to be processed as soon as possible regardless of the presence of pending regular messages.

If all mailboxes are dropped, the actor will process all of the pending messages and gracefully exit with crate::actor::ActorExitStatus::Success.

Implementations

impl<A: Actor> Mailbox<A>

pub fn id(&self) -> &str

impl<A: Actor> Mailbox<A>

pub fn actor_instance_id(&self) -> &str

pub async fn send_message<M>( &self, message: M, ) -> Result<Receiver<A::Reply>, SendError>

where A: Handler<M>, M: 'static + Send + Sync + Debug,

Sends a message to the actor owning the associated inbox.

From an actor context, use the ActorContext::send_message method instead.

SendError is returned if the actor has already exited.

pub async fn send_command(&self, command: Command) -> Result<(), SendError>

pub async fn ask<M, T>(&self, message: M) -> Result<T, AskError<Infallible>>

where A: Handler<M, Reply = T>, M: 'static + Send + Sync + Debug,

Similar to send_message, except this method waits asynchronously for the actor reply.

From an actor context, use the ActorContext::ask method instead.

pub async fn ask_for_res<M, T, E: Debug>( &self, message: M, ) -> Result<T, AskError<E>>

where A: Handler<M, Reply = Result<T, E>>, M: 'static + Send + Sync + Debug,

Similar to send_message, except this method waits asynchronously for the actor reply.

From an actor context, use the ActorContext::ask method instead.

Trait Implementations

impl<A: Actor> Clone for Mailbox<A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Actor> Debug for Mailbox<A>

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

Formats the value using the given formatter.

impl<A: Actor> Hash for Mailbox<A>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<A: Actor> PartialEq for Mailbox<A>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A: Actor> Eq for Mailbox<A>