#[repr(C)]pub struct Diagnostic {
pub level: Level,
pub message: Vec<Message>,
pub code: Option<DiagnosticId>,
pub span: MultiSpan,
pub children: Vec<SubDiagnostic>,
pub suggestions: Vec<CodeSuggestion>,
}
Fields§
§level: Level
§message: Vec<Message>
§code: Option<DiagnosticId>
§span: MultiSpan
§children: Vec<SubDiagnostic>
§suggestions: Vec<CodeSuggestion>
Implementations§
source§impl 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<Message>) -> &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
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
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
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
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<Message>
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§
source§impl Archive for Diagnosticwhere
Level: Archive,
Vec<Message>: Archive,
Option<DiagnosticId>: Archive,
MultiSpan: Archive,
Vec<SubDiagnostic>: Archive,
Vec<CodeSuggestion>: Archive,
impl Archive for Diagnosticwhere
Level: Archive,
Vec<Message>: Archive,
Option<DiagnosticId>: Archive,
MultiSpan: Archive,
Vec<SubDiagnostic>: Archive,
Vec<CodeSuggestion>: Archive,
source§const COPY_OPTIMIZATION: CopyOptimization<Self> = _
const COPY_OPTIMIZATION: CopyOptimization<Self> = _
serialize
. Read moresource§impl<__C: Fallible + ?Sized> CheckBytes<__C> for Diagnosticwhere
<__C as Fallible>::Error: Trace,
Level: CheckBytes<__C>,
Vec<Message>: CheckBytes<__C>,
Option<DiagnosticId>: CheckBytes<__C>,
MultiSpan: CheckBytes<__C>,
Vec<SubDiagnostic>: CheckBytes<__C>,
Vec<CodeSuggestion>: CheckBytes<__C>,
impl<__C: Fallible + ?Sized> CheckBytes<__C> for Diagnosticwhere
<__C as Fallible>::Error: Trace,
Level: CheckBytes<__C>,
Vec<Message>: CheckBytes<__C>,
Option<DiagnosticId>: CheckBytes<__C>,
MultiSpan: CheckBytes<__C>,
Vec<SubDiagnostic>: CheckBytes<__C>,
Vec<CodeSuggestion>: CheckBytes<__C>,
source§impl Clone for Diagnostic
impl Clone for Diagnostic
source§fn clone(&self) -> Diagnostic
fn clone(&self) -> Diagnostic
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Diagnostic
impl Debug for Diagnostic
source§impl<'de> Deserialize<'de> for Diagnostic
impl<'de> Deserialize<'de> for Diagnostic
source§fn 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>,
source§impl<__D: Fallible + ?Sized> Deserialize<Diagnostic, __D> for Archived<Diagnostic>where
Level: Archive,
<Level as Archive>::Archived: Deserialize<Level, __D>,
Vec<Message>: Archive,
<Vec<Message> as Archive>::Archived: Deserialize<Vec<Message>, __D>,
Option<DiagnosticId>: Archive,
<Option<DiagnosticId> as Archive>::Archived: Deserialize<Option<DiagnosticId>, __D>,
MultiSpan: Archive,
<MultiSpan as Archive>::Archived: Deserialize<MultiSpan, __D>,
Vec<SubDiagnostic>: Archive,
<Vec<SubDiagnostic> as Archive>::Archived: Deserialize<Vec<SubDiagnostic>, __D>,
Vec<CodeSuggestion>: Archive,
<Vec<CodeSuggestion> as Archive>::Archived: Deserialize<Vec<CodeSuggestion>, __D>,
impl<__D: Fallible + ?Sized> Deserialize<Diagnostic, __D> for Archived<Diagnostic>where
Level: Archive,
<Level as Archive>::Archived: Deserialize<Level, __D>,
Vec<Message>: Archive,
<Vec<Message> as Archive>::Archived: Deserialize<Vec<Message>, __D>,
Option<DiagnosticId>: Archive,
<Option<DiagnosticId> as Archive>::Archived: Deserialize<Option<DiagnosticId>, __D>,
MultiSpan: Archive,
<MultiSpan as Archive>::Archived: Deserialize<MultiSpan, __D>,
Vec<SubDiagnostic>: Archive,
<Vec<SubDiagnostic> as Archive>::Archived: Deserialize<Vec<SubDiagnostic>, __D>,
Vec<CodeSuggestion>: Archive,
<Vec<CodeSuggestion> as Archive>::Archived: Deserialize<Vec<CodeSuggestion>, __D>,
source§fn deserialize(
&self,
deserializer: &mut __D,
) -> Result<Diagnostic, <__D as Fallible>::Error>
fn deserialize( &self, deserializer: &mut __D, ) -> Result<Diagnostic, <__D as Fallible>::Error>
source§impl Hash for Diagnostic
impl Hash for Diagnostic
source§impl PartialEq for Diagnostic
impl PartialEq for Diagnostic
source§impl<__S: Fallible + ?Sized> Serialize<__S> for Diagnosticwhere
Level: Serialize<__S>,
Vec<Message>: Serialize<__S>,
Option<DiagnosticId>: Serialize<__S>,
MultiSpan: Serialize<__S>,
Vec<SubDiagnostic>: Serialize<__S>,
Vec<CodeSuggestion>: Serialize<__S>,
impl<__S: Fallible + ?Sized> Serialize<__S> for Diagnosticwhere
Level: Serialize<__S>,
Vec<Message>: Serialize<__S>,
Option<DiagnosticId>: Serialize<__S>,
MultiSpan: Serialize<__S>,
Vec<SubDiagnostic>: Serialize<__S>,
Vec<CodeSuggestion>: Serialize<__S>,
source§impl Serialize for Diagnostic
impl Serialize for Diagnostic
impl Eq for Diagnostic
impl StructuralPartialEq for Diagnostic
Auto Trait Implementations§
impl Freeze for Diagnostic
impl RefUnwindSafe for Diagnostic
impl Send for Diagnostic
impl Sync for Diagnostic
impl Unpin for Diagnostic
impl UnwindSafe for Diagnostic
Blanket Implementations§
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
§impl<T> ArchiveUnsized for Twhere
T: Archive,
impl<T> ArchiveUnsized for Twhere
T: Archive,
§type Archived = <T as Archive>::Archived
type Archived = <T as Archive>::Archived
Archive
, it may be
unsized. Read more§fn archived_metadata(
&self,
) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata
fn archived_metadata( &self, ) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Pointee for T
impl<T> Pointee for T
§impl<T, S> SerializeUnsized<S> for Twhere
T: Serialize<S>,
S: Fallible + Writer + ?Sized,
impl<T, S> SerializeUnsized<S> for Twhere
T: Serialize<S>,
S: Fallible + Writer + ?Sized,
§fn serialize_unsized(
&self,
serializer: &mut S,
) -> Result<usize, <S as Fallible>::Error>
fn serialize_unsized( &self, serializer: &mut S, ) -> Result<usize, <S as Fallible>::Error>
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.