Struct SupervisorRoleError 

pub struct SupervisorRoleError {
    pub child_id: ChildId,
    pub phase: RoleLifecyclePhase,
    pub message: String,
}

Structured error returned by a supervisor role.

Fields

child_id: ChildId

Stable child identifier for the failed supervisor role.

phase: RoleLifecyclePhase

Lifecycle phase where the supervisor role failed.

message: String

Human-readable diagnostic message.

Implementations

impl SupervisorRoleError

pub fn new( child_id: ChildId, phase: RoleLifecyclePhase, message: impl Into<String>, ) -> Self

Creates a supervisor role error.

Arguments

• child_id: Stable child identifier for the failed supervisor role.
• phase: Lifecycle phase where the supervisor role failed.
• message: Diagnostic message for operators.

Returns

Returns a structured SupervisorRoleError value.

Examples

let error = rust_supervisor::role::result::supervisor::SupervisorRoleError::new(
    rust_supervisor::id::types::ChildId::new("nested-supervisor"),
    rust_supervisor::role::lifecycle::RoleLifecyclePhase::BuildTree,
    "nested tree could not be built",
);
assert_eq!(error.phase.as_str(), "build_tree");

pub fn from_supervisor_error( child_id: ChildId, phase: RoleLifecyclePhase, error: SupervisorError, ) -> Self

Creates a supervisor role error from a runtime supervisor error.

Arguments

• child_id: Stable child identifier for the failed supervisor role.
• phase: Lifecycle phase that observed the runtime error.
• error: Runtime supervisor error returned by the nested supervisor.

Returns

Returns a structured SupervisorRoleError value with the runtime error rendered into its diagnostic message.

pub fn into_task_failure(self) -> TaskFailure

Converts this supervisor role error into a runtime task failure.

Arguments

This function has no arguments.

Returns

Returns a TaskFailure value consumed by the runtime policy pipeline.

Trait Implementations

impl Clone for SupervisorRoleError

fn clone(&self) -> SupervisorRoleError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SupervisorRoleError

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

Formats the value using the given formatter.

impl Display for SupervisorRoleError

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

Formats the value using the given formatter.

impl Eq for SupervisorRoleError

impl Error for SupervisorRoleError

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 PartialEq for SupervisorRoleError

fn eq(&self, other: &SupervisorRoleError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SupervisorRoleError