Enum RuntimeError 

#[non_exhaustive]
pub enum RuntimeError {
    TokioRuntimeUnavailable,
    #[non_exhaustive]
    ThreadStartFailed {
        component: &'static str,
        source: Error,
    },
    #[non_exhaustive]
    GraceExceeded {
        grace: Duration,
        stuck: Vec<Arc<str>>,
    },
    #[non_exhaustive]
    TaskAlreadyExists {
        name: Arc<str>,
    },
    #[non_exhaustive]
    ResourceLimitReached {
        resource: &'static str,
        limit: usize,
    },
    CommandQueueFull,
    #[non_exhaustive]
    TaskTerminationTimeout {
        id: TaskId,
        timeout: Duration,
    },
    #[non_exhaustive]
    OutcomeUnavailable {
        id: TaskId,
    },
    #[non_exhaustive]
    SignalSetupFailed {
        source: Error,
    },
    ShuttingDown,
    AlreadyRunning,
}

Failure of a supervisor lifecycle or management operation.

Runtime startup, static runs, dynamic management, outcome waiting, and shutdown return this type. Task attempts return TaskError instead. This enum and its data-carrying variants are non-exhaustive; keep a fallback arm and use .. when matching fields.

See also

• Error combines runtime and feature-gated controller errors.
• ControllerError - controller availability and submission intake errors

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.

TokioRuntimeUnavailable

Runtime startup was requested without an active Tokio runtime.

The supervisor remains stopped and startup may be retried from inside a Tokio runtime.

#[non_exhaustive]

ThreadStartFailed

A required Taskvisor worker thread could not start.

The operation that needed the worker remains uncommitted. The source identifies the failed thread-creation or startup handshake.

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.

component: &'static str

Stable runtime component name suitable for diagnostics.

source: Error

I/O error from thread creation or the transactional startup handshake.

#[non_exhaustive]

GraceExceeded

Task cleanup did not finish within the shared shutdown grace period.

A listed name belongs to an actor that required logical force-abort or a removal owner still finishing at the deadline. A force-aborted actor can remain physically active under Taskvisor’s cleanup ownership after this error is returned.

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 whose removal did not finish within the grace period.

#[non_exhaustive]

TaskAlreadyExists

A task name is already reserved or repeated in an atomic static batch.

Registry membership and cleanup ownership of a physically active force-aborted actor can both reserve a name.

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>

Conflicting task name.

#[non_exhaustive]

ResourceLimitReached

A configured runtime or user-lifetime budget was exhausted.

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.

resource: &'static str

Stable resource name used by diagnostics.

limit: usize

Reported bound for the rejected resource. For owned_user_lifetimes, this is the domain’s configured capacity; retired poisoned slots can make the currently usable capacity smaller.

CommandQueueFull

A fail-fast management call found its command queue full.

The rejected request does not change task or controller-slot ownership.

#[non_exhaustive]

TaskTerminationTimeout

The caller’s bounded wait for terminal registry cleanup expired.

The stop request remains active. This error does not undo cancellation or change the supervisor’s shutdown 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 whose terminal cleanup remained pending.

timeout: Duration

Wait duration before timing out.

#[non_exhaustive]

OutcomeUnavailable

A watched task or controller submission’s direct outcome channel closed without a result.

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 identity whose outcome could not be delivered.

#[non_exhaustive]

SignalSetupFailed

Explicit operating-system signal setup failed.

This can only come from Supervisor::run_with_os_signals. Every caller joining that shared shutdown receives an equivalent source.

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

A static run tried to acquire an already owned or committed lifecycle.

Supervisor::run, Supervisor::run_until, and Supervisor::run_with_os_signals share one single-shot lifecycle.

Implementations

impl RuntimeError

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

Returns the stable category label used by 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.