Struct Diagnostic

pub struct Diagnostic {
    pub level: DiagnosticLevel,
    pub labels: Labels,
    pub subdiagnostics: Vec<Subdiagnostic>,
}

Something that is wrong in the code.

Fields

level: DiagnosticLevel

labels: Labels

subdiagnostics: Vec<Subdiagnostic>

Extra diagnostics that are shown after the main diagnostic.

Implementations

impl Diagnostic

fn new( level: DiagnosticLevel, span: impl Into<FullSpan>, message: impl Into<Message>, ) -> Self

pub fn bug(span: impl Into<FullSpan>, message: impl Into<Message>) -> Self

Report that something happened in the compiler that shouldn’t be possible. This signifies that something is wrong with the compiler. It will include a large footer instructing the user to create an issue or otherwise get in touch.

pub fn error(span: impl Into<FullSpan>, message: impl Into<Message>) -> Self

Report that something is wrong with the supplied code.

pub fn level(self, level: DiagnosticLevel) -> Self

pub fn message(self, message: impl Into<Message>) -> Self

pub fn primary_label(self, primary_label: impl Into<Message>) -> Self

Attach a message to the primary label of this diagnostic.

pub fn secondary_label( self, span: impl Into<FullSpan>, message: impl Into<Message>, ) -> Self

Attach a secondary label to this diagnostic.

pub fn note(self, message: impl Into<Message>) -> Self

Attach a simple (one-line) note to this diagnostic.

pub fn add_note(&mut self, message: impl Into<Message>) -> &mut Self

Attach a simple (one-line) note to this diagnostic.

Modifying version of Self::note.

pub fn help(self, message: impl Into<Message>) -> Self

Attach a simple (one-line) help to this diagnostic.

Builder version of Self::add_help.

pub fn add_help(&mut self, message: impl Into<Message>) -> &mut Self

Attach a simple (one-line) help to this diagnostic.

Modifying version of Self::help.

pub fn subdiagnostic(self, subdiagnostic: Subdiagnostic) -> Self

Attach a general subdiagnostic to this diagnostic.

Prefer a more specific convenicence method (see the crate documentation) if you can. This is intended for spanned notes since they need a builder in order to be constructed.

pub fn push_subdiagnostic(&mut self, subdiagnostic: Subdiagnostic) -> &mut Self

See Self::subdiagnostic.

pub fn span_suggest( self, message: impl Into<Message>, span: impl Into<FullSpan>, code: impl Into<String>, ) -> Self

pub fn span_suggest_insert_before( self, message: impl Into<Message>, span: impl Into<FullSpan>, code: impl Into<String>, ) -> Self

Convenience method to suggest some code that can be inserted directly before some span.

Note that this will be after any preceding whitespace. Use Diagnostic::span_suggest_insert_after if you want the suggestion to insert before preceding whitespace.

pub fn span_suggest_insert_after( self, message: impl Into<Message>, span: impl Into<FullSpan>, code: impl Into<String>, ) -> Self

Convenience method to suggest some code that can be inserted directly after some span.

Note that this will be before any preceding whitespace. Use Diagnostic::span_suggest_insert_before if you want the suggestion to insert after preceding whitespace.

pub fn span_suggest_replace( self, message: impl Into<Message>, span: impl Into<FullSpan>, code: impl Into<String>, ) -> Self

Convenience method to suggest some code that can be replaced.

pub fn span_suggest_remove( self, message: impl Into<Message>, span: impl Into<FullSpan>, ) -> Self

Convenience method to suggest some code that can be removed.

pub fn span_suggest_multipart( self, message: impl Into<Message>, parts: SuggestionParts, ) -> Self

Suggest a change that consists of multiple parts.

pub fn push_span_suggest_multipart( &mut self, message: impl Into<Message>, SuggestionParts: SuggestionParts, ) -> &mut Self

Suggest a change that consists of multiple parts, but usable outside of builders.

pub fn type_error( self, expected: String, expected_outer: Option<String>, got: String, got_outer: Option<String>, ) -> Self

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 CompilationError for Diagnostic

fn report( &self, buffer: &mut Buffer, code: &CodeBundle, diag_handler: &mut DiagHandler, )

impl Debug for Diagnostic

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

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 StructuralPartialEq for Diagnostic