1 use crate::utils::{differing_macro_contexts, in_macro, match_def_path, match_qpath, paths, span_lint_and_sugg};
2 use clippy_utils::source::{snippet, snippet_with_macro_callsite};
3 use clippy_utils::ty::is_type_diagnostic_item;
4 use if_chain::if_chain;
5 use rustc_errors::Applicability;
6 use rustc_hir::{Expr, ExprKind, LangItem, MatchSource, QPath};
7 use rustc_lint::{LateContext, LateLintPass};
8 use rustc_middle::lint::in_external_macro;
9 use rustc_middle::ty::{self, Ty};
10 use rustc_session::{declare_lint_pass, declare_tool_lint};
13 declare_clippy_lint! {
14 /// **What it does:** Checks for usages of `Err(x)?`.
16 /// **Why is this bad?** The `?` operator is designed to allow calls that
17 /// can fail to be easily chained. For example, `foo()?.bar()` or
18 /// `foo(bar()?)`. Because `Err(x)?` can't be used that way (it will
19 /// always return), it is more clear to write `return Err(x)`.
21 /// **Known problems:** None.
25 /// fn foo(fail: bool) -> Result<i32, String> {
35 /// fn foo(fail: bool) -> Result<i32, String> {
37 /// return Err("failed".into());
44 "return errors explicitly rather than hiding them behind a `?`"
47 declare_lint_pass!(TryErr => [TRY_ERR]);
49 impl<'tcx> LateLintPass<'tcx> for TryErr {
50 fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
51 // Looks for a structure like this:
52 // match ::std::ops::Try::into_result(Err(5)) {
53 // ::std::result::Result::Err(err) =>
54 // #[allow(unreachable_code)]
55 // return ::std::ops::Try::from_error(::std::convert::From::from(err)),
56 // ::std::result::Result::Ok(val) =>
57 // #[allow(unreachable_code)]
61 if !in_external_macro(cx.tcx.sess, expr.span);
62 if let ExprKind::Match(ref match_arg, _, MatchSource::TryDesugar) = expr.kind;
63 if let ExprKind::Call(ref match_fun, ref try_args) = match_arg.kind;
64 if let ExprKind::Path(ref match_fun_path) = match_fun.kind;
65 if matches!(match_fun_path, QPath::LangItem(LangItem::TryIntoResult, _));
66 if let Some(ref try_arg) = try_args.get(0);
67 if let ExprKind::Call(ref err_fun, ref err_args) = try_arg.kind;
68 if let Some(ref err_arg) = err_args.get(0);
69 if let ExprKind::Path(ref err_fun_path) = err_fun.kind;
70 if match_qpath(err_fun_path, &paths::RESULT_ERR);
71 if let Some(return_ty) = find_return_type(cx, &expr.kind);
77 if let Some(ty) = result_error_type(cx, return_ty) {
81 } else if let Some(ty) = poll_result_error_type(cx, return_ty) {
82 prefix = "Poll::Ready(Err(";
85 } else if let Some(ty) = poll_option_result_error_type(cx, return_ty) {
86 prefix = "Poll::Ready(Some(Err(";
93 let expr_err_ty = cx.typeck_results().expr_ty(err_arg);
94 let differing_contexts = differing_macro_contexts(expr.span, err_arg.span);
96 let origin_snippet = if in_macro(expr.span) && in_macro(err_arg.span) && differing_contexts {
97 snippet(cx, err_arg.span.ctxt().outer_expn_data().call_site, "_")
98 } else if err_arg.span.from_expansion() && !in_macro(expr.span) {
99 snippet_with_macro_callsite(cx, err_arg.span, "_")
101 snippet(cx, err_arg.span, "_")
103 let suggestion = if err_ty == expr_err_ty {
104 format!("return {}{}{}", prefix, origin_snippet, suffix)
106 format!("return {}{}.into(){}", prefix, origin_snippet, suffix)
113 "returning an `Err(_)` with the `?` operator",
116 Applicability::MachineApplicable
123 /// Finds function return type by examining return expressions in match arms.
124 fn find_return_type<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx ExprKind<'_>) -> Option<Ty<'tcx>> {
125 if let ExprKind::Match(_, ref arms, MatchSource::TryDesugar) = expr {
126 for arm in arms.iter() {
127 if let ExprKind::Ret(Some(ref ret)) = arm.body.kind {
128 return Some(cx.typeck_results().expr_ty(ret));
135 /// Extracts the error type from Result<T, E>.
136 fn result_error_type<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
138 if let ty::Adt(_, subst) = ty.kind();
139 if is_type_diagnostic_item(cx, ty, sym::result_type);
140 let err_ty = subst.type_at(1);
149 /// Extracts the error type from Poll<Result<T, E>>.
150 fn poll_result_error_type<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
152 if let ty::Adt(def, subst) = ty.kind();
153 if match_def_path(cx, def.did, &paths::POLL);
154 let ready_ty = subst.type_at(0);
156 if let ty::Adt(ready_def, ready_subst) = ready_ty.kind();
157 if cx.tcx.is_diagnostic_item(sym::result_type, ready_def.did);
158 let err_ty = ready_subst.type_at(1);
168 /// Extracts the error type from Poll<Option<Result<T, E>>>.
169 fn poll_option_result_error_type<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
171 if let ty::Adt(def, subst) = ty.kind();
172 if match_def_path(cx, def.did, &paths::POLL);
173 let ready_ty = subst.type_at(0);
175 if let ty::Adt(ready_def, ready_subst) = ready_ty.kind();
176 if cx.tcx.is_diagnostic_item(sym::option_type, ready_def.did);
177 let some_ty = ready_subst.type_at(0);
179 if let ty::Adt(some_def, some_subst) = some_ty.kind();
180 if cx.tcx.is_diagnostic_item(sym::result_type, some_def.did);
181 let err_ty = some_subst.type_at(1);