Struct ParallaxError 

pub struct ParallaxError {
    pub code: ErrorCode,
    pub message: String,
    pub source_component: String,
    pub operation: String,
    pub runtime: Option<RuntimeKind>,
    pub context: Vec<(String, String)>,
    pub remediations: Vec<Remediation>,
    pub diagnostic: Option<String>,
}

Structured Parallax error.

Fields

code: ErrorCode

Stable error code.

message: String

Human-readable message.

source_component: String

Component that produced the error.

operation: String

Operation being attempted.

runtime: Option<RuntimeKind>

Optional runtime involved.

context: Vec<(String, String)>

Structured context key/value pairs.

remediations: Vec<Remediation>

Suggested remediations.

diagnostic: Option<String>

Optional verbose diagnostic (stack, stderr, etc.).

Implementations

impl ParallaxError

pub fn new(code: ErrorCode, message: impl Into<String>) -> Self

Start building an error.

pub fn with_source(self, source: impl Into<String>) -> Self

Set source component.

pub fn with_operation(self, op: impl Into<String>) -> Self

Set operation name.

pub fn with_runtime(self, runtime: RuntimeKind) -> Self

Attach runtime.

pub fn context(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add context pair.

pub fn remediate(self, remediation: Remediation) -> Self

Add remediation.

pub fn with_diagnostic(self, diagnostic: impl Into<String>) -> Self

Attach verbose diagnostic.

pub fn format_report(&self, verbose: bool) -> String

Format a concise user-facing report (non-JSON).

Trait Implementations

impl Clone for ParallaxError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParallaxError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParallaxError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ParallaxError

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

Formats the value using the given formatter.

impl Error for ParallaxError

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<Error> for ParallaxError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ParallaxError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl Serialize for ParallaxError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.