rust/clippy_lints/src/if_let_some_result.rs

77 lines
3.0 KiB
Rust
Raw Normal View History

use clippy_utils::diagnostics::span_lint_and_sugg;
2021-08-08 09:49:13 -05:00
use clippy_utils::higher;
use clippy_utils::method_chain_args;
use clippy_utils::source::snippet_with_applicability;
use clippy_utils::ty::is_type_diagnostic_item;
2018-11-27 14:14:15 -06:00
use if_chain::if_chain;
2020-01-09 17:34:13 -06:00
use rustc_errors::Applicability;
2021-08-08 09:49:13 -05:00
use rustc_hir::{Expr, ExprKind, PatKind, QPath};
2020-01-12 00:08:41 -06:00
use rustc_lint::{LateContext, LateLintPass};
2020-01-11 05:37:08 -06:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
use rustc_span::sym;
2016-10-02 15:48:52 -05:00
2018-03-28 08:24:26 -05:00
declare_clippy_lint! {
/// ### What it does
///* Checks for unnecessary `ok()` in if let.
///
/// ### Why is this bad?
/// Calling `ok()` in if let is unnecessary, instead match
/// on `Ok(pat)`
///
/// ### Example
2019-03-05 16:23:50 -06:00
/// ```ignore
/// for i in iter {
/// if let Some(value) = i.parse().ok() {
/// vec.push(value)
/// }
/// }
/// ```
/// Could be written:
///
2019-03-05 16:23:50 -06:00
/// ```ignore
/// for i in iter {
/// if let Ok(value) = i.parse() {
/// vec.push(value)
/// }
/// }
/// ```
2016-10-02 15:48:52 -05:00
pub IF_LET_SOME_RESULT,
2018-03-28 08:24:26 -05:00
style,
2016-10-02 16:15:24 -05:00
"usage of `ok()` in `if let Some(pat)` statements is unnecessary, match on `Ok(pat)` instead"
2016-10-02 15:48:52 -05:00
}
2019-04-08 15:43:55 -05:00
declare_lint_pass!(OkIfLet => [IF_LET_SOME_RESULT]);
2016-10-02 15:48:52 -05:00
impl<'tcx> LateLintPass<'tcx> for OkIfLet {
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
if_chain! { //begin checking variables
2021-08-19 13:31:25 -05:00
if let Some(higher::IfLet { let_pat, let_expr, .. }) = higher::IfLet::hir(cx, expr);
if let ExprKind::MethodCall(_, ok_span, [ref result_types_0, ..], _) = let_expr.kind; //check is expr.ok() has type Result<T,E>.ok(, _)
if let PatKind::TupleStruct(QPath::Resolved(_, x), y, _) = let_pat.kind; //get operation
2021-08-08 09:49:13 -05:00
if method_chain_args(let_expr, &["ok"]).is_some(); //test to see if using ok() methoduse std::marker::Sized;
if is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(result_types_0), sym::result_type);
if rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_path(x, false)) == "Some";
2017-11-04 14:55:56 -05:00
then {
2020-01-09 17:34:13 -06:00
let mut applicability = Applicability::MachineApplicable;
let some_expr_string = snippet_with_applicability(cx, y[0].span, "", &mut applicability);
2021-08-08 09:49:13 -05:00
let trimmed_ok = snippet_with_applicability(cx, let_expr.span.until(ok_span), "", &mut applicability);
2020-01-10 13:34:01 -06:00
let sugg = format!(
"if let Ok({}) = {}",
2020-01-09 17:34:13 -06:00
some_expr_string,
2020-01-18 19:00:34 -06:00
trimmed_ok.trim().trim_end_matches('.'),
2020-01-09 17:34:13 -06:00
);
2020-01-19 06:14:47 -06:00
span_lint_and_sugg(
cx,
IF_LET_SOME_RESULT,
2021-08-08 09:49:13 -05:00
expr.span.with_hi(let_expr.span.hi()),
"matching on `Some` with `ok()` is redundant",
&format!("consider matching on `Ok({})` and removing the call to `ok` instead", some_expr_string),
2020-01-19 06:14:47 -06:00
sugg,
applicability,
);
2016-10-02 15:48:52 -05:00
}
}
2016-10-02 15:48:52 -05:00
}
}