Rollup merge of #100633 - estebank:must_use_async_fn_return, r=tmandry

Consider `#[must_use]` annotation on `async fn` as also affecting the `Future::Output`

No longer lint against `#[must_use] async fn foo()`.

When encountering a statement that awaits on a `Future`, check if the
`Future`'s parent item is annotated with `#[must_use]` and emit a lint
if so. This effectively makes `must_use` an annotation on the
`Future::Output` instead of only the `Future` itself.

Fix #78149.
This commit is contained in:
Dylan DPC 2022-11-11 20:51:38 +05:30 committed by GitHub
commit 978e7abece
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
28 changed files with 155 additions and 101 deletions

View File

@ -9,7 +9,7 @@ use rustc_hir::def::{DefKind, Res};
use rustc_hir::def_id::DefId;
use rustc_infer::traits::util::elaborate_predicates_with_span;
use rustc_middle::ty::adjustment;
use rustc_middle::ty::{self, Ty};
use rustc_middle::ty::{self, DefIdTree, Ty};
use rustc_span::symbol::Symbol;
use rustc_span::symbol::{kw, sym};
use rustc_span::{BytePos, Span};
@ -87,17 +87,33 @@ declare_lint_pass!(UnusedResults => [UNUSED_MUST_USE, UNUSED_RESULTS]);
impl<'tcx> LateLintPass<'tcx> for UnusedResults {
fn check_stmt(&mut self, cx: &LateContext<'_>, s: &hir::Stmt<'_>) {
let expr = match s.kind {
hir::StmtKind::Semi(ref expr) => &**expr,
_ => return,
};
let hir::StmtKind::Semi(expr) = s.kind else { return; };
if let hir::ExprKind::Ret(..) = expr.kind {
return;
}
if let hir::ExprKind::Match(await_expr, _arms, hir::MatchSource::AwaitDesugar) = expr.kind
&& let ty = cx.typeck_results().expr_ty(&await_expr)
&& let ty::Opaque(future_def_id, _) = ty.kind()
&& cx.tcx.ty_is_opaque_future(ty)
// FIXME: This also includes non-async fns that return `impl Future`.
&& let async_fn_def_id = cx.tcx.parent(*future_def_id)
&& check_must_use_def(
cx,
async_fn_def_id,
expr.span,
"output of future returned by ",
"",
)
{
// We have a bare `foo().await;` on an opaque type from an async function that was
// annotated with `#[must_use]`.
return;
}
let ty = cx.typeck_results().expr_ty(&expr);
let type_permits_lack_of_use = check_must_use_ty(cx, ty, &expr, s.span, "", "", 1);
let type_permits_lack_of_use = check_must_use_ty(cx, ty, &expr, expr.span, "", "", 1);
let mut fn_warned = false;
let mut op_warned = false;
@ -119,7 +135,7 @@ impl<'tcx> LateLintPass<'tcx> for UnusedResults {
_ => None,
};
if let Some(def_id) = maybe_def_id {
fn_warned = check_must_use_def(cx, def_id, s.span, "return value of ", "");
fn_warned = check_must_use_def(cx, def_id, expr.span, "return value of ", "");
} else if type_permits_lack_of_use {
// We don't warn about unused unit or uninhabited types.
// (See https://github.com/rust-lang/rust/issues/43806 for details.)

View File

@ -139,7 +139,7 @@ impl CheckAttrVisitor<'_> {
sym::collapse_debuginfo => self.check_collapse_debuginfo(attr, span, target),
sym::const_trait => self.check_const_trait(attr, span, target),
sym::must_not_suspend => self.check_must_not_suspend(&attr, span, target),
sym::must_use => self.check_must_use(hir_id, &attr, span, target),
sym::must_use => self.check_must_use(hir_id, &attr, target),
sym::rustc_pass_by_value => self.check_pass_by_value(&attr, span, target),
sym::rustc_allow_incoherent_impl => {
self.check_allow_incoherent_impl(&attr, span, target)
@ -1163,17 +1163,7 @@ impl CheckAttrVisitor<'_> {
}
/// Warns against some misuses of `#[must_use]`
fn check_must_use(&self, hir_id: HirId, attr: &Attribute, span: Span, target: Target) -> bool {
let node = self.tcx.hir().get(hir_id);
if let Some(kind) = node.fn_kind() && let rustc_hir::IsAsync::Async = kind.asyncness() {
self.tcx.emit_spanned_lint(
UNUSED_ATTRIBUTES,
hir_id,
attr.span,
errors::MustUseAsync { span }
);
}
fn check_must_use(&self, hir_id: HirId, attr: &Attribute, target: Target) -> bool {
if !matches!(
target,
Target::Fn

View File

@ -16,7 +16,7 @@ LL | / || match out_ref {
LL | | Variant::A => (),
LL | | Variant::B => (),
LL | | };
| |______^
| |_____^
|
= note: closures are lazy and do nothing unless called
= note: `#[warn(unused_must_use)]` on by default
@ -28,7 +28,7 @@ LL | / || match here.field {
LL | | Variant::A => (),
LL | | Variant::B => (),
LL | | };
| |______^
| |_____^
|
= note: closures are lazy and do nothing unless called

View File

@ -28,7 +28,7 @@ warning: unused `MustUseDeprecated` that must be used
--> $DIR/cfg-attr-multi-true.rs:19:5
|
LL | MustUseDeprecated::new();
| ^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^
|
note: the lint level is defined here
--> $DIR/cfg-attr-multi-true.rs:7:9

View File

@ -4,7 +4,7 @@ warning: unused generator that must be used
LL | / move || {
LL | | A.test(yield);
LL | | };
| |______^
| |_____^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default
@ -16,7 +16,7 @@ LL | / static move || {
LL | | yield *y.borrow();
LL | | return "Done";
LL | | };
| |______^
| |_____^
|
= note: generators are lazy and do nothing unless resumed

View File

@ -7,7 +7,7 @@ LL | | loop {
LL | | yield
LL | | }
LL | | };
| |______^
| |_____^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default

View File

@ -8,7 +8,7 @@ LL | | match Enum::A(String::new()) {
... |
LL | | }
LL | | };
| |______^
| |_____^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default

View File

@ -8,7 +8,7 @@ LL | | yield;
... |
LL | | *bar = 2;
LL | | };
| |______^
| |_____^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default

View File

@ -8,7 +8,7 @@ LL | | // and it should also find out that `a` is not live.
... |
LL | | let _ = &a;
LL | | };
| |__________^
| |_________^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default

View File

@ -5,7 +5,7 @@ LL | / || {
LL | | let b = true;
LL | | foo(yield, &b);
LL | | };
| |______^
| |_____^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default

View File

@ -8,7 +8,7 @@ LL | | let _t = box (&x, yield 0, &y);
... |
LL | | }
LL | | };
| |______^
| |_____^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default

