use rustc_span::Span;
declare_clippy_lint! {
- /// **What it does:** Checks for usage of `panic!`, `unimplemented!` or `unreachable!` in a function of type result/option.
+ /// **What it does:** Checks for usage of `panic!`, `unimplemented!`, `todo!` or `unreachable!` in a function of type result.
///
- /// **Why is this bad?** For some codebases, it is desirable for functions of type option/result to return an error instead of crashing. Hence unimplemented, panic and unreachable should be avoided.
+ /// **Why is this bad?** For some codebases, it is desirable for functions of type result to return an error instead of crashing. Hence unimplemented, panic and unreachable should be avoided.
///
/// **Known problems:** None.
///
/// **Example:**
///
/// ```rust
- /// fn option_with_panic() -> Option<bool>
+ /// fn result_with_panic() -> Result<bool, String>
/// {
/// panic!("error");
/// }
pub PANIC_IN_RESULT,
restriction,
- "functions of type `Result<..>` / `Option`<...> that contain `panic!()` or `unreachable()` or `unimplemented()` "
+ "functions of type `Result<..>` that contain `panic!()`, `todo!()` or `unreachable()` or `unimplemented()` "
}
declare_lint_pass!(PanicInResult => [PANIC_IN_RESULT]);
// first check if it's a method or function
if let hir::ImplItemKind::Fn(ref _signature, _) = impl_item.kind;
// checking if its return type is `result` or `option`
- if is_type_diagnostic_item(cx, return_ty(cx, impl_item.hir_id), sym!(result_type))
- || is_type_diagnostic_item(cx, return_ty(cx, impl_item.hir_id), sym!(option_type));
+ if is_type_diagnostic_item(cx, return_ty(cx, impl_item.hir_id), sym!(result_type));
then {
lint_impl_body(cx, impl_item.span, impl_item);
}
type Map = Map<'tcx>;
fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
- if is_expn_of(expr.span, "unimplemented").is_some() {
- self.result.push(expr.span);
- } else if is_expn_of(expr.span, "unreachable").is_some() {
- self.result.push(expr.span);
- } else if is_expn_of(expr.span, "panic").is_some() {
+ if is_expn_of(expr.span, "unimplemented").is_some()
+ || is_expn_of(expr.span, "unreachable").is_some()
+ || is_expn_of(expr.span, "panic").is_some()
+ || is_expn_of(expr.span, "todo").is_some()
+ {
self.result.push(expr.span);
}
-
// and check sub-expressions
intravisit::walk_expr(self, expr);
}
cx,
PANIC_IN_RESULT,
impl_span,
- "used unimplemented, unreachable or panic in a function that returns result or option",
+ "used unimplemented, unreachable, todo or panic in a function that returns result",
move |diag| {
diag.help(
- "unimplemented, unreachable or panic should not be used in a function that returns result or option" );
+ "unimplemented, unreachable, todo or panic should not be used in a function that returns result" );
diag.span_note(fpu.result, "will cause the application to crash.");
});
}
-error: used unimplemented, unreachable or panic in a function that returns result or option
+error: used unimplemented, unreachable, todo or panic in a function that returns result
--> $DIR/panic_in_result.rs:6:5
|
LL | / fn result_with_panic() -> Result<bool, String> // should emit lint
| |_____^
|
= note: `-D clippy::panic-in-result` implied by `-D warnings`
- = help: unimplemented, unreachable or panic should not be used in a function that returns result or option
+ = help: unimplemented, unreachable, todo or panic should not be used in a function that returns result
note: will cause the application to crash.
--> $DIR/panic_in_result.rs:8:9
|
| ^^^^^^^^^^^^^^^^
= note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
-error: used unimplemented, unreachable or panic in a function that returns result or option
+error: used unimplemented, unreachable, todo or panic in a function that returns result
--> $DIR/panic_in_result.rs:11:5
|
LL | / fn result_with_unimplemented() -> Result<bool, String> // should emit lint
LL | | }
| |_____^
|
- = help: unimplemented, unreachable or panic should not be used in a function that returns result or option
+ = help: unimplemented, unreachable, todo or panic should not be used in a function that returns result
note: will cause the application to crash.
--> $DIR/panic_in_result.rs:13:9
|
| ^^^^^^^^^^^^^^^^^
= note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
-error: used unimplemented, unreachable or panic in a function that returns result or option
+error: used unimplemented, unreachable, todo or panic in a function that returns result
--> $DIR/panic_in_result.rs:16:5
|
LL | / fn result_with_unreachable() -> Result<bool, String> // should emit lint
LL | | }
| |_____^
|
- = help: unimplemented, unreachable or panic should not be used in a function that returns result or option
+ = help: unimplemented, unreachable, todo or panic should not be used in a function that returns result
note: will cause the application to crash.
--> $DIR/panic_in_result.rs:18:9
|
| ^^^^^^^^^^^^^^^
= note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
-error: used unimplemented, unreachable or panic in a function that returns result or option
+error: used unimplemented, unreachable, todo or panic in a function that returns result
--> $DIR/panic_in_result.rs:21:5
|
-LL | / fn option_with_unreachable() -> Option<bool> // should emit lint
+LL | / fn result_with_todo() -> Result<bool, String> // should emit lint
LL | | {
-LL | | unreachable!();
+LL | | todo!("Finish this");
LL | | }
| |_____^
|
- = help: unimplemented, unreachable or panic should not be used in a function that returns result or option
+ = help: unimplemented, unreachable, todo or panic should not be used in a function that returns result
note: will cause the application to crash.
--> $DIR/panic_in_result.rs:23:9
|
-LL | unreachable!();
- | ^^^^^^^^^^^^^^^
- = note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
-
-error: used unimplemented, unreachable or panic in a function that returns result or option
- --> $DIR/panic_in_result.rs:26:5
- |
-LL | / fn option_with_unimplemented() -> Option<bool> // should emit lint
-LL | | {
-LL | | unimplemented!();
-LL | | }
- | |_____^
- |
- = help: unimplemented, unreachable or panic should not be used in a function that returns result or option
-note: will cause the application to crash.
- --> $DIR/panic_in_result.rs:28:9
- |
-LL | unimplemented!();
- | ^^^^^^^^^^^^^^^^^
- = note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
-
-error: used unimplemented, unreachable or panic in a function that returns result or option
- --> $DIR/panic_in_result.rs:31:5
- |
-LL | / fn option_with_panic() -> Option<bool> // should emit lint
-LL | | {
-LL | | panic!("error");
-LL | | }
- | |_____^
- |
- = help: unimplemented, unreachable or panic should not be used in a function that returns result or option
-note: will cause the application to crash.
- --> $DIR/panic_in_result.rs:33:9
- |
-LL | panic!("error");
- | ^^^^^^^^^^^^^^^^
+LL | todo!("Finish this");
+ | ^^^^^^^^^^^^^^^^^^^^^
= note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
-error: aborting due to 6 previous errors
+error: aborting due to 4 previous errors