Struct codespan_reporting::diagnostic::Diagnostic

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

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.

Implementations

impl<FileId> Diagnostic<FileId>

pub fn new(severity: Severity) -> Diagnostic<FileId>

Create a new diagnostic.

pub fn bug() -> Diagnostic<FileId>

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

pub fn error() -> Diagnostic<FileId>

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

pub fn warning() -> Diagnostic<FileId>

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

pub fn note() -> Diagnostic<FileId>

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

pub fn help() -> Diagnostic<FileId>

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

pub fn with_code(self, code: impl Into<String>) -> Diagnostic<FileId>

Set the error code of the diagnostic.

pub fn with_message(self, message: impl Into<String>) -> Diagnostic<FileId>

Set the message of the diagnostic.

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

Add some labels to the diagnostic.

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

Add some notes to the diagnostic.

Trait Implementations

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

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

Returns a copy 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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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> StructuralEq for Diagnostic<FileId>

impl<FileId> StructuralPartialEq for Diagnostic<FileId>