Struct Diagnostic 

pub struct Diagnostic {
    pub severity: Severity,
    pub code: Option<String>,
    pub message: String,
    pub primary: Option<Location>,
    pub hint: Option<String>,
    pub source: Option<Box<dyn Error + Send + Sync>>,
}

Structured diagnostic information

Fields

severity: Severity

Error severity level

code: Option<String>

Optional error code (e.g., “E001”, “typst::syntax”)

message: String

Human-readable error message

primary: Option<Location>

Primary source location

hint: Option<String>

Optional hint for fixing the error

source: Option<Box<dyn Error + Send + Sync>>

Source error that caused this diagnostic (for error chaining) Note: This field is excluded from serialization as Error trait objects cannot be serialized

Implementations

impl Diagnostic

pub fn new(severity: Severity, message: String) -> Self

Create a new diagnostic

pub fn with_code(self, code: String) -> Self

Set the error code

pub fn with_location(self, location: Location) -> Self

Set the primary location

pub fn with_hint(self, hint: String) -> Self

Set a hint

pub fn with_source(self, source: Box<dyn Error + Send + Sync>) -> Self

Set error source (chainable)

pub fn source_chain(&self) -> Vec<String>

Get the source chain as a list of error messages

pub fn fmt_pretty(&self) -> String

Format diagnostic for pretty printing

pub fn fmt_pretty_with_source(&self) -> String

Format diagnostic with source chain for debugging

Trait Implementations

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl Display for Diagnostic

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

Formats the value using the given formatter.

impl From<&Diagnostic> for SerializableDiagnostic

fn from(diag: &Diagnostic) -> Self

Converts to this type from the input type.

impl From<Diagnostic> for SerializableDiagnostic

fn from(diag: Diagnostic) -> Self

Converts to this type from the input type.

impl Serialize for Diagnostic

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

where __S: Serializer,

Serialize this value into the given Serde serializer.