View File

@ -8,7 +8,7 @@ LL | | // See https://github.com/rust-lang/rust/issues/52792
... |
LL | | }
LL | | };
| |______^
| |_____^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default

View File

@ -5,7 +5,7 @@ LL | / || {
LL | | yield a;
LL | | yield b;
LL | | };
| |______^
| |_____^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default

View File

@ -2,7 +2,7 @@ warning: unused closure that must be used
--> $DIR/issue-1460.rs:6:5
|
LL | {|i: u32| if 1 == i { }};
| ^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: closures are lazy and do nothing unless called
= note: `#[warn(unused_must_use)]` on by default

View File

@ -2,7 +2,7 @@ warning: unused closure that must be used
--> $DIR/issue-16256.rs:6:5
|
LL | |c: u8| buf.push(c);
| ^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^
|
= note: closures are lazy and do nothing unless called
= note: `#[warn(unused_must_use)]` on by default

View File

@ -2,7 +2,7 @@ warning: unused return value of `need_to_use_this_value` that must be used
--> $DIR/fn_must_use.rs:55:5
|
LL | need_to_use_this_value();
| ^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: it's important
note: the lint level is defined here
@ -15,13 +15,13 @@ warning: unused return value of `MyStruct::need_to_use_this_method_value` that m
--> $DIR/fn_must_use.rs:60:5
|
LL | m.need_to_use_this_method_value();
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
warning: unused return value of `EvenNature::is_even` that must be used
--> $DIR/fn_must_use.rs:61:5
|
LL | m.is_even(); // trait method!
| ^^^^^^^^^^^^
| ^^^^^^^^^^^
|
= note: no side effects
@ -29,19 +29,19 @@ warning: unused return value of `MyStruct::need_to_use_this_associated_function_
--> $DIR/fn_must_use.rs:64:5
|
LL | MyStruct::need_to_use_this_associated_function_value();
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
warning: unused return value of `std::cmp::PartialEq::eq` that must be used
--> $DIR/fn_must_use.rs:70:5
|
LL | 2.eq(&3);
| ^^^^^^^^^
| ^^^^^^^^
warning: unused return value of `std::cmp::PartialEq::eq` that must be used
--> $DIR/fn_must_use.rs:71:5
|
LL | m.eq(&n);
| ^^^^^^^^^
| ^^^^^^^^
warning: unused comparison that must be used
--> $DIR/fn_must_use.rs:74:5

View File

@ -2,7 +2,7 @@ warning: unused return value of `Box::<T>::from_raw` that must be used
--> $DIR/must-use-box-from-raw.rs:8:5
|
LL | Box::from_raw(ptr);
| ^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^
|
= note: call `drop(from_raw(ptr))` if you intend to drop the `Box`
note: the lint level is defined here

View File

@ -2,7 +2,7 @@ error: unused array of `S` that must be used
--> $DIR/must_use-array.rs:39:5
|
LL | singleton();
| ^^^^^^^^^^^^
| ^^^^^^^^^^^
|
note: the lint level is defined here
--> $DIR/must_use-array.rs:1:9
@ -14,7 +14,7 @@ error: unused array of `S` that must be used
--> $DIR/must_use-array.rs:40:5
|
LL | many();
| ^^^^^^^
| ^^^^^^
error: unused array of `S` in tuple element 0 that must be used
--> $DIR/must_use-array.rs:41:6
@ -26,7 +26,7 @@ error: unused array of implementers of `T` that must be used
--> $DIR/must_use-array.rs:42:5
|
LL | array_of_impl_trait();
| ^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^
error: unused array of boxed `T` trait objects in tuple element 1 that must be used
--> $DIR/must_use-array.rs:43:5
@ -38,7 +38,7 @@ error: unused array of arrays of arrays of `S` that must be used
--> $DIR/must_use-array.rs:45:5
|
LL | array_of_arrays_of_arrays();
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^
error: aborting due to 6 previous errors

View File

@ -2,7 +2,7 @@ error: unused implementer of `Iterator` that must be used
--> $DIR/must_use-in-stdlib-traits.rs:42:4
|
LL | iterator();
| ^^^^^^^^^^^
| ^^^^^^^^^^
|
= note: iterators are lazy and do nothing unless consumed
note: the lint level is defined here
@ -15,7 +15,7 @@ error: unused implementer of `Future` that must be used
--> $DIR/must_use-in-stdlib-traits.rs:43:4
|
LL | future();
| ^^^^^^^^^
| ^^^^^^^^
|
= note: futures do nothing unless you `.await` or poll them
@ -23,7 +23,7 @@ error: unused implementer of `FnOnce` that must be used
--> $DIR/must_use-in-stdlib-traits.rs:44:4
|
LL | square_fn_once();
| ^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^
|
= note: closures are lazy and do nothing unless called
@ -31,7 +31,7 @@ error: unused implementer of `FnMut` that must be used
--> $DIR/must_use-in-stdlib-traits.rs:45:4
|
LL | square_fn_mut();
| ^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^
|
= note: closures are lazy and do nothing unless called
@ -39,7 +39,7 @@ error: unused implementer of `Fn` that must be used
--> $DIR/must_use-in-stdlib-traits.rs:46:4
|
LL | square_fn();
| ^^^^^^^^^^^^
| ^^^^^^^^^^^
|
= note: closures are lazy and do nothing unless called

View File

@ -2,7 +2,7 @@ error: unused implementer of `Critical` that must be used
--> $DIR/must_use-trait.rs:33:5
|
LL | get_critical();
| ^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^
|
note: the lint level is defined here
--> $DIR/must_use-trait.rs:1:9
@ -14,13 +14,13 @@ error: unused boxed `Critical` trait object that must be used
--> $DIR/must_use-trait.rs:34:5
|
LL | get_boxed_critical();
| ^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^
error: unused boxed boxed `Critical` trait object that must be used
--> $DIR/must_use-trait.rs:35:5
|
LL | get_nested_boxed_critical();
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^
error: unused boxed `Critical` trait object in tuple element 1 that must be used
--> $DIR/must_use-trait.rs:37:5

View File

@ -2,7 +2,7 @@ error: unused return value of `foo` that must be used
--> $DIR/must_use-unit.rs:13:5
|
LL | foo();
| ^^^^^^
| ^^^^^
|
note: the lint level is defined here
--> $DIR/must_use-unit.rs:2:9
@ -14,7 +14,7 @@ error: unused return value of `bar` that must be used
--> $DIR/must_use-unit.rs:15:5
|
LL | bar();
| ^^^^^^
| ^^^^^
error: aborting due to 2 previous errors

View File

@ -1,24 +1,43 @@
// edition:2018
// run-pass
#![allow(dead_code)]
#![deny(unused_must_use)]
#[must_use]
//~^ WARNING `must_use`
async fn test() -> i32 {
async fn foo() -> i32 {
1
}
#[must_use]
fn bar() -> impl std::future::Future<Output=i32> {
async {
42
}
}
async fn baz() -> i32 {
0
}
struct Wowee {}
impl Wowee {
#[must_use]
//~^ WARNING `must_use`
async fn test_method() -> i32 {
1
}
}
async fn test() {
foo(); //~ ERROR unused return value of `foo` that must be used
//~^ ERROR unused implementer of `Future` that must be used
foo().await; //~ ERROR unused output of future returned by `foo` that must be used
bar(); //~ ERROR unused return value of `bar` that must be used
//~^ ERROR unused implementer of `Future` that must be used
bar().await; //~ ERROR unused output of future returned by `bar` that must be used
baz(); //~ ERROR unused implementer of `Future` that must be used
baz().await; // ok
}
/* FIXME(guswynn) update this test when async-fn-in-traits works
trait Doer {
#[must_use]

View File

@ -1,26 +1,55 @@
warning: `must_use` attribute on `async` functions applies to the anonymous `Future` returned by the function, not the value within
--> $DIR/unused-async.rs:5:1
error: unused implementer of `Future` that must be used
--> $DIR/unused-async.rs:31:5
|
LL | #[must_use]
| ^^^^^^^^^^^
LL |
LL | / async fn test() -> i32 {
LL | | 1
LL | | }
| |_- this attribute does nothing, the `Future`s returned by async functions are already `must_use`
LL | foo();
| ^^^^^
|
= note: `#[warn(unused_attributes)]` on by default
warning: `must_use` attribute on `async` functions applies to the anonymous `Future` returned by the function, not the value within
--> $DIR/unused-async.rs:15:5
= note: futures do nothing unless you `.await` or poll them
note: the lint level is defined here
--> $DIR/unused-async.rs:2:9
|
LL | #[must_use]
| ^^^^^^^^^^^
LL |
LL | / async fn test_method() -> i32 {
LL | | 1
LL | | }
| |_____- this attribute does nothing, the `Future`s returned by async functions are already `must_use`
LL | #![deny(unused_must_use)]
| ^^^^^^^^^^^^^^^
warning: 2 warnings emitted
error: unused return value of `foo` that must be used
--> $DIR/unused-async.rs:31:5
|
LL | foo();
| ^^^^^
error: unused output of future returned by `foo` that must be used
--> $DIR/unused-async.rs:33:5
|
LL | foo().await;
| ^^^^^^^^^^^
error: unused implementer of `Future` that must be used
--> $DIR/unused-async.rs:34:5
|
LL | bar();
| ^^^^^
|
= note: futures do nothing unless you `.await` or poll them
error: unused return value of `bar` that must be used
--> $DIR/unused-async.rs:34:5
|
LL | bar();
| ^^^^^
error: unused output of future returned by `bar` that must be used
--> $DIR/unused-async.rs:36:5
|
LL | bar().await;
| ^^^^^^^^^^^
error: unused implementer of `Future` that must be used
--> $DIR/unused-async.rs:37:5
|
LL | baz();
| ^^^^^
|
= note: futures do nothing unless you `.await` or poll them
error: aborting due to 7 previous errors

