Struct Diagnostic

pub struct Diagnostic {
    pub messages: Vec<(DiagnosticMessage, Style)>,
    pub span: MultiSpan,
    pub children: Vec<SubDiagnostic>,
    pub code: Option<DiagnosticId>,
    pub created_at: &'static Location<'static>,
    /* private fields */
}

A compiler diagnostic.

Fields

messages: Vec<(DiagnosticMessage, Style)>

span: MultiSpan

children: Vec<SubDiagnostic>

code: Option<DiagnosticId>

created_at: &'static Location<'static>

Implementations

impl Diagnostic

pub fn new<M: Into<DiagnosticMessage>>(level: Level, msg: M) -> Self

Creates a new Diagnostic with a single message.

pub fn new_with_messages( level: Level, messages: Vec<(DiagnosticMessage, Style)>, ) -> Self

Creates a new Diagnostic with multiple messages.

pub fn is_error(&self) -> bool

Returns true if this diagnostic is an error.

pub fn label(&self) -> Cow<'_, str>

Formats the diagnostic messages into a single string.

pub fn messages(&self) -> &[(DiagnosticMessage, Style)]

Returns the messages of this diagnostic.

pub fn level(&self) -> Level

Returns the level of this diagnostic.

pub fn id(&self) -> Option<String>

Returns the code of this diagnostic as a string.

impl Diagnostic

Setters.

pub fn span(&mut self, span: impl Into<MultiSpan>) -> &mut Self

Sets the span of this diagnostic.

pub fn code(&mut self, code: impl Into<DiagnosticId>) -> &mut Self

Sets the code of this diagnostic.

pub fn span_label( &mut self, span: Span, label: impl Into<DiagnosticMessage>, ) -> &mut Self

Adds a span/label to be included in the resulting snippet.

This is pushed onto the MultiSpan that was created when the diagnostic was first built. That means it will be shown together with the original span/label, not a span added by one of the span_{note,warn,help,suggestions} methods.

This span is not considered a “primary span”; only the Span supplied when creating the diagnostic is primary.

pub fn span_labels( &mut self, spans: impl IntoIterator<Item = Span>, label: impl Into<DiagnosticMessage>, ) -> &mut Self

Labels all the given spans with the provided label. See Self::span_label() for more information.

impl Diagnostic

Sub-diagnostics.

pub fn warn(&mut self, msg: impl Into<DiagnosticMessage>) -> &mut Self

Add a warning attached to this diagnostic.

pub fn span_warn( &mut self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>, ) -> &mut Self

Prints the span with a warning above it. This is like Diagnostic::warn(), but it gets its own span.

pub fn note(&mut self, msg: impl Into<DiagnosticMessage>) -> &mut Self

Add a note to this diagnostic.

pub fn span_note( &mut self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>, ) -> &mut Self

Prints the span with a note above it. This is like Diagnostic::note(), but it gets its own span.

pub fn highlighted_note( &mut self, messages: Vec<(impl Into<DiagnosticMessage>, Style)>, ) -> &mut Self

pub fn note_once(&mut self, msg: impl Into<DiagnosticMessage>) -> &mut Self

Prints the span with a note above it. This is like Diagnostic::note(), but it gets emitted only once.

pub fn span_note_once( &mut self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>, ) -> &mut Self

Prints the span with a note above it. This is like Diagnostic::note_once(), but it gets its own span.

pub fn help(&mut self, msg: impl Into<DiagnosticMessage>) -> &mut Self

Add a help message attached to this diagnostic.

pub fn help_once(&mut self, msg: impl Into<DiagnosticMessage>) -> &mut Self

Prints the span with a help above it. This is like Diagnostic::help(), but it gets its own span.

pub fn highlighted_help( &mut self, msgs: Vec<(impl Into<DiagnosticMessage>, Style)>, ) -> &mut Self

Add a help message attached to this diagnostic with a customizable highlighted message.

pub fn span_help( &mut self, span: impl Into<MultiSpan>, msg: impl Into<DiagnosticMessage>, ) -> &mut Self

Prints the span with some help above it. This is like Diagnostic::help(), but it gets its own span.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

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

Formats the value using the given formatter.

impl Hash for Diagnostic

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

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 Diagnostic

fn eq(&self, other: &Self) -> 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.