src/tools/clippy/clippy_lints/src/match_result_ok.rs

   1 use clippy_utils::diagnostics::span_lint_and_sugg;
   2 use clippy_utils::higher;
   3 use clippy_utils::method_chain_args;
   4 use clippy_utils::source::snippet_with_applicability;
   5 use clippy_utils::ty::is_type_diagnostic_item;
   6 use if_chain::if_chain;
   7 use rustc_errors::Applicability;
   8 use rustc_hir::{Expr, ExprKind, PatKind, QPath};
   9 use rustc_lint::{LateContext, LateLintPass};
  10 use rustc_session::{declare_lint_pass, declare_tool_lint};
  11 use rustc_span::sym;
  12
  13 declare_clippy_lint! {
  14     /// ### What it does
  15     /// Checks for unnecessary `ok()` in `while let`.
  16     ///
  17     /// ### Why is this bad?
  18     /// Calling `ok()` in `while let` is unnecessary, instead match
  19     /// on `Ok(pat)`
  20     ///
  21     /// ### Example
  22     /// ```ignore
  23     /// while let Some(value) = iter.next().ok() {
  24     ///     vec.push(value)
  25     /// }
  26     ///
  27     /// if let Some(value) = iter.next().ok() {
  28     ///     vec.push(value)
  29     /// }
  30     /// ```
  31     /// Use instead:
  32     /// ```ignore
  33     /// while let Ok(value) = iter.next() {
  34     ///     vec.push(value)
  35     /// }
  36     ///
  37     /// if let Ok(value) = iter.next() {
  38     ///        vec.push(value)
  39     /// }
  40     /// ```
  41     #[clippy::version = "1.57.0"]
  42     pub MATCH_RESULT_OK,
  43     style,
  44     "usage of `ok()` in `let Some(pat)` statements is unnecessary, match on `Ok(pat)` instead"
  45 }
  46
  47 declare_lint_pass!(MatchResultOk => [MATCH_RESULT_OK]);
  48
  49 impl<'tcx> LateLintPass<'tcx> for MatchResultOk {
  50     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
  51         let (let_pat, let_expr, ifwhile) =
  52             if let Some(higher::IfLet { let_pat, let_expr, .. }) = higher::IfLet::hir(cx, expr) {
  53                 (let_pat, let_expr, "if")
  54             } else if let Some(higher::WhileLet { let_pat, let_expr, .. }) = higher::WhileLet::hir(expr) {
  55                 (let_pat, let_expr, "while")
  56             } else {
  57                 return;
  58             };
  59
  60         if_chain! {
  61             if let ExprKind::MethodCall(ok_path, result_types_0, ..) = let_expr.kind; //check is expr.ok() has type Result<T,E>.ok(, _)
  62             if let PatKind::TupleStruct(QPath::Resolved(_, x), y, _)  = let_pat.kind; //get operation
  63             if method_chain_args(let_expr, &["ok"]).is_some(); //test to see if using ok() method use std::marker::Sized;
  64             if is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(result_types_0), sym::Result);
  65             if rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_path(x, false)) == "Some";
  66
  67             then {
  68
  69                 let mut applicability = Applicability::MachineApplicable;
  70                 let some_expr_string = snippet_with_applicability(cx, y[0].span, "", &mut applicability);
  71                 let trimmed_ok = snippet_with_applicability(cx, let_expr.span.until(ok_path.ident.span), "", &mut applicability);
  72                 let sugg = format!(
  73                     "{ifwhile} let Ok({some_expr_string}) = {}",
  74                     trimmed_ok.trim().trim_end_matches('.'),
  75                 );
  76                 span_lint_and_sugg(
  77                     cx,
  78                     MATCH_RESULT_OK,
  79                     expr.span.with_hi(let_expr.span.hi()),
  80                     "matching on `Some` with `ok()` is redundant",
  81                     &format!("consider matching on `Ok({some_expr_string})` and removing the call to `ok` instead"),
  82                     sugg,
  83                     applicability,
  84                 );
  85             }
  86         }
  87     }
  88 }