src/tools/clippy/clippy_lints/src/inline_fn_without_body.rs

   1 //! checks for `#[inline]` on trait methods without bodies
   2
   3 use crate::utils::span_lint_and_then;
   4 use crate::utils::sugg::DiagnosticBuilderExt;
   5 use rustc_ast::ast::Attribute;
   6 use rustc_errors::Applicability;
   7 use rustc_hir::{TraitFn, TraitItem, TraitItemKind};
   8 use rustc_lint::{LateContext, LateLintPass};
   9 use rustc_session::{declare_lint_pass, declare_tool_lint};
  10 use rustc_span::{sym, Symbol};
  11
  12 declare_clippy_lint! {
  13     /// **What it does:** Checks for `#[inline]` on trait methods without bodies
  14     ///
  15     /// **Why is this bad?** Only implementations of trait methods may be inlined.
  16     /// The inline attribute is ignored for trait methods without bodies.
  17     ///
  18     /// **Known problems:** None.
  19     ///
  20     /// **Example:**
  21     /// ```rust
  22     /// trait Animal {
  23     ///     #[inline]
  24     ///     fn name(&self) -> &'static str;
  25     /// }
  26     /// ```
  27     pub INLINE_FN_WITHOUT_BODY,
  28     correctness,
  29     "use of `#[inline]` on trait methods without bodies"
  30 }
  31
  32 declare_lint_pass!(InlineFnWithoutBody => [INLINE_FN_WITHOUT_BODY]);
  33
  34 impl<'tcx> LateLintPass<'tcx> for InlineFnWithoutBody {
  35     fn check_trait_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx TraitItem<'_>) {
  36         if let TraitItemKind::Fn(_, TraitFn::Required(_)) = item.kind {
  37             check_attrs(cx, item.ident.name, &item.attrs);
  38         }
  39     }
  40 }
  41
  42 fn check_attrs(cx: &LateContext<'_>, name: Symbol, attrs: &[Attribute]) {
  43     for attr in attrs {
  44         if !attr.has_name(sym::inline) {
  45             continue;
  46         }
  47
  48         span_lint_and_then(
  49             cx,
  50             INLINE_FN_WITHOUT_BODY,
  51             attr.span,
  52             &format!("use of `#[inline]` on trait method `{}` which has no body", name),
  53             |diag| {
  54                 diag.suggest_remove_item(cx, attr.span, "remove", Applicability::MachineApplicable);
  55             },
  56         );
  57     }
  58 }