Struct SourceDiagnostic 

pub struct SourceDiagnostic {
    pub severity: Severity,
    pub span: DiagSpan,
    pub message: EcoString,
    pub trace: EcoVec<Spanned<Tracepoint>>,
    pub hints: EcoVec<Spanned<EcoString, DiagSpan>>,
}

An error or warning in a source or text file. The recommended way to create one is with the error! or warning! macros.

The contained spans will only be detached if any of the input source files were detached.

Fields

severity: Severity

Whether the diagnostic is an error or a warning.

span: DiagSpan

The span of a relevant node in a Typst source file or the relevant byte range of an external file.

message: EcoString

A diagnostic message describing the problem.

trace: EcoVec<Spanned<Tracepoint>>

The trace of function calls leading to the problem.

hints: EcoVec<Spanned<EcoString, DiagSpan>>

Additional hints to the user.

• When the span is None, these are generic hints. The CLI renders them as a list at the bottom, each prefixed with hint: .

• When a span is given, the hint is related to a secondary piece of code and will be annotated at that code.

Implementations

impl SourceDiagnostic

pub fn error( span: impl Into<DiagSpan>, message: impl Into<EcoString>, ) -> SourceDiagnostic

Create a new, bare error.

pub fn warning( span: impl Into<DiagSpan>, message: impl Into<EcoString>, ) -> SourceDiagnostic

Create a new, bare warning.

pub fn hint(&mut self, hint: impl Into<EcoString>)

Adds a single hint to the diagnostic.

pub fn spanned_hint( &mut self, hint: impl Into<EcoString>, span: impl Into<DiagSpan>, )

Adds a single hint specific to a source code location to the diagnostic.

pub fn with_hint(self, hint: impl Into<EcoString>) -> SourceDiagnostic

Adds a single hint to the diagnostic.

pub fn with_spanned_hint( self, hint: impl Into<EcoString>, span: impl Into<DiagSpan>, ) -> SourceDiagnostic

Adds a single hint specific to a source code location to the diagnostic.

pub fn with_hints( self, hints: impl IntoIterator<Item = EcoString>, ) -> SourceDiagnostic

Adds multiple user-facing hints to the diagnostic.

pub fn with_tracepoint( self, tracepoint: Tracepoint, span: Span, ) -> SourceDiagnostic

Adds a single tracepoint to the diagnostic.

Trait Implementations

impl Clone for SourceDiagnostic

fn clone(&self) -> SourceDiagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceDiagnostic

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

Formats the value using the given formatter.

impl Eq for SourceDiagnostic

impl From<SyntaxDiagnostic> for SourceDiagnostic

fn from(syntax_diag: SyntaxDiagnostic) -> SourceDiagnostic

Converts to this type from the input type.

impl Hash for SourceDiagnostic

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SourceDiagnostic

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