Struct Diagnostic 

#[non_exhaustive]
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 args: BTreeMap<String, Value>,
    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 (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

severity: Severity

code: Option<String>

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

message: String

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>

args: BTreeMap<String, Value>

The facts Self::message interpolates, keyed by name: with Self::code, the substitution unit a consumer needs to word this diagnostic in its own language.

One code carries one key set, tabulated per code in prose/canon/ERROR.md § “Diagnostic args” and tested against it. Values keep their JSON shape, so joining and pluralizing stay the consumer’s locale decisions.

Empty either because the code is outside the structured surface or because its sentence needs no facts beyond the code; canon tells the two apart. Engine prose never rides under a key: a consumer’s sentence may be coarser than ours, never half-translated.

source_chain: Vec<String>

Flattened cause chain (outermost first). Upstream English, and untranslatable for the same reason the prose it wraps is.

Implementations

impl Diagnostic

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

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

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

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

pub fn with_args(self, args: BTreeMap<String, Value>) -> Self

Attach the message’s substitution facts. See Self::args.

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

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

Equality operator ==.

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

Inequality operator !=.

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