# Struct rustc_errors::diagnostic::Diagnostic

source ·

    pub struct Diagnostic {
        pub(crate) level: Level,
        pub messages: Vec<(DiagnosticMessage, Style)>,
        pub code: Option<DiagnosticId>,
        pub span: MultiSpan,
        pub children: Vec<SubDiagnostic>,
        pub suggestions: Result<Vec<CodeSuggestion>, SuggestionsDisabled>,
        args: FxHashMap<Cow<'static, str>, DiagnosticArgValue<'static>>,
        pub sort_span: Span,
        pub is_lint: bool,
        pub emitted_at: DiagnosticLocation,
    }

## Fields§

§`level: Level`§`messages: Vec<(DiagnosticMessage, Style)>`§`code: Option<DiagnosticId>`§`span: MultiSpan`§`children: Vec<SubDiagnostic>`§`suggestions: Result<Vec<CodeSuggestion>, SuggestionsDisabled>`§`args: FxHashMap<Cow<'static, str>, DiagnosticArgValue<'static>>`§`sort_span: Span`

This is not used for highlighting or rendering any error message. Rather, it can be used as a sort key to sort a buffer of diagnostics. By default, it is the primary span of `span` if there is one. Otherwise, it is `DUMMY_SP`.

§`is_lint: bool`

If diagnostic is from Lint, custom hash function ignores notes otherwise hash is based on the all the fields

§`emitted_at: DiagnosticLocation`

With `-Ztrack_diagnostics` enabled, we print where in rustc this error was emitted.

## Implementations§

source§

### impl Diagnostic

source

#### pub fn new<M: Into<DiagnosticMessage>>(level: Level, message: M) -> Self

source

#### pub fn new_with_messages( level: Level, messages: Vec<(DiagnosticMessage, Style)> ) -> Self

source

#### pub fn level(&self) -> Level

source

#### pub fn is_error(&self) -> bool

source

#### pub(crate) fn update_unstable_expectation_id( &mut self, unstable_to_stable: &FxIndexMap<LintExpectationId, LintExpectationId> )

source

#### pub(crate) fn has_future_breakage(&self) -> bool

Indicates whether this diagnostic should show up in cargo’s future breakage report.

source

#### pub(crate) fn is_force_warn(&self) -> bool

source

#### pub fn downgrade_to_delayed_bug(&mut self)

Delay emission of this diagnostic as a bug.

This can be useful in contexts where an error indicates a bug but typically this only happens when other compilation errors have already happened. In those cases this can be used to defer emission of this diagnostic as a bug in the compiler only if no other errors have been emitted.

In the meantime, though, callsites are required to deal with the “bug” locally in whichever way makes the most sense.

source

#### pub fn span_label( &mut self, span: Span, label: impl Into<SubdiagnosticMessage> ) -> &mut Self

Appends a labeled span to the diagnostic.

Labels are used to convey additional context for the diagnostic’s primary span. They will be shown together with the original diagnostic’s span, not with spans added by `span_note`, `span_help`, etc. Therefore, if the primary span is not displayable (because the span is `DUMMY_SP` or the source code isn’t found), labels will not be displayed either.

Implementation-wise, the label span is pushed onto the `MultiSpan` that was created when the diagnostic was constructed. However, the label span is not considered a “primary span”; only the `Span` supplied when creating the diagnostic is primary.

source

#### pub fn span_labels( &mut self, spans: impl IntoIterator<Item = Span>, label: &str ) -> &mut Self

Labels all the given spans with the provided label. See `Self::span_label()` for more information.

source

#### pub fn replace_span_with(&mut self, after: Span, keep_label: bool) -> &mut Self

source

#### pub fn note_expected_found( &mut self, expected_label: &dyn Display, expected: DiagnosticStyledString, found_label: &dyn Display, found: DiagnosticStyledString ) -> &mut Self

source

#### pub fn note_expected_found_extra( &mut self, expected_label: &dyn Display, expected: DiagnosticStyledString, found_label: &dyn Display, found: DiagnosticStyledString, expected_extra: &dyn Display, found_extra: &dyn Display ) -> &mut Self

source

#### pub fn note_trait_signature( &mut self, name: Symbol, signature: String ) -> &mut Self

source

#### pub fn note(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self

Add a note attached to this diagnostic.

source

#### fn highlighted_note<M: Into<SubdiagnosticMessage>>( &mut self, msg: Vec<(M, Style)> ) -> &mut Self

source

#### pub fn note_once(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self

