Struct ActorMonitor 

pub struct ActorMonitor { /* private fields */ }

A handle to a child actor that monitors another actor’s liveness.

Implementations

impl ActorMonitor

pub fn spawn_persistent<C>(cx: &C, target: ActorAddr) -> Self

where C: Actor,

Spawn a persistent monitor actor for target as a child of cx.

A persistent monitor polls the target’s status for as long as it runs.

pub fn spawn_dormant<C>(cx: &C, target: ActorAddr) -> Self

where C: Actor,

Spawn a monitor actor for target as a child of cx, starting dormant.

The monitor is active, polling the target’s status, while at least one MonitorActivation from Self::activate is live, and dormant otherwise. It receives the target’s terminal-status notification in either state. This lets callers share one monitor across intermittent waits without polling between them.

pub fn target(&self) -> &ActorAddr

The actor being monitored.

pub fn status(&self) -> MonitorStatus

Return the monitor’s current status.

pub fn activate(&self, cx: &impl Actor) -> MonitorActivation

Keep the monitor active, polling the target’s status, until the returned activation is dropped.

Activations are counted; the monitor is active while any is live. When a dormant monitor becomes active, the first poll waits for the initial delay, so short-lived waits that the terminal-status notification resolves never poll. The monitor goes dormant at its first tick after the last activation is dropped and sends no further polls; reactivating it before then keeps its current poll schedule.

pub fn into_supervisor<C>(self, cx: &C) -> ActorSupervisor

where C: Actor,

Convert this monitor into one that reports detected failures through actor supervision.

pub async fn guard<F>(&self, fut: F) -> Result<F::Output, MonitorFailure>

where F: Future,

Run fut until it completes or the monitor fails.

pub async fn recv<M>( &self, receiver: &mut PortReceiver<M>, ) -> Result<Result<M, MailboxError>, MonitorFailure>

where M: Message,

Receive the next message from receiver or return a monitor failure.

Trait Implementations

impl Debug for ActorMonitor

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

Formats the value using the given formatter.

impl Drop for ActorMonitor

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.