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