Struct Diagnostic 

pub struct Diagnostic {
    pub severity: Severity,
    pub code: Option<String>,
    pub message: String,
    pub location: Option<Location>,
    pub path: Option<String>,
    pub hint: Option<String>,
    pub source_chain: Vec<String>,
}

Structured diagnostic information.

source_chain is a flat list of error messages from any attached std::error::Error cause chain, eagerly walked at construction time so the diagnostic remains trivially Clone and fully serializable across every binding boundary.

Fields

severity: Severity

Error severity level

code: Option<String>

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

message: String

Human-readable error message

location: Option<Location>

Primary source location (text anchor: file/line/column).

Set by parsers and backend compilers. May co-exist with Self::path — the two anchors are independent.

path: Option<String>

Document-model anchor — a dotted/bracketed path into the typed crate::document::Document.

Set by schema validation and coercion. See the module-level docs for the path grammar and conventions. May co-exist with Self::location.

hint: Option<String>

Optional hint for fixing the error

source_chain: Vec<String>

Flattened cause chain (outermost first).

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_path(self, path: String) -> Self

Set the document-model path anchor.

See the module-level docs for the path grammar and conventions.

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

Set a hint

pub fn with_source(self, source: &(dyn Error + 'static)) -> Self

Attach an error cause chain, walked eagerly into source_chain.

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 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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Diagnostic

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

Formats the value using the given formatter.

impl PartialEq for Diagnostic

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Diagnostic