View File

@ -4,7 +4,7 @@ error: unused closure that must be used
LL | / || {
LL | | println!("Hello!");
LL | | };
| |______^
| |_____^
|
= note: closures are lazy and do nothing unless called
note: the lint level is defined here
@ -17,7 +17,7 @@ error: unused implementer of `Future` that must be used
--> $DIR/unused-closure.rs:13:5
|
LL | async {};
| ^^^^^^^^^
| ^^^^^^^^
|
= note: futures do nothing unless you `.await` or poll them
@ -25,7 +25,7 @@ error: unused closure that must be used
--> $DIR/unused-closure.rs:14:5
|
LL | || async {};
| ^^^^^^^^^^^^
| ^^^^^^^^^^^
|
= note: closures are lazy and do nothing unless called
@ -33,7 +33,7 @@ error: unused closure that must be used
--> $DIR/unused-closure.rs:15:5
|
LL | async || {};
| ^^^^^^^^^^^^
| ^^^^^^^^^^^
|
= note: closures are lazy and do nothing unless called
@ -41,7 +41,7 @@ error: unused array of boxed arrays of closures that must be used
--> $DIR/unused-closure.rs:18:5
|
LL | [Box::new([|| {}; 10]); 1];
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: closures are lazy and do nothing unless called
@ -49,7 +49,7 @@ error: unused closure that must be used
--> $DIR/unused-closure.rs:20:5
|
LL | vec![|| "a"].pop().unwrap();
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: closures are lazy and do nothing unless called
@ -57,7 +57,7 @@ error: unused closure that must be used
--> $DIR/unused-closure.rs:23:9
|
LL | || true;
| ^^^^^^^^
| ^^^^^^^
|
= note: closures are lazy and do nothing unless called

