Enum ActorFailure 

pub enum ActorFailure<T: Actor> {
    OnStart {
        error: T::Error,
    },
    OnIdle {
        actor: T,
        error: T::Error,
    },
    OnStop {
        actor: T,
        error: T::Error,
    },
    OnIdleThenOnStop {
        actor: T,
        error: T::Error,
        stop_error: T::Error,
    },
}

Phase-specific payload of a failed actor lifecycle.

Each variant carries exactly the data that can exist in that phase, so the invariants that were previously documentation-only are enforced by the type system:

• Only OnStart lacks an actor instance (the actor was never constructed).
• Only OnIdleThenOnStop carries a second error (the on_stop cleanup failure after the primary on_idle failure).

Use the accessors (phase, error, actor, stop_error) for uniform access across variants, or match directly when handling a specific phase.

Variants

OnStart

on_start returned an error; the actor was never constructed, so no instance is available.

Fields

error: T::Error

The error returned by on_start.

OnIdle

on_idle returned an error and the subsequent on_stop cleanup succeeded.

Fields

actor: T

The actor instance, recovered for inspection or restart.

error: T::Error

The error returned by on_idle.

OnStop

on_stop returned an error during shutdown.

Fields

actor: T

The actor instance, recovered for inspection or restart.

error: T::Error

The error returned by on_stop.

OnIdleThenOnStop

on_idle returned an error, and then on_stop also failed while cleaning up.

Fields

actor: T

The actor instance, recovered for inspection or restart.

error: T::Error

The primary error returned by on_idle.

stop_error: T::Error

The secondary error returned by on_stop during cleanup.

Implementations

impl<T: Actor> ActorFailure<T>

pub fn phase(&self) -> FailurePhase

Returns the lifecycle phase this failure occurred in.

pub fn error(&self) -> &T::Error

Returns the primary error of this failure.

For OnIdleThenOnStop this is the original on_idle error; the on_stop cleanup error is available via stop_error.

pub fn into_error(self) -> T::Error

Consumes the failure and returns the primary error.

Drops the recovered actor instance (if any) and the on_stop cleanup error (for OnIdleThenOnStop).

pub fn actor(&self) -> Option<&T>

Returns the recovered actor instance, if one exists.

None only for OnStart failures, where the actor was never constructed.

pub fn into_actor(self) -> Option<T>

Consumes the failure and returns the recovered actor instance, if any.

pub fn stop_error(&self) -> Option<&T::Error>

Returns the on_stop cleanup error, present only for OnIdleThenOnStop.

pub fn into_stop_error(self) -> Option<T::Error>

Consumes the failure and returns the on_stop cleanup error, present only for OnIdleThenOnStop.

Trait Implementations

impl<T: Debug + Actor> Debug for ActorFailure<T>

where T::Error: Debug,

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

Formats the value using the given formatter.