Struct swc_common::errors::Diagnostic
source · [−]pub struct Diagnostic {
pub level: Level,
pub message: Vec<(String, Style)>,
pub code: Option<DiagnosticId>,
pub span: MultiSpan,
pub children: Vec<SubDiagnostic>,
pub suggestions: Vec<CodeSuggestion>,
}
Fields
level: Level
message: Vec<(String, Style)>
code: Option<DiagnosticId>
span: MultiSpan
children: Vec<SubDiagnostic>
suggestions: Vec<CodeSuggestion>
Implementations
sourceimpl Diagnostic
impl Diagnostic
pub fn new(level: Level, message: &str) -> Self
pub fn new_with_code(
level: Level,
code: Option<DiagnosticId>,
message: &str
) -> Self
pub fn is_error(&self) -> bool
sourcepub fn cancel(&mut self)
pub fn cancel(&mut self)
Cancel the diagnostic (a structured diagnostic must either be emitted or canceled or it will panic when dropped).
pub fn cancelled(&self) -> bool
sourcepub fn span_label<T: Into<String>>(&mut self, span: Span, label: T) -> &mut Self
pub fn span_label<T: Into<String>>(&mut self, span: Span, label: T) -> &mut Self
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 replace_span_with(&mut self, after: Span) -> &mut Self
pub fn note_expected_found(
&mut self,
label: &dyn Display,
expected: DiagnosticStyledString,
found: DiagnosticStyledString
) -> &mut Self
pub fn note_expected_found_extra(
&mut self,
label: &dyn Display,
expected: DiagnosticStyledString,
found: DiagnosticStyledString,
expected_extra: &dyn Display,
found_extra: &dyn Display
) -> &mut Self
pub fn note_trait_signature(
&mut self,
name: String,
signature: String
) -> &mut Self
pub fn note(&mut self, msg: &str) -> &mut Self
pub fn highlighted_note(&mut self, msg: Vec<(String, Style)>) -> &mut Self
pub fn span_note<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self
pub fn warn(&mut self, msg: &str) -> &mut Self
pub fn span_warn<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self
pub fn help(&mut self, msg: &str) -> &mut Self
pub fn span_help<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self
sourcepub fn span_suggestion_short(
&mut self,
sp: Span,
msg: &str,
suggestion: String
) -> &mut Self
👎 Deprecated: Use span_suggestion_short_with_applicability
pub fn span_suggestion_short(
&mut self,
sp: Span,
msg: &str,
suggestion: String
) -> &mut Self
Use span_suggestion_short_with_applicability
Prints out a message with a suggested edit of the code. If the suggestion is presented inline it will only show the text message and not the text.
See CodeSuggestion
for more information.
sourcepub fn span_suggestion(
&mut self,
sp: Span,
msg: &str,
suggestion: String
) -> &mut Self
👎 Deprecated: Use span_suggestion_with_applicability
pub fn span_suggestion(
&mut self,
sp: Span,
msg: &str,
suggestion: String
) -> &mut Self
Use span_suggestion_with_applicability
Prints out a message with a suggested edit of the code.
In case of short messages and a simple suggestion, rustc displays it as a label like
“try adding parentheses: (tup.0).1
”
The message
- should not end in any punctuation (a
:
is added automatically) - should not be a question
- should not contain any parts like “the following”, “as shown”
- may look like “to do xyz, use” or “to do xyz, use abc”
- may contain a name of a function, variable or type, but not whole expressions
See CodeSuggestion
for more information.
pub fn multipart_suggestion_with_applicability(
&mut self,
msg: &str,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> &mut Self
pub fn multipart_suggestion(
&mut self,
msg: &str,
suggestion: Vec<(Span, String)>
) -> &mut Self
Use multipart_suggestion_with_applicability
sourcepub fn span_suggestions(
&mut self,
sp: Span,
msg: &str,
suggestions: Vec<String>
) -> &mut Self
👎 Deprecated: Use span_suggestions_with_applicability
pub fn span_suggestions(
&mut self,
sp: Span,
msg: &str,
suggestions: Vec<String>
) -> &mut Self
Use span_suggestions_with_applicability
Prints out a message with multiple suggested edits of the code.
sourcepub fn span_suggestion_with_applicability(
&mut self,
sp: Span,
msg: &str,
suggestion: String,
applicability: Applicability
) -> &mut Self
pub fn span_suggestion_with_applicability(
&mut self,
sp: Span,
msg: &str,
suggestion: String,
applicability: Applicability
) -> &mut Self
This is a suggestion that may contain mistakes or fillers and should be read and understood by a human.
pub fn span_suggestions_with_applicability(
&mut self,
sp: Span,
msg: &str,
suggestions: impl Iterator<Item = String>,
applicability: Applicability
) -> &mut Self
pub fn span_suggestion_short_with_applicability(
&mut self,
sp: Span,
msg: &str,
suggestion: String,
applicability: Applicability
) -> &mut Self
pub fn set_span<S: Into<MultiSpan>>(&mut self, sp: S) -> &mut Self
pub fn code(&mut self, s: DiagnosticId) -> &mut Self
pub fn get_code(&self) -> Option<DiagnosticId>
pub fn message(&self) -> String
pub fn styled_message(&self) -> &Vec<(String, Style)>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
sourcepub fn copy_details_not_message(&mut self, from: &Diagnostic)
pub fn copy_details_not_message(&mut self, from: &Diagnostic)
Used by a lint. Copies over all details but the “main message”.
Trait Implementations
sourceimpl Archive for Diagnostic where
Level: Archive,
Vec<(String, Style)>: Archive,
Option<DiagnosticId>: Archive,
MultiSpan: Archive,
Vec<SubDiagnostic>: Archive,
Vec<CodeSuggestion>: Archive,
impl Archive for Diagnostic where
Level: Archive,
Vec<(String, Style)>: Archive,
Option<DiagnosticId>: Archive,
MultiSpan: Archive,
Vec<SubDiagnostic>: Archive,
Vec<CodeSuggestion>: Archive,
sourceimpl Clone for Diagnostic
impl Clone for Diagnostic
sourcefn clone(&self) -> Diagnostic
fn clone(&self) -> Diagnostic
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for Diagnostic
impl Debug for Diagnostic
sourceimpl<'de> Deserialize<'de> for Diagnostic
impl<'de> Deserialize<'de> for Diagnostic
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<__D: Fallible + ?Sized> Deserialize<Diagnostic, __D> for Archived<Diagnostic> where
Level: Archive,
Archived<Level>: Deserialize<Level, __D>,
Vec<(String, Style)>: Archive,
Archived<Vec<(String, Style)>>: Deserialize<Vec<(String, Style)>, __D>,
Option<DiagnosticId>: Archive,
Archived<Option<DiagnosticId>>: Deserialize<Option<DiagnosticId>, __D>,
MultiSpan: Archive,
Archived<MultiSpan>: Deserialize<MultiSpan, __D>,
Vec<SubDiagnostic>: Archive,
Archived<Vec<SubDiagnostic>>: Deserialize<Vec<SubDiagnostic>, __D>,
Vec<CodeSuggestion>: Archive,
Archived<Vec<CodeSuggestion>>: Deserialize<Vec<CodeSuggestion>, __D>,
impl<__D: Fallible + ?Sized> Deserialize<Diagnostic, __D> for Archived<Diagnostic> where
Level: Archive,
Archived<Level>: Deserialize<Level, __D>,
Vec<(String, Style)>: Archive,
Archived<Vec<(String, Style)>>: Deserialize<Vec<(String, Style)>, __D>,
Option<DiagnosticId>: Archive,
Archived<Option<DiagnosticId>>: Deserialize<Option<DiagnosticId>, __D>,
MultiSpan: Archive,
Archived<MultiSpan>: Deserialize<MultiSpan, __D>,
Vec<SubDiagnostic>: Archive,
Archived<Vec<SubDiagnostic>>: Deserialize<Vec<SubDiagnostic>, __D>,
Vec<CodeSuggestion>: Archive,
Archived<Vec<CodeSuggestion>>: Deserialize<Vec<CodeSuggestion>, __D>,
sourcefn deserialize(&self, deserializer: &mut __D) -> Result<Diagnostic, __D::Error>
fn deserialize(&self, deserializer: &mut __D) -> Result<Diagnostic, __D::Error>
Deserializes using the given deserializer
sourceimpl Hash for Diagnostic
impl Hash for Diagnostic
sourceimpl PartialEq<Diagnostic> for Diagnostic
impl PartialEq<Diagnostic> for Diagnostic
sourcefn eq(&self, other: &Diagnostic) -> bool
fn eq(&self, other: &Diagnostic) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &Diagnostic) -> bool
fn ne(&self, other: &Diagnostic) -> bool
This method tests for !=
.
sourceimpl Serialize for Diagnostic
impl Serialize for Diagnostic
sourceimpl<__S: Fallible + ?Sized> Serialize<__S> for Diagnostic where
Level: Serialize<__S>,
Vec<(String, Style)>: Serialize<__S>,
Option<DiagnosticId>: Serialize<__S>,
MultiSpan: Serialize<__S>,
Vec<SubDiagnostic>: Serialize<__S>,
Vec<CodeSuggestion>: Serialize<__S>,
impl<__S: Fallible + ?Sized> Serialize<__S> for Diagnostic where
Level: Serialize<__S>,
Vec<(String, Style)>: Serialize<__S>,
Option<DiagnosticId>: Serialize<__S>,
MultiSpan: Serialize<__S>,
Vec<SubDiagnostic>: Serialize<__S>,
Vec<CodeSuggestion>: Serialize<__S>,
impl Eq for Diagnostic
impl StructuralEq for Diagnostic
impl StructuralPartialEq for Diagnostic
Auto Trait Implementations
impl RefUnwindSafe for Diagnostic
impl Send for Diagnostic
impl Sync for Diagnostic
impl Unpin for Diagnostic
impl UnwindSafe for Diagnostic
Blanket Implementations
sourceimpl<T> ArchivePointee for T
impl<T> ArchivePointee for T
type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
sourcefn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
sourceimpl<T> ArchiveUnsized for T where
T: Archive,
impl<T> ArchiveUnsized for T where
T: Archive,
type Archived = <T as Archive>::Archived
type Archived = <T as Archive>::Archived
The archived counterpart of this type. Unlike Archive
, it may be unsized. Read more
type MetadataResolver = ()
type MetadataResolver = ()
The resolver for the metadata of this type. Read more
sourceunsafe fn resolve_metadata(
&self,
usize,
<T as ArchiveUnsized>::MetadataResolver,
*mut <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata
)
unsafe fn resolve_metadata(
&self,
usize,
<T as ArchiveUnsized>::MetadataResolver,
*mut <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata
)
Creates the archived version of the metadata for this value at the given position and writes it to the given output. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> CallHasher for T where
T: Hash + ?Sized,
impl<T> CallHasher for T where
T: Hash + ?Sized,
sourceimpl<F, W, T, D> Deserialize<With<T, W>, D> for F where
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
impl<F, W, T, D> Deserialize<With<T, W>, D> for F where
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T, S> SerializeUnsized<S> for T where
T: Serialize<S>,
S: Serializer + ?Sized,
impl<T, S> SerializeUnsized<S> for T where
T: Serialize<S>,
S: Serializer + ?Sized,
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more