Prints the span with a note above it. This is like `Diagnostic::note()`, but it gets its own span.

source

#### pub fn span_note<S: Into<MultiSpan>>( &mut self, sp: S, msg: impl Into<SubdiagnosticMessage> ) -> &mut Self

Prints the span with a note above it. This is like `Diagnostic::note()`, but it gets its own span.

source

#### pub fn span_note_once<S: Into<MultiSpan>>( &mut self, sp: S, msg: impl Into<SubdiagnosticMessage> ) -> &mut Self

Prints the span with a note above it. This is like `Diagnostic::note()`, but it gets its own span.

source

#### pub fn warn(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self

Add a warning attached to this diagnostic.

source

#### pub fn span_warn<S: Into<MultiSpan>>( &mut self, sp: S, msg: impl Into<SubdiagnosticMessage> ) -> &mut Self

Prints the span with a warning above it. This is like `Diagnostic::warn()`, but it gets its own span.

source

#### pub fn help(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self

Add a help message attached to this diagnostic.

source

#### pub fn help_once(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self

Prints the span with a help above it. This is like `Diagnostic::help()`, but it gets its own span.

source

#### pub fn highlighted_help(&mut self, msg: Vec<(String, Style)>) -> &mut Self

Add a help message attached to this diagnostic with a customizable highlighted message.

source

#### pub fn span_help<S: Into<MultiSpan>>( &mut self, sp: S, msg: impl Into<SubdiagnosticMessage> ) -> &mut Self

Prints the span with some help above it. This is like `Diagnostic::help()`, but it gets its own span.

source

#### pub fn disable_suggestions(&mut self) -> &mut Self

Disallow attaching suggestions this diagnostic. Any suggestions attached e.g. with the `span_suggestion_*` methods (before and after the call to `disable_suggestions`) will be ignored.

source

#### fn push_suggestion(&mut self, suggestion: CodeSuggestion)

Helper for pushing to `self.suggestions`, if available (not disable).

source

#### pub fn multipart_suggestion( &mut self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability ) -> &mut Self

Show a suggestion that has multiple parts to it. In other words, multiple changes need to be applied as part of this suggestion.

source

#### pub fn multipart_suggestion_verbose( &mut self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability ) -> &mut Self

Show a suggestion that has multiple parts to it, always as it’s own subdiagnostic. In other words, multiple changes need to be applied as part of this suggestion.

source

#### pub fn multipart_suggestion_with_style( &mut self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability, style: SuggestionStyle ) -> &mut Self

`Diagnostic::multipart_suggestion()` but you can set the `SuggestionStyle`.

source

#### pub fn tool_only_multipart_suggestion( &mut self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability ) -> &mut Self

Prints out a message with for a multipart suggestion without showing the suggested code.

This is intended to be used for suggestions that are obvious in what the changes need to be from the message, showing the span label inline would be visually unpleasant (marginally overlapping spans or multiline spans) and showing the snippet window wouldn’t improve understandability.

source

#### pub fn span_suggestion( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> &mut Self

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:

    try adding parentheses: `(tup.0).1`

The message

- should not end in any punctuation (a `:` is added automatically)
- should not be a question (avoid language like “did you mean”)
- should not contain any phrases like “the following”, “as shown”, etc.
- 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.

source

#### pub fn span_suggestion_with_style( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability, style: SuggestionStyle ) -> &mut Self

`Diagnostic::span_suggestion()` but you can set the `SuggestionStyle`.

source

#### pub fn span_suggestion_verbose( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> &mut Self

Always show the suggested change.

source

#### pub fn span_suggestions( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestions: impl IntoIterator<Item = String>, applicability: Applicability ) -> &mut Self

Prints out a message with multiple suggested edits of the code. See also `Diagnostic::span_suggestion()`.

source

#### pub fn span_suggestions_with_style( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestions: impl IntoIterator<Item = String>, applicability: Applicability, style: SuggestionStyle ) -> &mut Self

`Diagnostic::span_suggestions()` but you can set the `SuggestionStyle`.

source

#### pub fn multipart_suggestions( &mut self, msg: impl Into<SubdiagnosticMessage>, suggestions: impl IntoIterator<Item = Vec<(Span, String)>>, applicability: Applicability ) -> &mut Self

Prints out a message with multiple suggested edits of the code, where each edit consists of multiple parts. See also `Diagnostic::multipart_suggestion()`.

source

#### pub fn span_suggestion_short( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> &mut Self

