rust-clippy/clippy_lints/src/needless_borrowed_ref.rs

86 lines
2.9 KiB
Rust
Raw Normal View History

//! Checks for useless borrowed references.
2017-06-24 10:04:56 +00:00
//!
//! This lint is **warn** by default
use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
use crate::rustc::{declare_tool_lint, lint_array};
2018-07-19 08:00:54 +00:00
use if_chain::if_chain;
use crate::rustc::hir::{BindingAnnotation, MutImmutable, Pat, PatKind};
2018-05-30 08:15:50 +00:00
use crate::utils::{in_macro, snippet, span_lint_and_then};
2017-06-24 10:04:56 +00:00
/// **What it does:** Checks for useless borrowed references.
2017-06-24 10:04:56 +00:00
///
2017-09-03 21:15:15 +00:00
/// **Why is this bad?** It is mostly useless and make the code look more
/// complex than it
2017-06-29 14:07:43 +00:00
/// actually is.
2017-06-24 10:04:56 +00:00
///
/// **Known problems:** It seems that the `&ref` pattern is sometimes useful.
/// For instance in the following snippet:
/// ```rust
/// enum Animal {
/// Cat(u64),
/// Dog(u64),
/// }
///
/// fn foo(a: &Animal, b: &Animal) {
/// match (a, b) {
2017-09-03 21:15:15 +00:00
/// (&Animal::Cat(v), k) | (k, &Animal::Cat(v)) => (), // lifetime
/// mismatch error
/// (&Animal::Dog(ref c), &Animal::Dog(_)) => ()
/// }
/// }
/// ```
2017-09-03 21:15:15 +00:00
/// There is a lifetime mismatch error for `k` (indeed a and b have distinct
/// lifetime).
/// This can be fixed by using the `&ref` pattern.
/// However, the code can also be fixed by much cleaner ways
2017-06-24 10:04:56 +00:00
///
/// **Example:**
/// ```rust
/// let mut v = Vec::<String>::new();
/// let _ = v.iter_mut().filter(|&ref a| a.is_empty());
/// ```
2018-01-01 21:55:40 +00:00
/// This closure takes a reference on something that has been matched as a
2017-08-09 07:30:56 +00:00
/// reference and
2017-06-29 14:07:43 +00:00
/// de-referenced.
/// As such, it could just be |a| a.is_empty()
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
2017-06-24 10:04:56 +00:00
pub NEEDLESS_BORROWED_REFERENCE,
2018-03-28 13:24:26 +00:00
complexity,
2017-06-24 10:04:56 +00:00
"taking a needless borrowed reference"
}
#[derive(Copy, Clone)]
pub struct NeedlessBorrowedRef;
impl LintPass for NeedlessBorrowedRef {
fn get_lints(&self) -> LintArray {
lint_array!(NEEDLESS_BORROWED_REFERENCE)
}
}
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NeedlessBorrowedRef {
fn check_pat(&mut self, cx: &LateContext<'a, 'tcx>, pat: &'tcx Pat) {
if in_macro(pat.span) {
// OK, simple enough, lints doesn't check in macro.
return;
}
if_chain! {
// Only lint immutable refs, because `&mut ref T` may be useful.
if let PatKind::Ref(ref sub_pat, MutImmutable) = pat.node;
// Check sub_pat got a `ref` keyword (excluding `ref mut`).
if let PatKind::Binding(BindingAnnotation::Ref, _, spanned_name, ..) = sub_pat.node;
then {
span_lint_and_then(cx, NEEDLESS_BORROWED_REFERENCE, pat.span,
"this pattern takes a reference on something that is being de-referenced",
|db| {
let hint = snippet(cx, spanned_name.span, "..").into_owned();
db.span_suggestion(pat.span, "try removing the `&ref` part and just keep", hint);
});
}
}
2017-06-24 10:04:56 +00:00
}
}