Skip to content

Commit 86cb711

Browse files
committed
Reduce capabilities of Diagnostic.
Currently many diagnostic modifier methods are available on both `Diagnostic` and `DiagnosticBuilder`. This commit removes most of them from `Diagnostic`. To minimize the diff size, it keeps them within `diagnostic.rs` but changes the surrounding `impl Diagnostic` block to `impl DiagnosticBuilder`. (I intend to move things around later, to give a more sensible code layout.) `Diagnostic` keeps a few methods that it still needs, like `sub`, `arg`, and `replace_args`. The `forward!` macro, which defined two additional methods per call (e.g. `note` and `with_note`), is replaced by the `with_fn!` macro, which defines one additional method per call (e.g. `with_note`). It's now also only used when necessary -- not all modifier methods currently need a `with_*` form. (New ones can be easily added as necessary.) All this also requires changing `trait AddToDiagnostic` so its methods take `DiagnosticBuilder` instead of `Diagnostic`, which leads to many mechanical changes. `SubdiagnosticMessageOp` gains a type parameter `G`. There are three subdiagnostics -- `DelayedAtWithoutNewline`, `DelayedAtWithNewline`, and `InvalidFlushedDelayedDiagnosticLevel` -- that are created within the diagnostics machinery and appended to external diagnostics. These are handled at the `Diagnostic` level, which means it's now hard to construct them via `derive(Diagnostic)`, so instead we construct them by hand. This has no effect on what they look like when printed. There are lots of new `allow` markers for `untranslatable_diagnostics` and `diagnostics_outside_of_impl`. This is because `#[rustc_lint_diagnostics]` annotations were present on the `Diagnostic` modifier methods, but missing from the `DiagnosticBuilder` modifier methods. They're now present.
1 parent a16dbd7 commit 86cb711

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

clippy_utils/src/sugg.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -683,7 +683,7 @@ fn indentation<T: LintContext>(cx: &T, span: Span) -> Option<String> {
683683
})
684684
}
685685

686-
/// Convenience extension trait for `Diagnostic`.
686+
/// Convenience extension trait for `DiagnosticBuilder`.
687687
pub trait DiagnosticExt<T: LintContext> {
688688
/// Suggests to add an attribute to an item.
689689
///
@@ -731,7 +731,7 @@ pub trait DiagnosticExt<T: LintContext> {
731731
fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str, applicability: Applicability);
732732
}
733733

734-
impl<T: LintContext> DiagnosticExt<T> for rustc_errors::Diagnostic {
734+
impl<T: LintContext> DiagnosticExt<T> for rustc_errors::DiagnosticBuilder<'_, ()> {
735735
fn suggest_item_with_attr<D: Display + ?Sized>(
736736
&mut self,
737737
cx: &T,

0 commit comments

Comments
 (0)