Struct WeakActorRef

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

A reference to an actor that allows messages to be sent to the actor.

If the actor has been dropped, this WeakActorRef will not be able to send messages to the actor, and will not be able to be upgraded.

Implementations

impl<A: Actor> WeakActorRef<A>

pub fn upgrade(&self) -> Option<ActorRef<A>>

Attempts to upgrade this WeakActorRef to an ActorRef. If the actor has been dropped, this will return None.

pub async fn send(&self, msg: A::Message) -> Result<(), A::Message>

Sends a message to the actor. If the actor has been dropped, or the mailbox is full, the message will be returned in Err.

pub fn stop(&self, stop: A::Message) -> Result<(), A::Message>

Stops the actor by sending a stop message to it. If the actor has been dropped, or the mailbox is full, the stop message will be returned in Err.

Trait Implementations

impl<A: Actor> Clone for WeakActorRef<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: Debug + Actor> Debug for WeakActorRef<A>

where A::Message: Debug,

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

Formats the value using the given formatter.

impl<A: Actor> TryInto<ActorRef<A>> for WeakActorRef<A>

type Error = ()

The type returned in the event of a conversion error.

fn try_into(self) -> Result<ActorRef<A>, Self::Error>

Performs the conversion.