Struct SourceDiagnostic

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

An error or warning in a source file.

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

The span of the relevant node in the source code.

message: EcoString

A diagnostic message describing the problem.

trace: EcoVec<Spanned<Tracepoint>>

The trace of function calls leading to the problem.

hints: EcoVec<EcoString>

Additional hints to the user, indicating how this problem could be avoided or worked around.

Implementations

impl SourceDiagnostic

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

Create a new, bare error.

pub fn warning(span: Span, 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 with_hint(self, hint: impl Into<EcoString>) -> SourceDiagnostic

Adds a single hint to the diagnostic.

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

Adds user-facing hints to the diagnostic.

Trait Implementations

impl Clone for SourceDiagnostic

fn clone(&self) -> SourceDiagnostic

Returns a copy 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 From<SyntaxError> for SourceDiagnostic

fn from(error: SyntaxError) -> 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 Eq for SourceDiagnostic

impl StructuralPartialEq for SourceDiagnostic