View File

@ -2,7 +2,7 @@ error: unused `MustUse` that must be used
--> $DIR/unused-result.rs:21:5
|
LL | foo::<MustUse>();
| ^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^
|
note: the lint level is defined here
--> $DIR/unused-result.rs:2:25
@ -14,7 +14,7 @@ error: unused `MustUseMsg` that must be used
--> $DIR/unused-result.rs:22:5
|
LL | foo::<MustUseMsg>();
| ^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^
|
= note: some message
@ -34,13 +34,13 @@ error: unused `MustUse` that must be used
--> $DIR/unused-result.rs:35:5
|
LL | foo::<MustUse>();
| ^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^
error: unused `MustUseMsg` that must be used
--> $DIR/unused-result.rs:36:5
|
LL | foo::<MustUseMsg>();
| ^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^
|
= note: some message

View File

@ -2,7 +2,7 @@ error: unused implementer of `Iterator` that must be used
--> $DIR/unused-supertrait.rs:9:5
|
LL | it();
| ^^^^^
| ^^^^
|
= note: iterators are lazy and do nothing unless consumed
note: the lint level is defined here

View File

@ -139,7 +139,7 @@ error: unused `X` that must be used
--> $DIR/unused_attributes-must_use.rs:103:5
|
LL | X;
| ^^
| ^
|
note: the lint level is defined here
--> $DIR/unused_attributes-must_use.rs:2:28
@ -151,37 +151,37 @@ error: unused `Y` that must be used
--> $DIR/unused_attributes-must_use.rs:104:5
|
LL | Y::Z;
| ^^^^^
| ^^^^
error: unused `U` that must be used
--> $DIR/unused_attributes-must_use.rs:105:5
|
LL | U { unit: () };
| ^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^
error: unused return value of `U::method` that must be used
--> $DIR/unused_attributes-must_use.rs:106:5
|
LL | U::method();
| ^^^^^^^^^^^^
| ^^^^^^^^^^^
error: unused return value of `foo` that must be used
--> $DIR/unused_attributes-must_use.rs:107:5
|
LL | foo();
| ^^^^^^
| ^^^^^
error: unused return value of `foreign_foo` that must be used
--> $DIR/unused_attributes-must_use.rs:110:9
|
LL | foreign_foo();
| ^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^
error: unused return value of `Use::get_four` that must be used
--> $DIR/unused_attributes-must_use.rs:118:5
|
LL | ().get_four();
| ^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^
error: aborting due to 28 previous errors

View File

@ -2,7 +2,7 @@ warning: unused generator that must be used
--> $DIR/issue-48623-generator.rs:15:5
|
LL | move || { d; yield; &mut *r };
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: generators are lazy and do nothing unless resumed
= note: `#[warn(unused_must_use)]` on by default