Struct Diagnostic

pub struct Diagnostic<FileId> {
    pub severity: Severity,
    pub code: Option<String>,
    pub message: String,
    pub labels: Vec<Label<FileId>>,
    pub notes: Vec<String>,
    pub subdiagnostics: Vec<Subdiagnostic<FileId>>,
}

Represents a diagnostic message that can provide information like errors and warnings to the user.

The position of a Diagnostic is considered to be the position of the Label that has the earliest starting position and has the highest style which appears in all the labels of the diagnostic.

Fields

severity: Severity

The overall severity of the diagnostic

code: Option<String>

An optional code that identifies this diagnostic.

message: String

The main message associated with this diagnostic.

These should not include line breaks, and in order support the ‘short’ diagnostic display mod, the message should be specific enough to make sense on its own, without additional context provided by labels and notes.

labels: Vec<Label<FileId>>

Source labels that describe the cause of the diagnostic. The order of the labels inside the vector does not have any meaning. The labels are always arranged in the order they appear in the source code.

notes: Vec<String>

Notes that are associated with the primary cause of the diagnostic. These can include line breaks for improved formatting.

subdiagnostics: Vec<Subdiagnostic<FileId>>

A list of diagnostics that are “attached” to the main diagnostic. They are rendered below the main diagnostic but still as one “unit”. For example, a note with one or more labels can be attached to a warning to give additional information that doesn’t make sense to group with the labels.

Implementations

impl<FileId> Diagnostic<FileId>

pub fn new(severity: Severity) -> Self

Create a new diagnostic.

pub fn bug() -> Self

Create a new diagnostic with a severity of Severity::Bug.

pub fn error() -> Self

Create a new diagnostic with a severity of Severity::Error.

pub fn warning() -> Self

Create a new diagnostic with a severity of Severity::Warning.

pub fn note() -> Self

Create a new diagnostic with a severity of Severity::Note.

pub fn help() -> Self

Create a new diagnostic with a severity of Severity::Help.

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

Set the error code of the diagnostic.

pub fn with_message(self, message: impl ToString) -> Self

Set the message of the diagnostic.

pub fn with_label(self, label: Label<FileId>) -> Self

Add a label to the diagnostic.

pub fn with_labels(self, labels: Vec<Label<FileId>>) -> Self

Add some labels to the diagnostic.

pub fn with_labels_iter<I>(self, labels: I) -> Self

where I: IntoIterator<Item = Label<FileId>>,

Add some labels from an iterator to the diagnostic.

pub fn with_notes(self, notes: Vec<String>) -> Self

Add some notes to the diagnostic.

pub fn with_note(self, note: impl Into<String>) -> Self

Add a note to the diagnostic.

pub fn with_notes_iter<I, T>(self, notes: I) -> Self

where I: IntoIterator<Item = T>, T: Into<String>,

Add notes from an iterator to the diagnostic.

pub fn with_suggestions(self, suggestions: Vec<Suggestion<FileId>>) -> Self

Add some suggestions to the diagnostic.

Convenience method for Self::with_subdiagnostics. Use that if you want to interleave suggestions with other Subdiagnostics.

pub fn with_spanned_notes(self, spanned_notes: Vec<SpannedNote<FileId>>) -> Self

Add some spanned notes to the diagnostic.

Convenience method for Self::with_subdiagnostics. Use that if you want to interleave spanned notes with other Subdiagnostics.

pub fn with_subdiagnostics( self, subdiagnostics: Vec<Subdiagnostic<FileId>>, ) -> Diagnostic<FileId>

Add some subdiagnostics to the diagnostic.

Trait Implementations

impl<FileId: Clone> Clone for Diagnostic<FileId>

fn clone(&self) -> Diagnostic<FileId>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<FileId: Debug> Debug for Diagnostic<FileId>

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

Formats the value using the given formatter.

impl<FileId: PartialEq> PartialEq for Diagnostic<FileId>

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

impl<FileId> StructuralPartialEq for Diagnostic<FileId>