Struct thespis_impl::Mailbox

pub struct Mailbox<A> where
    A: Actor,  { /* fields omitted */ }

The mailbox implementation.

Implementations

impl<A> Mailbox<A> where
    A: Actor, 

pub fn new(name: Option<&str>, rx: ChanReceiver<A>) -> Self

Create a new inbox.

pub fn info(&self) -> &ActorInfo

Getter for ActorInfo.

pub fn addr(&self, tx: ChanSender<A>) -> Addr<A>

Create an Addr to send messages to this mailbox.

pub async fn start(self, actor: A) -> MailboxEnd<A> where
    A: Send, 

Run the mailbox. Returns a future that processes incoming messages. If the actor panics during message processing, this will return the mailbox to you so you can supervise actors by re-initiating your actor and then calling this method on the mailbox again. All addresses will remain valid in this scenario.

This means that we use AssertUnwindSafe and catch_unwind when calling your actor and the thread will not unwind. This means that your actor should implement std::panic::UnwindSafe. This might become an enforced trait bound for Actor in the future.

Warning: if you drop the future returned by this function in order to stop an actor, Actor::stopped will not be called.

pub async fn start_local(self, actor: A) -> MailboxEnd<A>

Exactly as Mailbox::start, but works for !Send actors.

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

fn id(&self) -> usize

Get a unique identifier for this actor. You can use this to verify whether two addresss deliver to the same actor.

fn name(&self) -> Option<Arc<str>>

A human readable name of the actor.