Struct theatre::prelude::Addr

pub struct Addr<A> where
    A: 'static + Actor,  { /* fields omitted */ }

An Address to an Actor. Actor addresses allow for messages to be sent to actors.

A message must implement Messageand the actor that should receive it needs to implement Handler<M> where M is the message type.

Addresses are parametrized over the Actor they point to. To obtain an address that is parametrized over the message type call recipient().

Addresses keep actors running. Once all addresses are dropped the actor will stop. To obtain an address to an actor without keeping it alive call downgrade() to get a WeakAddr (similar to Arc & WeakArc).

Implementations

impl<A> Addr<A> where
    A: Actor + Send, 

pub async fn send<M>(&mut self, msg: M) -> Result<M::Return, TheatreError> where
    A: Handler<M>,
    M: Message + 'static, 

Send a message and wait for the response. If the mailbox is full wait until there is capacity.

pub async fn try_send<M>(&mut self, msg: M) -> Result<M::Return, TheatreError> where
    A: Handler<M>,
    M: Message + 'static, 

Try send a message and wait for the response. If the mailbox is full or dropped return an error.

pub fn try_send_and_forget<M>(&mut self, msg: M) -> Result<(), TheatreError> where
    A: Handler<M>,
    M: Message + 'static, 

Try to send a message and discard the result. If the mailbox is full or dropped return an error.

pub fn recipient<M>(self) -> Recipient<M> where
    A: Handler<M>,
    M: 'static + Message, 

Obtain a recipient to the actor.

pub fn downgrade(&self) -> WeakAddr<A>

Downgrade the address into a WeakAddr

Trait Implementations

impl<A> Clone for Addr<A> where
    A: Actor, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> Debug for Addr<A> where
    A: Actor, 

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

Formats the value using the given formatter.

impl<A> Drop for Addr<A> where
    A: Actor, 

fn drop(&mut self)

Executes the destructor for this type.