pub struct DiagnosticBuilder<'a, G: EmissionGuarantee = ErrorGuaranteed> {
pub dcx: &'a DiagCtxt,
diag: Option<Box<Diagnostic>>,
_marker: PhantomData<G>,
}
Expand description
Used for emitting structured error messages and other diagnostic information.
Each constructed DiagnosticBuilder
must be consumed by a function such as
emit
, cancel
, delay_as_bug
, or into_diagnostic
. A panic occurrs if a
DiagnosticBuilder
is dropped without being consumed by one of these
functions.
If there is some state in a downstream crate you would like to
access in the methods of DiagnosticBuilder
here, consider
extending DiagCtxtFlags
.
Fields§
§dcx: &'a DiagCtxt
§diag: Option<Box<Diagnostic>>
Why the Option
? It is always Some
until the DiagnosticBuilder
is
consumed via emit
, cancel
, etc. At that point it is consumed and
replaced with None
. Then drop
checks that it is None
; if not, it
panics because a diagnostic was built but not used.
Why the Box? Diagnostic
is a large type, and DiagnosticBuilder
is
often used as a return value, especially within the frequently-used
PResult
type. In theory, return value optimization (RVO) should avoid
unnecessary copying. In practice, it does not (at the time of writing).
_marker: PhantomData<G>
Implementations§
source§impl<'a, G: EmissionGuarantee> DiagnosticBuilder<'a, G>
impl<'a, G: EmissionGuarantee> DiagnosticBuilder<'a, G>
sourcefn take_diag(&mut self) -> Diagnostic
fn take_diag(&mut self) -> Diagnostic
Takes the diagnostic. For use by methods that consume the
DiagnosticBuilder: emit
, cancel
, etc. Afterwards, drop
is the
only code that will be run on self
.
sourcefn emit_producing_nothing(self)
fn emit_producing_nothing(self)
Most emit_producing_guarantee
functions use this as a starting point.
sourcefn emit_producing_error_guaranteed(self) -> ErrorGuaranteed
fn emit_producing_error_guaranteed(self) -> ErrorGuaranteed
ErrorGuaranteed::emit_producing_guarantee
uses this.
source§impl<'a, G: EmissionGuarantee> DiagnosticBuilder<'a, G>
impl<'a, G: EmissionGuarantee> DiagnosticBuilder<'a, G>
pub fn new<M: Into<DiagnosticMessage>>( dcx: &'a DiagCtxt, level: Level, message: M ) -> Self
sourcepub(crate) fn new_diagnostic(dcx: &'a DiagCtxt, diag: Diagnostic) -> Self
pub(crate) fn new_diagnostic(dcx: &'a DiagCtxt, diag: Diagnostic) -> Self
Creates a new DiagnosticBuilder
with an already constructed
diagnostic.
sourcepub fn emit(self) -> G::EmitResult
pub fn emit(self) -> G::EmitResult
Emit and consume the diagnostic.
sourcepub fn emit_unless(self, delay: bool) -> G::EmitResult
pub fn emit_unless(self, delay: bool) -> G::EmitResult
Emit the diagnostic unless delay
is true,
in which case the emission will be delayed as a bug.
See emit
and delay_as_bug
for details.
sourcepub fn cancel(self)
pub fn cancel(self)
Cancel and consume the diagnostic. (A diagnostic must either be emitted or cancelled or it will panic when dropped).
sourcepub fn stash(self, span: Span, key: StashKey)
pub fn stash(self, span: Span, key: StashKey)
Stashes diagnostic for possible later improvement in a different,
later stage of the compiler. The diagnostic can be accessed with
the provided span
and key
through DiagCtxt::steal_diagnostic()
.
sourcepub fn into_diagnostic(self) -> Diagnostic
pub fn into_diagnostic(self) -> Diagnostic
Converts the builder to a Diagnostic
for later emission.
sourcepub fn delay_as_bug(self) -> G::EmitResult
pub fn delay_as_bug(self) -> G::EmitResult
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.
sourcepub fn span_label(
&mut self,
span: Span,
label: impl Into<SubdiagnosticMessage>
) -> &mut Self
pub fn span_label( &mut self, span: Span, label: impl Into<SubdiagnosticMessage> ) -> &mut Self
sourcepub fn with_span_label(
self,
span: Span,
label: impl Into<SubdiagnosticMessage>
) -> Self
pub fn with_span_label( self, span: Span, label: impl Into<SubdiagnosticMessage> ) -> Self
sourcepub fn span_labels(
&mut self,
spans: impl IntoIterator<Item = Span>,
label: &str
) -> &mut Self
pub fn span_labels( &mut self, spans: impl IntoIterator<Item = Span>, label: &str ) -> &mut Self
sourcepub fn with_span_labels(
self,
spans: impl IntoIterator<Item = Span>,
label: &str
) -> Self
pub fn with_span_labels( self, spans: impl IntoIterator<Item = Span>, label: &str ) -> Self
sourcepub fn note_expected_found(
&mut self,
expected_label: &dyn Display,
expected: DiagnosticStyledString,
found_label: &dyn Display,
found: DiagnosticStyledString
) -> &mut Self
pub fn note_expected_found( &mut self, expected_label: &dyn Display, expected: DiagnosticStyledString, found_label: &dyn Display, found: DiagnosticStyledString ) -> &mut Self
sourcepub fn with_note_expected_found(
self,
expected_label: &dyn Display,
expected: DiagnosticStyledString,
found_label: &dyn Display,
found: DiagnosticStyledString
) -> Self
pub fn with_note_expected_found( self, expected_label: &dyn Display, expected: DiagnosticStyledString, found_label: &dyn Display, found: DiagnosticStyledString ) -> Self
sourcepub 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
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
sourcepub fn with_note_expected_found_extra(
self,
expected_label: &dyn Display,
expected: DiagnosticStyledString,
found_label: &dyn Display,
found: DiagnosticStyledString,
expected_extra: &dyn Display,
found_extra: &dyn Display
) -> Self
pub fn with_note_expected_found_extra( self, expected_label: &dyn Display, expected: DiagnosticStyledString, found_label: &dyn Display, found: DiagnosticStyledString, expected_extra: &dyn Display, found_extra: &dyn Display ) -> Self
sourcepub fn note(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
pub fn note(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
See Diagnostic::note()
.
sourcepub fn with_note(self, msg: impl Into<SubdiagnosticMessage>) -> Self
pub fn with_note(self, msg: impl Into<SubdiagnosticMessage>) -> Self
See Diagnostic::note()
.
sourcepub fn note_once(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
pub fn note_once(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
sourcepub fn with_note_once(self, msg: impl Into<SubdiagnosticMessage>) -> Self
pub fn with_note_once(self, msg: impl Into<SubdiagnosticMessage>) -> Self
sourcepub fn span_note(
&mut self,
sp: impl Into<MultiSpan>,
msg: impl Into<SubdiagnosticMessage>
) -> &mut Self
pub fn span_note( &mut self, sp: impl Into<MultiSpan>, msg: impl Into<SubdiagnosticMessage> ) -> &mut Self
sourcepub fn with_span_note(
self,
sp: impl Into<MultiSpan>,
msg: impl Into<SubdiagnosticMessage>
) -> Self
pub fn with_span_note( self, sp: impl Into<MultiSpan>, msg: impl Into<SubdiagnosticMessage> ) -> Self
sourcepub fn span_note_once(
&mut self,
sp: impl Into<MultiSpan>,
msg: impl Into<SubdiagnosticMessage>
) -> &mut Self
pub fn span_note_once( &mut self, sp: impl Into<MultiSpan>, msg: impl Into<SubdiagnosticMessage> ) -> &mut Self
sourcepub fn with_span_note_once(
self,
sp: impl Into<MultiSpan>,
msg: impl Into<SubdiagnosticMessage>
) -> Self
pub fn with_span_note_once( self, sp: impl Into<MultiSpan>, msg: impl Into<SubdiagnosticMessage> ) -> Self
sourcepub fn warn(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
pub fn warn(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
See Diagnostic::warn()
.
sourcepub fn with_warn(self, msg: impl Into<SubdiagnosticMessage>) -> Self
pub fn with_warn(self, msg: impl Into<SubdiagnosticMessage>) -> Self
See Diagnostic::warn()
.
sourcepub fn span_warn(
&mut self,
sp: impl Into<MultiSpan>,
msg: impl Into<SubdiagnosticMessage>
) -> &mut Self
pub fn span_warn( &mut self, sp: impl Into<MultiSpan>, msg: impl Into<SubdiagnosticMessage> ) -> &mut Self
sourcepub fn with_span_warn(
self,
sp: impl Into<MultiSpan>,
msg: impl Into<SubdiagnosticMessage>
) -> Self
pub fn with_span_warn( self, sp: impl Into<MultiSpan>, msg: impl Into<SubdiagnosticMessage> ) -> Self
sourcepub fn help(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
pub fn help(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
See Diagnostic::help()
.
sourcepub fn with_help(self, msg: impl Into<SubdiagnosticMessage>) -> Self
pub fn with_help(self, msg: impl Into<SubdiagnosticMessage>) -> Self
See Diagnostic::help()
.
sourcepub fn help_once(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
pub fn help_once(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
sourcepub fn with_help_once(self, msg: impl Into<SubdiagnosticMessage>) -> Self
pub fn with_help_once(self, msg: impl Into<SubdiagnosticMessage>) -> Self
sourcepub fn span_help(
&mut self,
sp: impl Into<MultiSpan>,
msg: impl Into<SubdiagnosticMessage>
) -> &mut Self
pub fn span_help( &mut self, sp: impl Into<MultiSpan>, msg: impl Into<SubdiagnosticMessage> ) -> &mut Self
sourcepub fn with_span_help_once(
self,
sp: impl Into<MultiSpan>,
msg: impl Into<SubdiagnosticMessage>
) -> Self
pub fn with_span_help_once( self, sp: impl Into<MultiSpan>, msg: impl Into<SubdiagnosticMessage> ) -> Self
sourcepub fn multipart_suggestion(
&mut self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> &mut Self
pub fn multipart_suggestion( &mut self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability ) -> &mut Self
sourcepub fn with_multipart_suggestion(
self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> Self
pub fn with_multipart_suggestion( self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability ) -> Self
sourcepub fn multipart_suggestion_verbose(
&mut self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> &mut Self
pub fn multipart_suggestion_verbose( &mut self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability ) -> &mut Self
sourcepub fn with_multipart_suggestion_verbose(
self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> Self
pub fn with_multipart_suggestion_verbose( self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability ) -> Self
sourcepub fn tool_only_multipart_suggestion(
&mut self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> &mut Self
pub fn tool_only_multipart_suggestion( &mut self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability ) -> &mut Self
sourcepub fn with_tool_only_multipart_suggestion(
self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> Self
pub fn with_tool_only_multipart_suggestion( self, msg: impl Into<SubdiagnosticMessage>, suggestion: Vec<(Span, String)>, applicability: Applicability ) -> Self
sourcepub fn span_suggestion(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> &mut Self
pub fn span_suggestion( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> &mut Self
sourcepub fn with_span_suggestion(
self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> Self
pub fn with_span_suggestion( self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> Self
sourcepub fn span_suggestions(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestions: impl IntoIterator<Item = String>,
applicability: Applicability
) -> &mut Self
pub fn span_suggestions( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestions: impl IntoIterator<Item = String>, applicability: Applicability ) -> &mut Self
sourcepub fn with_span_suggestions(
self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestions: impl IntoIterator<Item = String>,
applicability: Applicability
) -> Self
pub fn with_span_suggestions( self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestions: impl IntoIterator<Item = String>, applicability: Applicability ) -> Self
sourcepub fn multipart_suggestions(
&mut self,
msg: impl Into<SubdiagnosticMessage>,
suggestions: impl IntoIterator<Item = Vec<(Span, String)>>,
applicability: Applicability
) -> &mut Self
pub fn multipart_suggestions( &mut self, msg: impl Into<SubdiagnosticMessage>, suggestions: impl IntoIterator<Item = Vec<(Span, String)>>, applicability: Applicability ) -> &mut Self
sourcepub fn with_multipart_suggestions(
self,
msg: impl Into<SubdiagnosticMessage>,
suggestions: impl IntoIterator<Item = Vec<(Span, String)>>,
applicability: Applicability
) -> Self
pub fn with_multipart_suggestions( self, msg: impl Into<SubdiagnosticMessage>, suggestions: impl IntoIterator<Item = Vec<(Span, String)>>, applicability: Applicability ) -> Self
sourcepub fn span_suggestion_short(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> &mut Self
pub fn span_suggestion_short( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> &mut Self
sourcepub fn with_span_suggestion_short(
self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> Self
pub fn with_span_suggestion_short( self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> Self
sourcepub fn span_suggestion_verbose(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> &mut Self
pub fn span_suggestion_verbose( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> &mut Self
sourcepub fn with_span_suggestion_verbose(
self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> Self
pub fn with_span_suggestion_verbose( self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> Self
sourcepub fn tool_only_span_suggestion(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> &mut Self
pub fn tool_only_span_suggestion( &mut self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> &mut Self
sourcepub fn with_tool_only_span_suggestion(
self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> Self
pub fn with_tool_only_span_suggestion( self, sp: Span, msg: impl Into<SubdiagnosticMessage>, suggestion: impl ToString, applicability: Applicability ) -> Self
sourcepub fn primary_message(
&mut self,
msg: impl Into<DiagnosticMessage>
) -> &mut Self
pub fn primary_message( &mut self, msg: impl Into<DiagnosticMessage> ) -> &mut Self
sourcepub fn with_primary_message(self, msg: impl Into<DiagnosticMessage>) -> Self
pub fn with_primary_message(self, msg: impl Into<DiagnosticMessage>) -> Self
sourcepub fn with_span(self, sp: impl Into<MultiSpan>) -> Self
pub fn with_span(self, sp: impl Into<MultiSpan>) -> Self
See Diagnostic::span()
.
sourcepub fn with_is_lint(self, name: String, has_future_breakage: bool) -> Self
pub fn with_is_lint(self, name: String, has_future_breakage: bool) -> Self
sourcepub fn code(&mut self, code: ErrCode) -> &mut Self
pub fn code(&mut self, code: ErrCode) -> &mut Self
See Diagnostic::code()
.
sourcepub fn with_code(self, code: ErrCode) -> Self
pub fn with_code(self, code: ErrCode) -> Self
See Diagnostic::code()
.
sourcepub fn arg(
&mut self,
name: impl Into<Cow<'static, str>>,
arg: impl IntoDiagnosticArg
) -> &mut Self
pub fn arg( &mut self, name: impl Into<Cow<'static, str>>, arg: impl IntoDiagnosticArg ) -> &mut Self
See Diagnostic::arg()
.
sourcepub fn with_arg(
self,
name: impl Into<Cow<'static, str>>,
arg: impl IntoDiagnosticArg
) -> Self
pub fn with_arg( self, name: impl Into<Cow<'static, str>>, arg: impl IntoDiagnosticArg ) -> Self
See Diagnostic::arg()
.
sourcepub fn subdiagnostic(
&mut self,
subdiagnostic: impl AddToDiagnostic
) -> &mut Self
pub fn subdiagnostic( &mut self, subdiagnostic: impl AddToDiagnostic ) -> &mut Self
sourcepub fn with_subdiagnostic(self, subdiagnostic: impl AddToDiagnostic) -> Self
pub fn with_subdiagnostic(self, subdiagnostic: impl AddToDiagnostic) -> Self
sourcepub fn eager_subdiagnostic(
&mut self,
dcx: &DiagCtxt,
subdiagnostic: impl AddToDiagnostic
) -> &mut Self
pub fn eager_subdiagnostic( &mut self, dcx: &DiagCtxt, subdiagnostic: impl AddToDiagnostic ) -> &mut Self
sourcepub fn with_eager_subdiagnostic(
self,
dcx: &DiagCtxt,
subdiagnostic: impl AddToDiagnostic
) -> Self
pub fn with_eager_subdiagnostic( self, dcx: &DiagCtxt, subdiagnostic: impl AddToDiagnostic ) -> Self
Methods from Deref<Target = Diagnostic>§
pub fn level(&self) -> Level
pub fn is_error(&self) -> bool
pub(crate) fn update_unstable_expectation_id( &mut self, unstable_to_stable: &FxIndexMap<LintExpectationId, LintExpectationId> )
sourcepub(crate) fn has_future_breakage(&self) -> bool
pub(crate) fn has_future_breakage(&self) -> bool
Indicates whether this diagnostic should show up in cargo’s future breakage report.
pub(crate) fn is_force_warn(&self) -> bool
sourcepub fn downgrade_to_delayed_bug(&mut self)
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.
sourcepub fn span_label(
&mut self,
span: Span,
label: impl Into<SubdiagnosticMessage>
) -> &mut Self
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.
sourcepub fn span_labels(
&mut self,
spans: impl IntoIterator<Item = Span>,
label: &str
) -> &mut Self
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.
pub fn replace_span_with(&mut self, after: Span, keep_label: bool) -> &mut Self
pub fn note_expected_found( &mut self, expected_label: &dyn Display, expected: DiagnosticStyledString, found_label: &dyn Display, found: DiagnosticStyledString ) -> &mut Self
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
pub fn note_trait_signature( &mut self, name: Symbol, signature: String ) -> &mut Self
sourcepub fn note(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
pub fn note(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
Add a note attached to this diagnostic.
fn highlighted_note<M: Into<SubdiagnosticMessage>>( &mut self, msg: Vec<(M, Style)> ) -> &mut Self
sourcepub fn note_once(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
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.
sourcepub fn span_note<S: Into<MultiSpan>>(
&mut self,
sp: S,
msg: impl Into<SubdiagnosticMessage>
) -> &mut Self
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.
sourcepub fn span_note_once<S: Into<MultiSpan>>(
&mut self,
sp: S,
msg: impl Into<SubdiagnosticMessage>
) -> &mut Self
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.
sourcepub fn warn(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
pub fn warn(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
Add a warning attached to this diagnostic.
sourcepub fn span_warn<S: Into<MultiSpan>>(
&mut self,
sp: S,
msg: impl Into<SubdiagnosticMessage>
) -> &mut Self
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.
sourcepub fn help(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
pub fn help(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
Add a help message attached to this diagnostic.
sourcepub fn help_once(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self
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.
sourcepub fn highlighted_help(&mut self, msg: Vec<(String, Style)>) -> &mut Self
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.
sourcepub fn span_help<S: Into<MultiSpan>>(
&mut self,
sp: S,
msg: impl Into<SubdiagnosticMessage>
) -> &mut Self
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.
sourcepub fn disable_suggestions(&mut self) -> &mut Self
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.
sourcefn push_suggestion(&mut self, suggestion: CodeSuggestion)
fn push_suggestion(&mut self, suggestion: CodeSuggestion)
Helper for pushing to self.suggestions
, if available (not disable).
sourcepub fn multipart_suggestion(
&mut self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> &mut Self
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.
sourcepub fn multipart_suggestion_verbose(
&mut self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> &mut Self
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.
sourcepub fn multipart_suggestion_with_style(
&mut self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability,
style: SuggestionStyle
) -> &mut Self
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
.
sourcepub fn tool_only_multipart_suggestion(
&mut self,
msg: impl Into<SubdiagnosticMessage>,
suggestion: Vec<(Span, String)>,
applicability: Applicability
) -> &mut Self
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.
sourcepub fn span_suggestion(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> &mut Self
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.
sourcepub fn span_suggestion_with_style(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability,
style: SuggestionStyle
) -> &mut Self
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
.
sourcepub fn span_suggestion_verbose(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> &mut Self
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.
sourcepub fn span_suggestions(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestions: impl IntoIterator<Item = String>,
applicability: Applicability
) -> &mut Self
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()
.
sourcepub fn span_suggestions_with_style(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestions: impl IntoIterator<Item = String>,
applicability: Applicability,
style: SuggestionStyle
) -> &mut Self
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
.
sourcepub fn multipart_suggestions(
&mut self,
msg: impl Into<SubdiagnosticMessage>,
suggestions: impl IntoIterator<Item = Vec<(Span, String)>>,
applicability: Applicability
) -> &mut Self
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()
.
sourcepub fn span_suggestion_short(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> &mut Self
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.
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.
sourcepub fn tool_only_span_suggestion(
&mut self,
sp: Span,
msg: impl Into<SubdiagnosticMessage>,
suggestion: impl ToString,
applicability: Applicability
) -> &mut Self
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.
sourcepub fn subdiagnostic(
&mut self,
subdiagnostic: impl AddToDiagnostic
) -> &mut Self
pub fn subdiagnostic( &mut self, subdiagnostic: impl AddToDiagnostic ) -> &mut Self
Add a subdiagnostic from a type that implements Subdiagnostic
(see
rustc_macros::Subdiagnostic).
sourcepub fn eager_subdiagnostic(
&mut self,
dcx: &DiagCtxt,
subdiagnostic: impl AddToDiagnostic
) -> &mut Self
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).
pub fn span<S: Into<MultiSpan>>(&mut self, sp: S) -> &mut Self
pub fn is_lint(&mut self, name: String, has_future_breakage: bool) -> &mut Self
pub fn code(&mut self, code: ErrCode) -> &mut Self
pub fn clear_code(&mut self) -> &mut Self
pub fn get_code(&self) -> Option<ErrCode>
pub fn primary_message( &mut self, msg: impl Into<DiagnosticMessage> ) -> &mut Self
pub fn args(&self) -> impl Iterator<Item = DiagnosticArg<'_>>
pub fn arg( &mut self, name: impl Into<Cow<'static, str>>, arg: impl IntoDiagnosticArg ) -> &mut Self
pub fn replace_args( &mut self, args: FxHashMap<DiagnosticArgName, DiagnosticArgValue> )
pub fn messages(&self) -> &[(DiagnosticMessage, Style)]
sourcefn subdiagnostic_message_to_diagnostic_message(
&self,
attr: impl Into<SubdiagnosticMessage>
) -> DiagnosticMessage
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).
sourcepub fn sub(
&mut self,
level: Level,
message: impl Into<SubdiagnosticMessage>,
span: MultiSpan
)
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
.
sourcefn sub_with_highlights<M: Into<SubdiagnosticMessage>>(
&mut self,
level: Level,
messages: Vec<(M, Style)>,
span: MultiSpan
)
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.
sourcefn keys(
&self
) -> (&Level, &[(DiagnosticMessage, Style)], &Option<ErrCode>, &MultiSpan, &[SubDiagnostic], &Result<Vec<CodeSuggestion>, SuggestionsDisabled>, Vec<(&DiagnosticArgName, &DiagnosticArgValue)>, &Option<IsLint>)
fn keys( &self ) -> (&Level, &[(DiagnosticMessage, Style)], &Option<ErrCode>, &MultiSpan, &[SubDiagnostic], &Result<Vec<CodeSuggestion>, SuggestionsDisabled>, Vec<(&DiagnosticArgName, &DiagnosticArgValue)>, &Option<IsLint>)
Fields used for Hash, and PartialEq trait
Trait Implementations§
source§impl<G> !Clone for DiagnosticBuilder<'_, G>
impl<G> !Clone for DiagnosticBuilder<'_, G>
source§impl<G: EmissionGuarantee> Debug for DiagnosticBuilder<'_, G>
impl<G: EmissionGuarantee> Debug for DiagnosticBuilder<'_, G>
source§impl<G: EmissionGuarantee> Deref for DiagnosticBuilder<'_, G>
impl<G: EmissionGuarantee> Deref for DiagnosticBuilder<'_, G>
§type Target = Diagnostic
type Target = Diagnostic
source§fn deref(&self) -> &Diagnostic
fn deref(&self) -> &Diagnostic
source§impl<G: EmissionGuarantee> DerefMut for DiagnosticBuilder<'_, G>
impl<G: EmissionGuarantee> DerefMut for DiagnosticBuilder<'_, G>
source§fn deref_mut(&mut self) -> &mut Diagnostic
fn deref_mut(&mut self) -> &mut Diagnostic
source§impl<G: EmissionGuarantee> Drop for DiagnosticBuilder<'_, G>
impl<G: EmissionGuarantee> Drop for DiagnosticBuilder<'_, G>
Destructor bomb: every DiagnosticBuilder
must be consumed (emitted,
cancelled, etc.) or we emit a bug.
Auto Trait Implementations§
impl<'a, G = ErrorGuaranteed> !RefUnwindSafe for DiagnosticBuilder<'a, G>
impl<'a, G = ErrorGuaranteed> !Send for DiagnosticBuilder<'a, G>
impl<'a, G = ErrorGuaranteed> !Sync for DiagnosticBuilder<'a, G>
impl<'a, G> Unpin for DiagnosticBuilder<'a, G>where
G: Unpin,
impl<'a, G = ErrorGuaranteed> !UnwindSafe for DiagnosticBuilder<'a, G>
Blanket Implementations§
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
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: 16 bytes