clippy_lints/src/try_err.rs

   1 use crate::utils::{match_qpath, paths, snippet, snippet_with_macro_callsite, span_lint_and_sugg};
   2 use if_chain::if_chain;
   3 use rustc::hir::*;
   4 use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintPass};
   5 use rustc::ty::Ty;
   6 use rustc::{declare_lint_pass, declare_tool_lint};
   7 use rustc_errors::Applicability;
   8
   9 declare_clippy_lint! {
  10     /// **What it does:** Checks for usages of `Err(x)?`.
  11     ///
  12     /// **Why is this bad?** The `?` operator is designed to allow calls that
  13     /// can fail to be easily chained. For example, `foo()?.bar()` or
  14     /// `foo(bar()?)`. Because `Err(x)?` can't be used that way (it will
  15     /// always return), it is more clear to write `return Err(x)`.
  16     ///
  17     /// **Known problems:** None.
  18     ///
  19     /// **Example:**
  20     /// ```rust
  21     /// fn foo(fail: bool) -> Result<i32, String> {
  22     ///     if fail {
  23     ///       Err("failed")?;
  24     ///     }
  25     ///     Ok(0)
  26     /// }
  27     /// ```
  28     /// Could be written:
  29     ///
  30     /// ```rust
  31     /// fn foo(fail: bool) -> Result<i32, String> {
  32     ///     if fail {
  33     ///       return Err("failed".into());
  34     ///     }
  35     ///     Ok(0)
  36     /// }
  37     /// ```
  38     pub TRY_ERR,
  39     style,
  40     "return errors explicitly rather than hiding them behind a `?`"
  41 }
  42
  43 declare_lint_pass!(TryErr => [TRY_ERR]);
  44
  45 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TryErr {
  46     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
  47         // Looks for a structure like this:
  48         // match ::std::ops::Try::into_result(Err(5)) {
  49         //     ::std::result::Result::Err(err) =>
  50         //         #[allow(unreachable_code)]
  51         //         return ::std::ops::Try::from_error(::std::convert::From::from(err)),
  52         //     ::std::result::Result::Ok(val) =>
  53         //         #[allow(unreachable_code)]
  54         //         val,
  55         // };
  56         if_chain! {
  57             if !in_external_macro(cx.tcx.sess, expr.span);
  58             if let ExprKind::Match(ref match_arg, _, MatchSource::TryDesugar) = expr.kind;
  59             if let ExprKind::Call(ref match_fun, ref try_args) = match_arg.kind;
  60             if let ExprKind::Path(ref match_fun_path) = match_fun.kind;
  61             if match_qpath(match_fun_path, &paths::TRY_INTO_RESULT);
  62             if let Some(ref try_arg) = try_args.get(0);
  63             if let ExprKind::Call(ref err_fun, ref err_args) = try_arg.kind;
  64             if let Some(ref err_arg) = err_args.get(0);
  65             if let ExprKind::Path(ref err_fun_path) = err_fun.kind;
  66             if match_qpath(err_fun_path, &paths::RESULT_ERR);
  67             if let Some(return_type) = find_err_return_type(cx, &expr.kind);
  68
  69             then {
  70                 let err_type = cx.tables.expr_ty(err_arg);
  71                 let origin_snippet = if err_arg.span.from_expansion() {
  72                     snippet_with_macro_callsite(cx, err_arg.span, "_")
  73                 } else {
  74                     snippet(cx, err_arg.span, "_")
  75                 };
  76                 let suggestion = if err_type == return_type {
  77                     format!("return Err({})", origin_snippet)
  78                 } else {
  79                     format!("return Err({}.into())", origin_snippet)
  80                 };
  81
  82                 span_lint_and_sugg(
  83                     cx,
  84                     TRY_ERR,
  85                     expr.span,
  86                     "returning an `Err(_)` with the `?` operator",
  87                     "try this",
  88                     suggestion,
  89                     Applicability::MachineApplicable
  90                 );
  91             }
  92         }
  93     }
  94 }
  95
  96 // In order to determine whether to suggest `.into()` or not, we need to find the error type the
  97 // function returns. To do that, we look for the From::from call (see tree above), and capture
  98 // its output type.
  99 fn find_err_return_type<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx ExprKind) -> Option<Ty<'tcx>> {
 100     if let ExprKind::Match(_, ref arms, MatchSource::TryDesugar) = expr {
 101         arms.iter().find_map(|ty| find_err_return_type_arm(cx, ty))
 102     } else {
 103         None
 104     }
 105 }
 106
 107 // Check for From::from in one of the match arms.
 108 fn find_err_return_type_arm<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, arm: &'tcx Arm) -> Option<Ty<'tcx>> {
 109     if_chain! {
 110         if let ExprKind::Ret(Some(ref err_ret)) = arm.body.kind;
 111         if let ExprKind::Call(ref from_error_path, ref from_error_args) = err_ret.kind;
 112         if let ExprKind::Path(ref from_error_fn) = from_error_path.kind;
 113         if match_qpath(from_error_fn, &paths::TRY_FROM_ERROR);
 114         if let Some(from_error_arg) = from_error_args.get(0);
 115         then {
 116             Some(cx.tables.expr_ty(from_error_arg))
 117         } else {
 118             None
 119         }
 120     }
 121 }