Struct DashboardError 

pub struct DashboardError {
    pub code: String,
    pub stage: String,
    pub target_id: Option<String>,
    pub message: String,
    pub retryable: bool,
}

Error returned by target-side dashboard IPC handlers.

Fields

code: String

Stable machine-readable error code.

stage: String

Processing stage that produced the error.

target_id: Option<String>

Optional target process identifier related to the error.

message: String

Human-readable diagnostic message.

retryable: bool

Whether a caller can retry after the reported condition changes.

Implementations

impl DashboardError

pub fn new( code: impl Into<String>, stage: impl Into<String>, target_id: Option<String>, message: impl Into<String>, retryable: bool, ) -> Self

Creates a structured dashboard error.

Arguments

• code: Stable machine-readable error code.
• stage: Processing stage that produced the error.
• target_id: Optional target process identifier.
• message: Human-readable diagnostic message.
• retryable: Whether a retry can later succeed.

Returns

Returns a DashboardError value ready for JSON serialization.

Examples found in repository

examples/demo/bootstrap.rs (line 657)

fn io_error(
    // Continue the demo expression.
    code: &str,
    // Continue the demo expression.
    stage: &str,
    // Continue the demo expression.
    target_id: Option<String>,
    // Continue the demo expression.
    error: std::io::Error,
    // Continue the demo expression.
) -> DashboardError {
    // Create a retryable I/O error.
    DashboardError::new(code, stage, target_id, error.to_string(), true)
    // End I/O error construction.
}

pub fn unsupported_method(method: impl AsRef<str>) -> Self

Creates an unsupported method error.

Arguments

• method: Method name rejected by the parser.

Returns

Returns a non-retryable DashboardError.

pub fn validation( stage: impl Into<String>, target_id: Option<String>, message: impl Into<String>, ) -> Self

Creates a validation error.

Arguments

• stage: Validation stage.
• target_id: Optional target process identifier.
• message: Human-readable validation message.

Returns

Returns a non-retryable DashboardError.

Examples found in repository

examples/demo/scenario.rs (line 1590)

fn validation(target_id: &str, message: &str) -> DashboardError {
    // Create a target-scoped validation error.
    DashboardError::validation("command_validate", Some(target_id.to_owned()), message)
    // End validation construction.
}

pub fn target_unavailable( stage: impl Into<String>, target_id: impl Into<String>, message: impl Into<String>, ) -> Self

Creates a target unavailable error.

Arguments

• stage: Processing stage that tried to use the target.
• target_id: Target process identifier.
• message: Human-readable diagnostic message.

Returns

Returns a retryable DashboardError.

Trait Implementations

impl Clone for DashboardError

fn clone(&self) -> DashboardError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DashboardError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DashboardError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DashboardError

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

Formats the value using the given formatter.

impl Error for DashboardError

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 JsonSchema for DashboardError

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for DashboardError

fn eq(&self, other: &DashboardError) -> 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 Serialize for DashboardError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DashboardError

impl StructuralPartialEq for DashboardError