Struct ActorHandle 

pub struct ActorHandle<M> { /* private fields */ }

Handle into an actor which can be used to send messages.

Implementations

impl<M> ActorHandle<M>

pub fn new_closed() -> Self

Create a closed (disconnected) handle useful for tests.

impl<M> ActorHandle<M>

where M: Send + 'static,

pub fn downgrade(self) -> WeakActorHandle<M>

Convert to weak actor handle.

pub fn tags(&self) -> &Tags

Get actor tags.

pub fn is_running(&self) -> bool

Check if actor is running.

Running means not initializing, stopping or stopped.

pub fn is_closed(&self) -> bool

Check if actor is closed.

Closed means not initializing or running.

pub async fn initialized(&self) -> Result<(), ActorError>

Wait for startup to be complete.

pub async fn closed(&self) -> Result<(), ActorError>

Wait for actor shutdown.

pub fn shutdown(&self)

Request shutdown.

pub fn dispatch(&self, message: impl Into<M>) -> Result<(), ActorError>

Dispatch message. Will only fail when the actor already has been stopped.

pub async fn request<T>( &self, message: impl FnOnce(Response<T>) -> M, ) -> Result<T, ActorError>

Request with response.

pub async fn try_request<T, E>( &self, message: impl FnOnce(Response<Result<T, E>>) -> M, ) -> Result<T, ActorError>

where E: Into<Error>,

Request with response result. If an error is returned in the result it will be wrapped in ´ActorError::Actor`.

pub fn stream<T>( &self, message: impl FnOnce(ResponseStream<T>) -> M, ) -> impl Stream<Item = Result<T, ActorError>>

Request with streaming response.

Errors

The stream only fails if the stream request could not be sent to the actor because it’s not running. In this case ActorError::InvalidState is returned and the stream ends after it.

pub fn stream_graceful<T>( &self, message: impl FnOnce(ResponseStream<T>) -> M, ) -> impl Stream<Item = T>

Request with streaming response. Gracefully ends the stream when the actor is not running.

pub fn stream_backpressure<T: Debug>( &self, buffer: usize, message: impl FnOnce(ResponseBackPressureStream<T>) -> M, ) -> impl Stream<Item = Result<T, ActorError>>

Request with streaming response with back-pressure.

Trait Implementations

impl<M> Clone for ActorHandle<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Debug for ActorHandle<M>

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

Formats the value using the given formatter.