Struct Diagnostic 

pub struct Diagnostic {
    pub severity: Severity,
    pub code: DiagnosticCode,
    pub stage: DiagnosticStage,
    pub message: Cow<'static, str>,
    pub location: Option<OpLocation>,
    pub suggested_fix: Option<Cow<'static, str>>,
    pub cause: Option<DiagnosticCause>,
    pub retry: RetryClass,
    pub doc_url: Option<Cow<'static, str>>,
}

Serializable diagnostic shared by compiler, AOT, runtime, and drivers.

Fields

severity: Severity

Severity of the diagnostic.

code: DiagnosticCode

Stable machine-readable code.

stage: DiagnosticStage

Stage that produced the diagnostic.

message: Cow<'static, str>

Deterministic failure detail.

location: Option<OpLocation>

Typed source, graph, operation, or artifact location.

suggested_fix: Option<Cow<'static, str>>

Corrective action the caller can apply.

cause: Option<DiagnosticCause>

Structured cause retained from the owning stage.

retry: RetryClass

Retry policy for this failure.

doc_url: Option<Cow<'static, str>>

Optional stable documentation URL.

Implementations

impl Diagnostic

pub fn error( code: &'static str, message: impl Into<Cow<'static, str>>, ) -> Diagnostic

Construct an error diagnostic at validation stage with no retry.

pub fn warning( code: &'static str, message: impl Into<Cow<'static, str>>, ) -> Diagnostic

Construct a warning diagnostic at validation stage with no retry.

pub fn note( code: &'static str, message: impl Into<Cow<'static, str>>, ) -> Diagnostic

Construct a note diagnostic at validation stage with no retry.

pub const fn with_stage(self, stage: DiagnosticStage) -> Diagnostic

Set the owning workflow stage.

pub fn with_location(self, location: OpLocation) -> Diagnostic

Attach a typed location.

pub fn with_fix(self, fix: impl Into<Cow<'static, str>>) -> Diagnostic

Attach a corrective action.

pub fn with_cause( self, kind: impl Into<String>, detail: impl Into<String>, ) -> Diagnostic

Attach a structured cause.

pub const fn with_retry(self, retry: RetryClass) -> Diagnostic

Set the retry policy.

pub fn with_doc_url(self, url: impl Into<Cow<'static, str>>) -> Diagnostic

Attach a documentation URL.

pub fn render_human(&self) -> String

Render a deterministic rustc-style diagnostic.

pub fn to_json(&self) -> String

Serialize this diagnostic as canonical JSON.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Diagnostic

fn deserialize<__D>( __deserializer: __D, ) -> Result<Diagnostic, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Diagnostic

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

Formats the value using the given formatter.

impl Eq for Diagnostic

impl From<&ValidationError> for Diagnostic

fn from(issue: &ValidationError) -> Diagnostic

Converts to this type from the input type.

impl From<ValidationError> for Diagnostic

fn from(issue: ValidationError) -> Diagnostic

Converts to this type from the input type.

impl PartialEq for Diagnostic

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Diagnostic

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Diagnostic