clippy_lints/src/let_underscore.rs

   1 use clippy_utils::diagnostics::span_lint_and_help;
   2 use clippy_utils::ty::{is_must_use_ty, match_type};
   3 use clippy_utils::{is_must_use_func_call, paths};
   4 use if_chain::if_chain;
   5 use rustc_hir::{Local, PatKind};
   6 use rustc_lint::{LateContext, LateLintPass};
   7 use rustc_middle::lint::in_external_macro;
   8 use rustc_middle::ty::subst::GenericArgKind;
   9 use rustc_session::{declare_lint_pass, declare_tool_lint};
  10
  11 declare_clippy_lint! {
  12     /// **What it does:** Checks for `let _ = <expr>`
  13     /// where expr is #[must_use]
  14     ///
  15     /// **Why is this bad?** It's better to explicitly
  16     /// handle the value of a #[must_use] expr
  17     ///
  18     /// **Known problems:** None.
  19     ///
  20     /// **Example:**
  21     /// ```rust
  22     /// fn f() -> Result<u32, u32> {
  23     ///     Ok(0)
  24     /// }
  25     ///
  26     /// let _ = f();
  27     /// // is_ok() is marked #[must_use]
  28     /// let _ = f().is_ok();
  29     /// ```
  30     pub LET_UNDERSCORE_MUST_USE,
  31     restriction,
  32     "non-binding let on a `#[must_use]` expression"
  33 }
  34
  35 declare_clippy_lint! {
  36     /// **What it does:** Checks for `let _ = sync_lock`
  37     ///
  38     /// **Why is this bad?** This statement immediately drops the lock instead of
  39     /// extending its lifetime to the end of the scope, which is often not intended.
  40     /// To extend lock lifetime to the end of the scope, use an underscore-prefixed
  41     /// name instead (i.e. _lock). If you want to explicitly drop the lock,
  42     /// `std::mem::drop` conveys your intention better and is less error-prone.
  43     ///
  44     /// **Known problems:** None.
  45     ///
  46     /// **Example:**
  47     ///
  48     /// Bad:
  49     /// ```rust,ignore
  50     /// let _ = mutex.lock();
  51     /// ```
  52     ///
  53     /// Good:
  54     /// ```rust,ignore
  55     /// let _lock = mutex.lock();
  56     /// ```
  57     pub LET_UNDERSCORE_LOCK,
  58     correctness,
  59     "non-binding let on a synchronization lock"
  60 }
  61
  62 declare_clippy_lint! {
  63     /// **What it does:** Checks for `let _ = <expr>`
  64     /// where expr has a type that implements `Drop`
  65     ///
  66     /// **Why is this bad?** This statement immediately drops the initializer
  67     /// expression instead of extending its lifetime to the end of the scope, which
  68     /// is often not intended. To extend the expression's lifetime to the end of the
  69     /// scope, use an underscore-prefixed name instead (i.e. _var). If you want to
  70     /// explicitly drop the expression, `std::mem::drop` conveys your intention
  71     /// better and is less error-prone.
  72     ///
  73     /// **Known problems:** None.
  74     ///
  75     /// **Example:**
  76     ///
  77     /// Bad:
  78     /// ```rust,ignore
  79     /// struct Droppable;
  80     /// impl Drop for Droppable {
  81     ///     fn drop(&mut self) {}
  82     /// }
  83     /// {
  84     ///     let _ = Droppable;
  85     ///     //               ^ dropped here
  86     ///     /* more code */
  87     /// }
  88     /// ```
  89     ///
  90     /// Good:
  91     /// ```rust,ignore
  92     /// {
  93     ///     let _droppable = Droppable;
  94     ///     /* more code */
  95     ///     // dropped at end of scope
  96     /// }
  97     /// ```
  98     pub LET_UNDERSCORE_DROP,
  99     pedantic,
 100     "non-binding let on a type that implements `Drop`"
 101 }
 102
 103 declare_lint_pass!(LetUnderscore => [LET_UNDERSCORE_MUST_USE, LET_UNDERSCORE_LOCK, LET_UNDERSCORE_DROP]);
 104
 105 const SYNC_GUARD_PATHS: [&[&str]; 3] = [
 106     &paths::MUTEX_GUARD,
 107     &paths::RWLOCK_READ_GUARD,
 108     &paths::RWLOCK_WRITE_GUARD,
 109 ];
 110
 111 impl<'tcx> LateLintPass<'tcx> for LetUnderscore {
 112     fn check_local(&mut self, cx: &LateContext<'_>, local: &Local<'_>) {
 113         if in_external_macro(cx.tcx.sess, local.span) {
 114             return;
 115         }
 116
 117         if_chain! {
 118             if let PatKind::Wild = local.pat.kind;
 119             if let Some(ref init) = local.init;
 120             then {
 121                 let init_ty = cx.typeck_results().expr_ty(init);
 122                 let contains_sync_guard = init_ty.walk().any(|inner| match inner.unpack() {
 123                     GenericArgKind::Type(inner_ty) => {
 124                         SYNC_GUARD_PATHS.iter().any(|path| match_type(cx, inner_ty, path))
 125                     },
 126
 127                     GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
 128                 });
 129                 if contains_sync_guard {
 130                     span_lint_and_help(
 131                         cx,
 132                         LET_UNDERSCORE_LOCK,
 133                         local.span,
 134                         "non-binding let on a synchronization lock",
 135                         None,
 136                         "consider using an underscore-prefixed named \
 137                             binding or dropping explicitly with `std::mem::drop`"
 138                     )
 139                 } else if init_ty.needs_drop(cx.tcx, cx.param_env) {
 140                     span_lint_and_help(
 141                         cx,
 142                         LET_UNDERSCORE_DROP,
 143                         local.span,
 144                         "non-binding `let` on a type that implements `Drop`",
 145                         None,
 146                         "consider using an underscore-prefixed named \
 147                             binding or dropping explicitly with `std::mem::drop`"
 148                     )
 149                 } else if is_must_use_ty(cx, cx.typeck_results().expr_ty(init)) {
 150                     span_lint_and_help(
 151                         cx,
 152                         LET_UNDERSCORE_MUST_USE,
 153                         local.span,
 154                         "non-binding let on an expression with `#[must_use]` type",
 155                         None,
 156                         "consider explicitly using expression value"
 157                     )
 158                 } else if is_must_use_func_call(cx, init) {
 159                     span_lint_and_help(
 160                         cx,
 161                         LET_UNDERSCORE_MUST_USE,
 162                         local.span,
 163                         "non-binding let on a result of a `#[must_use]` function",
 164                         None,
 165                         "consider explicitly using function result"
 166                     )
 167                 }
 168             }
 169         }
 170     }
 171 }