Skip to content

Commit

Permalink
Auto merge of rust-lang#11042 - y21:issue10459, r=Manishearth
Browse files Browse the repository at this point in the history
[`unused_async`]: don't lint if function is part of a trait

Fixes rust-lang#10459.

We shouldn't lint if the function is part of a trait, because the user won't be able to easily remove the `async`, as this will then not match with the function signature in the trait definition

changelog: [`unused_async`]: don't lint if function is part of a trait
  • Loading branch information
bors committed Jun 28, 2023
2 parents 36f4feb + b713cd5 commit 750c7a1
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 5 deletions.
3 changes: 2 additions & 1 deletion clippy_lints/src/unused_async.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
use clippy_utils::diagnostics::span_lint_and_then;
use clippy_utils::is_def_id_trait_method;
use rustc_hir::intravisit::{walk_body, walk_expr, walk_fn, FnKind, Visitor};
use rustc_hir::{Body, Expr, ExprKind, FnDecl, YieldSource};
use rustc_lint::{LateContext, LateLintPass};
Expand Down Expand Up @@ -91,7 +92,7 @@ impl<'tcx> LateLintPass<'tcx> for UnusedAsync {
span: Span,
def_id: LocalDefId,
) {
if !span.from_expansion() && fn_kind.asyncness().is_async() {
if !span.from_expansion() && fn_kind.asyncness().is_async() && !is_def_id_trait_method(cx, def_id) {
let mut visitor = AsyncFnVisitor {
cx,
found_await: false,
Expand Down
12 changes: 12 additions & 0 deletions clippy_utils/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,18 @@ pub fn is_trait_method(cx: &LateContext<'_>, expr: &Expr<'_>, diag_item: Symbol)
.map_or(false, |did| is_diag_trait_item(cx, did, diag_item))
}

/// Checks if the `def_id` belongs to a function that is part of a trait impl.
pub fn is_def_id_trait_method(cx: &LateContext<'_>, def_id: LocalDefId) -> bool {
if let Some(hir_id) = cx.tcx.opt_local_def_id_to_hir_id(def_id)
&& let Node::Item(item) = cx.tcx.hir().get_parent(hir_id)
&& let ItemKind::Impl(imp) = item.kind
{
imp.of_trait.is_some()
} else {
false
}
}

/// Checks if the given expression is a path referring an item on the trait
/// that is marked with the given diagnostic item.
///
Expand Down
14 changes: 14 additions & 0 deletions tests/ui/unused_async.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
#![warn(clippy::unused_async)]
#![feature(async_fn_in_trait)]
#![allow(incomplete_features)]

use std::future::Future;
use std::pin::Pin;
Expand All @@ -23,6 +25,18 @@ mod issue10800 {
}
}

mod issue10459 {
trait HasAsyncMethod {
async fn do_something() -> u32;
}

impl HasAsyncMethod for () {
async fn do_something() -> u32 {
1
}
}
}

async fn foo() -> i32 {
4
}
Expand Down
8 changes: 4 additions & 4 deletions tests/ui/unused_async.stderr
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
error: unused `async` for function with no await statements
--> $DIR/unused_async.rs:11:5
--> $DIR/unused_async.rs:13:5
|
LL | / async fn async_block_await() {
LL | | async {
Expand All @@ -10,14 +10,14 @@ LL | | }
|
= help: consider removing the `async` from this function
note: `await` used in an async block, which does not require the enclosing function to be `async`
--> $DIR/unused_async.rs:13:23
--> $DIR/unused_async.rs:15:23
|
LL | ready(()).await;
| ^^^^^
= note: `-D clippy::unused-async` implied by `-D warnings`

error: unused `async` for function with no await statements
--> $DIR/unused_async.rs:26:1
--> $DIR/unused_async.rs:40:1
|
LL | / async fn foo() -> i32 {
LL | | 4
Expand All @@ -27,7 +27,7 @@ LL | | }
= help: consider removing the `async` from this function

error: unused `async` for function with no await statements
--> $DIR/unused_async.rs:37:5
--> $DIR/unused_async.rs:51:5
|
LL | / async fn unused(&self) -> i32 {
LL | | 1
Expand Down

0 comments on commit 750c7a1

Please sign in to comment.