clippy_lints/src/needless_borrowed_ref.rs

   1 //! Checks for useless borrowed references.
   2 //!
   3 //! This lint is **warn** by default
   4
   5 use rustc::lint::*;
   6 use rustc::{declare_lint, lint_array};
   7 use rustc::hir::{BindingAnnotation, MutImmutable, Pat, PatKind};
   8 use crate::utils::{in_macro, snippet, span_lint_and_then};
   9
  10 /// **What it does:** Checks for useless borrowed references.
  11 ///
  12 /// **Why is this bad?** It is mostly useless and make the code look more
  13 /// complex than it
  14 /// actually is.
  15 ///
  16 /// **Known problems:** It seems that the `&ref` pattern is sometimes useful.
  17 /// For instance in the following snippet:
  18 /// ```rust
  19 /// enum Animal {
  20 ///     Cat(u64),
  21 ///     Dog(u64),
  22 /// }
  23 ///
  24 /// fn foo(a: &Animal, b: &Animal) {
  25 ///     match (a, b) {
  26 /// (&Animal::Cat(v), k) | (k, &Animal::Cat(v)) => (), // lifetime
  27 /// mismatch error
  28 ///         (&Animal::Dog(ref c), &Animal::Dog(_)) => ()
  29 ///     }
  30 /// }
  31 /// ```
  32 /// There is a lifetime mismatch error for `k` (indeed a and b have distinct
  33 /// lifetime).
  34 /// This can be fixed by using the `&ref` pattern.
  35 /// However, the code can also be fixed by much cleaner ways
  36 ///
  37 /// **Example:**
  38 /// ```rust
  39 ///     let mut v = Vec::<String>::new();
  40 ///     let _ = v.iter_mut().filter(|&ref a| a.is_empty());
  41 /// ```
  42 /// This closure takes a reference on something that has been matched as a
  43 /// reference and
  44 /// de-referenced.
  45 /// As such, it could just be |a| a.is_empty()
  46 declare_clippy_lint! {
  47     pub NEEDLESS_BORROWED_REFERENCE,
  48     complexity,
  49     "taking a needless borrowed reference"
  50 }
  51
  52 #[derive(Copy, Clone)]
  53 pub struct NeedlessBorrowedRef;
  54
  55 impl LintPass for NeedlessBorrowedRef {
  56     fn get_lints(&self) -> LintArray {
  57         lint_array!(NEEDLESS_BORROWED_REFERENCE)
  58     }
  59 }
  60
  61 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NeedlessBorrowedRef {
  62     fn check_pat(&mut self, cx: &LateContext<'a, 'tcx>, pat: &'tcx Pat) {
  63         if in_macro(pat.span) {
  64             // OK, simple enough, lints doesn't check in macro.
  65             return;
  66         }
  67
  68         if_chain! {
  69             // Only lint immutable refs, because `&mut ref T` may be useful.
  70             if let PatKind::Ref(ref sub_pat, MutImmutable) = pat.node;
  71
  72             // Check sub_pat got a `ref` keyword (excluding `ref mut`).
  73             if let PatKind::Binding(BindingAnnotation::Ref, _, spanned_name, ..) = sub_pat.node;
  74             then {
  75                 span_lint_and_then(cx, NEEDLESS_BORROWED_REFERENCE, pat.span,
  76                                    "this pattern takes a reference on something that is being de-referenced",
  77                                    |db| {
  78                                        let hint = snippet(cx, spanned_name.span, "..").into_owned();
  79                                        db.span_suggestion(pat.span, "try removing the `&ref` part and just keep", hint);
  80                                    });
  81             }
  82         }
  83     }
  84 }