Enum RuntimeError 

#[non_exhaustive]
pub enum RuntimeError {
    #[non_exhaustive]
    GraceExceeded {
        grace: Duration,
        stuck: Vec<Arc<str>>,
    },
    #[non_exhaustive]
    TaskAlreadyExists {
        name: Arc<str>,
    },
    CommandQueueFull,
    #[non_exhaustive]
    TaskTerminationTimeout {
        id: TaskId,
        timeout: Duration,
    },
    #[non_exhaustive]
    SignalSetupFailed {
        source: Error,
    },
    ShuttingDown,
    AlreadyRunning,
}

Errors from supervisor lifecycle and management operations.

These errors come from add, remove, cancel, shutdown, and run operations. They are separate from TaskError, which comes from a task attempt.

Match with a wildcard arm because this enum is non-exhaustive. Data-carrying variants are also non-exhaustive; include .. when matching their fields.

Also

• Supervisor - returns RuntimeError from run
• SupervisorHandle - returns RuntimeError from management methods
• ControllerError - errors from optional controller configuration and submit* methods

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

GraceExceeded

Shutdown grace period was exceeded.

Some managed task runners did not stop in time and were force-terminated. Work detached by user code is outside this guarantee.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

grace: Duration

Configured shutdown grace duration.

stuck: Vec<Arc<str>>

Task names that did not stop in time.

#[non_exhaustive]

TaskAlreadyExists

A task name is already registered or repeated in an all-or-nothing batch.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

name: Arc<str>

Duplicate task name.

CommandQueueFull

A bounded management command queue has no free capacity.

A fail-fast management call could not enqueue its requested state change. That request does not change task or slot ownership.

#[non_exhaustive]

TaskTerminationTimeout

Timed out while waiting for terminal registry cleanup.

The stop request remains active. This error only ends the caller’s wait; it does not undo cancellation or change the supervisor grace period.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

id: TaskId

Task id whose terminal cleanup did not finish in time.

timeout: Duration

Wait duration before timing out.

#[non_exhaustive]

SignalSetupFailed

OS signal listener setup failed.

Signal-based shutdown is unavailable. The I/O error kind, message, and source chain are preserved for callers that join the shared shutdown operation.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: Error

I/O error returned by signal registration.

ShuttingDown

The runtime is shutting down and no longer accepts commands.

AlreadyRunning

Supervisor::run was called more than once.

A supervisor run is single-shot.

Implementations

impl RuntimeError

pub fn as_label(&self) -> &'static str

Returns a stable machine-readable label for logs and metrics.

This label is not the same as Display.

Trait Implementations

impl Debug for RuntimeError

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

Formats the value using the given formatter.

impl Display for RuntimeError

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

Formats the value using the given formatter.

impl Error for RuntimeError

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 From<RuntimeError> for Error

fn from(source: RuntimeError) -> Self

Converts to this type from the input type.