Enum SupervisorError 

pub enum SupervisorError {
    InvalidName {
        name: String,
    },
    FailedToInitialize {
        child_name: String,
        source: InitializationError,
    },
    Shutdown,
    SignificantChildExited,
    ShutdownTimedOut {
        aborted: usize,
    },
}

Supervisor errors.

Variants

InvalidName

Supervisor or worker name is invalid.

Fields

name: String

The name of the supervisor is invalid.

FailedToInitialize

A child process failed to initialize.

This error indicates that a child couldn’t complete its async initialization. This is distinct from runtime failures and doesn’t trigger restart logic.

Fields

child_name: String

The name of the child that failed to initialize.

source: InitializationError

The underlying initialization error.

Shutdown

The supervisor exceeded its restart limits and was forced to shutdown.

SignificantChildExited

The supervisor shut down because a significant child terminated.

See AutoShutdown and ChildSpecification::with_significant. The supervisor stopped, and drained its remaining children, because a child marked significant terminated without being restarted.

ShutdownTimedOut

The supervisor completed a requested shutdown, but one or more workers ignored graceful shutdown and had to be forcefully aborted after exceeding their shutdown timeout.

The shutdown itself was requested and otherwise orderly; this variant exists so that having to forcefully stop a worker is surfaced as a failure rather than reported as a clean shutdown. The count aggregates forced aborts across the entire supervision tree: a parent merges in the counts reported by any child supervisors that also timed out, so the value observed at the root supervisor is the total number of workers that had to be force-stopped tree-wide.

Fields

aborted: usize

The number of workers that had to be forcefully aborted.

Trait Implementations

impl Debug for SupervisorError

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

Formats the value using the given formatter.

impl Display for SupervisorError

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

Formats the value using the given formatter.

impl Error for SupervisorError

where Self: Debug + Display,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl ErrorCompat for SupervisorError

fn backtrace(&self) -> Option<&Backtrace>

Returns a Backtrace that may be printed.

fn iter_chain(&self) -> ChainCompat<'_, '_>

where Self: AsErrorSource,

Returns an iterator for traversing the chain of errors, starting with the current error and continuing with recursive calls to Error::source.