Struct syntex_syntax2::diagnostics::plugin::diagnostic_builder::DiagnosticBuilder

#[must_use]
pub struct DiagnosticBuilder<'a> { /* fields omitted */ }

Used for emitting structured error messages and other diagnostic information.

Methods

impl<'a> DiagnosticBuilder<'a>

pub fn emit(&mut self)

Emit the diagnostic.

pub fn span_label<T>(
    &mut self,
    span: Span,
    label: T
) -> &mut DiagnosticBuilder<'a> where
    T: Into<String>, 

Add 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. If you don't call this function at all, and you just supplied a Span to create the diagnostic, then the snippet will just include that Span, which is called the primary span.

pub fn note_expected_found(
    &mut self,
    label: &dyn Display,
    expected: DiagnosticStyledString,
    found: DiagnosticStyledString
) -> &mut DiagnosticBuilder<'a>

pub fn note_expected_found_extra(
    &mut self,
    label: &dyn Display,
    expected: DiagnosticStyledString,
    found: DiagnosticStyledString,
    expected_extra: &dyn Display,
    found_extra: &dyn Display
) -> &mut DiagnosticBuilder<'a>

pub fn note(&mut self, msg: &str) -> &mut DiagnosticBuilder<'a>

pub fn span_note<S>(&mut self, sp: S, msg: &str) -> &mut DiagnosticBuilder<'a> where
    S: Into<MultiSpan>, 

pub fn warn(&mut self, msg: &str) -> &mut DiagnosticBuilder<'a>

pub fn span_warn<S>(&mut self, sp: S, msg: &str) -> &mut DiagnosticBuilder<'a> where
    S: Into<MultiSpan>, 

pub fn help(&mut self, msg: &str) -> &mut DiagnosticBuilder<'a>

pub fn span_help<S>(&mut self, sp: S, msg: &str) -> &mut DiagnosticBuilder<'a> where
    S: Into<MultiSpan>, 

pub fn span_suggestion(
    &mut self,
    sp: Span,
    msg: &str,
    suggestion: String
) -> &mut DiagnosticBuilder<'a>

pub fn span_suggestions(
    &mut self,
    sp: Span,
    msg: &str,
    suggestions: Vec<String>
) -> &mut DiagnosticBuilder<'a>

pub fn set_span<S>(&mut self, sp: S) -> &mut DiagnosticBuilder<'a> where
    S: Into<MultiSpan>, 

pub fn code(&mut self, s: String) -> &mut DiagnosticBuilder<'a>

pub fn new(
    handler: &'a Handler,
    level: Level,
    message: &str
) -> DiagnosticBuilder<'a>

Convenience function for internal use, clients should use one of the struct_* methods on Handler.

pub fn new_with_code(
    handler: &'a Handler,
    level: Level,
    code: Option<String>,
    message: &str
) -> DiagnosticBuilder<'a>

Convenience function for internal use, clients should use one of the struct_* methods on Handler.

pub fn into_diagnostic(self) -> Diagnostic

Methods from Deref<Target = Diagnostic>

pub fn cancel(&mut self)

Cancel the diagnostic (a structured diagnostic must either be emitted or cancelled or it will panic when dropped). BEWARE: if this DiagnosticBuilder is an error, then creating it will bump the error count on the Handler and cancelling it won't undo that. If you want to decrement the error count you should use Handler::cancel.

pub fn cancelled(&self) -> bool

pub fn is_fatal(&self) -> bool

pub fn span_label<T>(&mut self, span: Span, label: T) -> &mut Diagnostic where
    T: Into<String>, 

Add 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. If you don't call this function at all, and you just supplied a Span to create the diagnostic, then the snippet will just include that Span, which is called the primary span.

pub fn note_expected_found(
    &mut self,
    label: &dyn Display,
    expected: DiagnosticStyledString,
    found: DiagnosticStyledString
) -> &mut Diagnostic

pub fn note_expected_found_extra(
    &mut self,
    label: &dyn Display,
    expected: DiagnosticStyledString,
    found: DiagnosticStyledString,
    expected_extra: &dyn Display,
    found_extra: &dyn Display
) -> &mut Diagnostic

pub fn note(&mut self, msg: &str) -> &mut Diagnostic

pub fn highlighted_note(&mut self, msg: Vec<(String, Style)>) -> &mut Diagnostic

pub fn span_note<S>(&mut self, sp: S, msg: &str) -> &mut Diagnostic where
    S: Into<MultiSpan>, 

pub fn warn(&mut self, msg: &str) -> &mut Diagnostic

pub fn span_warn<S>(&mut self, sp: S, msg: &str) -> &mut Diagnostic where
    S: Into<MultiSpan>, 

pub fn help(&mut self, msg: &str) -> &mut Diagnostic

pub fn span_help<S>(&mut self, sp: S, msg: &str) -> &mut Diagnostic where
    S: Into<MultiSpan>, 

pub fn span_suggestion(
    &mut self,
    sp: Span,
    msg: &str,
    suggestion: String
) -> &mut Diagnostic

Prints out a message with a suggested edit of the code.

See diagnostic::CodeSuggestion for more information.

pub fn span_suggestions(
    &mut self,
    sp: Span,
    msg: &str,
    suggestions: Vec<String>
) -> &mut Diagnostic

pub fn set_span<S>(&mut self, sp: S) -> &mut Diagnostic where
    S: Into<MultiSpan>, 

pub fn code(&mut self, s: String) -> &mut Diagnostic

pub fn message(&self) -> String

pub fn styled_message(&self) -> &Vec<(String, Style)>

pub fn level(&self) -> Level

pub fn copy_details_not_message(&mut self, from: &Diagnostic)

Used by a lint. Copies over all details but the "main message".

Trait Implementations

impl<'a> Clone for DiagnosticBuilder<'a>

fn clone(&self) -> DiagnosticBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DiagnosticBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> DerefMut for DiagnosticBuilder<'a>

fn deref_mut(&mut self) -> &mut Diagnostic

Mutably dereferences the value.

impl<'a> Deref for DiagnosticBuilder<'a>

type Target = Diagnostic

The resulting type after dereferencing.

fn deref(&self) -> &Diagnostic

Dereferences the value.

impl<'a> Drop for DiagnosticBuilder<'a>

Destructor bomb - a DiagnosticBuilder must be either emitted or cancelled or we emit a bug.

fn drop(&mut self)

Executes the destructor for this type.