Struct Diagnostic 

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

Represents a labels 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 labels.

Fields

severity: DiagnosticLevel

The overall severity of the labels

code: Option<String>

An optional code that identifies this labels.

message: String

The main message associated with this labels.

These should not include line breaks, and in order support the ‘short’ labels 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>

Source labels that describe the cause of the labels. 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 labels. These can include line breaks for improved formatting.

Implementations

impl Diagnostic

pub fn new(severity: DiagnosticLevel) -> Diagnostic

Create a new label.

pub fn info() -> Diagnostic

Create a new info label.

pub fn warning() -> Diagnostic

Create a new warning label.

pub fn error() -> Diagnostic

Create a new error label.

pub fn fatal() -> Diagnostic

Create a new fatal label.

pub fn with_code(self, code: impl Display) -> Diagnostic

Set the error code of the labels.

pub fn with_message(self, message: impl Display) -> Diagnostic

Set the message of the labels.

pub fn with_primary( self, file_id: &FileID, range: Range<usize>, message: impl Display, ) -> Diagnostic

Add some labels to the labels.

pub fn with_secondary( self, file_id: &FileID, range: Range<usize>, message: impl Display, ) -> Diagnostic

Add some labels to the labels.

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

Add some labels to the labels.

pub fn with_note(self, note: impl Display) -> Diagnostic

Add some notes to the labels.

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

Add some notes to the labels.

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<(), Error>

Formats the value using the given formatter.

impl PartialEq for Diagnostic

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Diagnostic

impl StructuralPartialEq for Diagnostic