Struct AnyActorHandle 

pub struct AnyActorHandle { /* private fields */ }

A type-erased handle to a running actor whose concrete type is erased.

This handle intentionally does not expose typed messaging or binding APIs. Use AnyActorHandle::downcast to recover a typed ActorHandle when the concrete actor type is known.

Implementations

impl AnyActorHandle

pub fn actor_id(&self) -> &ActorAddr

The ActorAddr of the actor represented by this handle.

pub fn drain_and_stop(&self, reason: &str) -> Result<(), ActorError>

Signal the actor to drain its current messages and then stop.

pub fn stop(&self, reason: &str) -> Result<(), ActorError>

Signal the actor to stop without draining ordinary queued work first.

pub fn kill(&self, reason: &str) -> Result<(), ActorError>

Signal the actor to terminate immediately.

pub fn status(&self) -> Receiver<ActorStatus>

A watch that observes the lifecycle state of the actor.

pub fn downcast<A: Actor>(&self) -> Option<ActorHandle<A>>

Attempt to recover a typed actor handle.

pub fn into_guard(self) -> AnyActorGuard

Convert this handle into a guard that stops the actor when dropped.

Dropping the returned guard sends a normal stop signal. The guard does not wait for the actor to stop.

Trait Implementations

impl Clone for AnyActorHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnyActorHandle

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

Formats the value using the given formatter.

impl IntoFuture for AnyActorHandle

IntoFuture allows users to await the handle to join it. The future resolves when the actor runtime has fully stopped. The future resolves to the actor’s final status.

type Output = ActorStatus

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <AnyActorHandle as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.