Struct ActorRef 

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

External handle to a running actor. Cloneable, Send + Sync.

Use this to send messages, make requests, or wait for the actor to stop. To stop the actor, send an explicit shutdown message through your protocol, or call Context::stop from within a handler.

Implementations

impl<A: Actor> ActorRef<A>

pub fn send<M>(&self, msg: M) -> Result<(), ActorError>

where A: Handler<M>, M: Message,

Send a fire-and-forget message to the actor.

pub fn request_raw<M>(&self, msg: M) -> Result<Receiver<M::Result>, ActorError>

where A: Handler<M>, M: Message,

Send a request and get a raw oneshot receiver for the reply.

pub async fn request<M>(&self, msg: M) -> Result<M::Result, ActorError>

where A: Handler<M>, M: Message,

Send a request and wait for the reply (default 5s timeout).

pub async fn request_with_timeout<M>( &self, msg: M, duration: Duration, ) -> Result<M::Result, ActorError>

where A: Handler<M>, M: Message,

Send a request and wait for the reply with a custom timeout.

pub fn recipient<M>(&self) -> Recipient<M>

where A: Handler<M>, M: Message,

Get a type-erased Recipient<M> for this actor.

pub fn context(&self) -> Context<A>

Get a Context<A> from this ref, for timer setup or stream listeners.

pub async fn join(&self)

Wait until the actor has fully stopped (including stopped() callback).

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<A, M> Receiver<M> for ActorRef<A>

where A: Actor + Handler<M>, M: Message,

fn send(&self, msg: M) -> Result<(), ActorError>

fn request_raw(&self, msg: M) -> Result<Receiver<M::Result>, ActorError>