Struct syntex_syntax2::diagnostics::plugin::diagnostic::Diagnostic

#[must_use]
pub struct Diagnostic {
    pub level: Level,
    pub message: Vec<(String, Style)>,
    pub code: Option<String>,
    pub span: MultiSpan,
    pub children: Vec<SubDiagnostic>,
    pub suggestions: Vec<CodeSuggestion>,
}

Fields

level: Level

message: Vec<(String, Style)>

code: Option<String>

span: MultiSpan

children: Vec<SubDiagnostic>

suggestions: Vec<CodeSuggestion>

Methods

impl Diagnostic

pub fn new(level: Level, message: &str) -> Diagnostic

pub fn new_with_code(
    level: Level,
    code: Option<String>,
    message: &str
) -> 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 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Diagnostic

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Diagnostic, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Diagnostic> for Diagnostic

fn eq(&self, other: &Diagnostic) -> bool

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

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

This method tests for !=.

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.