Prints out a message with a suggested edit of the code. If the suggestion is presented inline, it will only show the message and not the suggestion.

See `CodeSuggestion` for more information.

source

#### pub fn span_suggestion_hidden( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> &mut Self

Prints out a message for a suggestion without showing the suggested code.

This is intended to be used for suggestions that are obvious in what the changes need to be from the message, showing the span label inline would be visually unpleasant (marginally overlapping spans or multiline spans) and showing the snippet window wouldn’t improve understandability.

source

#### pub fn tool_only_span_suggestion( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> &mut Self

Adds a suggestion to the JSON output that will not be shown in the CLI.

This is intended to be used for suggestions that are very obvious in what the changes need to be from the message, but we still want other tools to be able to apply them.

source

#### pub fn subdiagnostic( &mut self, subdiagnostic: impl AddToDiagnostic ) -> &mut Self

Add a subdiagnostic from a type that implements `Subdiagnostic` (see rustc_macros::Subdiagnostic).

source

#### pub fn eager_subdiagnostic( &mut self, dcx: &DiagCtxt, subdiagnostic: impl AddToDiagnostic ) -> &mut Self

Add a subdiagnostic from a type that implements `Subdiagnostic` (see rustc_macros::Subdiagnostic). Performs eager translation of any translatable messages used in the subdiagnostic, so suitable for use with repeated messages (i.e. re-use of interpolated variables).

source

#### pub fn span<S: Into<MultiSpan>>(&mut self, sp: S) -> &mut Self

source

#### pub fn is_lint(&mut self) -> &mut Self

source

#### pub fn code(&mut self, s: DiagnosticId) -> &mut Self

source

#### pub fn clear_code(&mut self) -> &mut Self

source

#### pub fn get_code(&self) -> Option<DiagnosticId>

source

#### pub fn primary_message( &mut self, msg: impl Into<DiagnosticMessage> ) -> &mut Self

source

#### pub fn args(&self) -> impl Iterator<Item = DiagnosticArg<'_, 'static>>

source

#### pub fn arg( &mut self, name: impl Into<Cow<'static, str>>, arg: impl IntoDiagnosticArg ) -> &mut Self

source

#### pub fn replace_args( &mut self, args: FxHashMap<Cow<'static, str>, DiagnosticArgValue<'static>> )

source

#### pub fn messages(&self) -> &[(DiagnosticMessage, Style)]

source

#### fn subdiagnostic_message_to_diagnostic_message( &self, attr: impl Into<SubdiagnosticMessage> ) -> DiagnosticMessage

Helper function that takes a `SubdiagnosticMessage` and returns a `DiagnosticMessage` by combining it with the primary message of the diagnostic (if translatable, otherwise it just passes the user’s string along).

source

#### pub fn sub( &mut self, level: Level, message: impl Into<SubdiagnosticMessage>, span: MultiSpan )

Convenience function for internal use, clients should use one of the public methods above.

Used by `proc_macro_server` for implementing `server::Diagnostic`.

source

#### fn sub_with_highlights<M: Into<SubdiagnosticMessage>>( &mut self, level: Level, messages: Vec<(M, Style)>, span: MultiSpan )

Convenience function for internal use, clients should use one of the public methods above.

source

#### fn keys( &self ) -> (&Level, &[(DiagnosticMessage, Style)], Vec<(&Cow<'static, str>, &DiagnosticArgValue<'static>)>, &Option<DiagnosticId>, &MultiSpan, &Result<Vec<CodeSuggestion>, SuggestionsDisabled>, Option<&[SubDiagnostic]>)

Fields used for Hash, and PartialEq trait

## Trait Implementations§

source§

### impl Clone for Diagnostic

source§

#### fn clone(&self) -> Diagnostic

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for Diagnostic

source§

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

Formats the value using the given formatter. Read more
source§

### impl<__D: SpanDecoder> Decodable<__D> for Diagnostic

source§

#### fn decode(__decoder: &mut __D) -> Self

source§

### impl<__E: SpanEncoder> Encodable<__E> for Diagnostic

source§

#### fn encode(&self, __encoder: &mut __E)

source§

### impl Hash for Diagnostic

source§

#### fn hash<H>(&self, state: &mut H)
where H: Hasher,

Feeds this value into the given `Hasher`. Read more
1.3.0 · source§

#### fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given `Hasher`. Read more
source§

### impl PartialEq for Diagnostic

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.

## 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§

source§

### impl<T> Any for T
where T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for T
where T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for T
where U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> ToOwned for T
where T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 256 bytes