Note when opaque future from `async fn` is involved in a type mismatch is unclear #80658

SNCPlay42 · 2021-01-03T19:52:35Z

fn foo() -> u8 {
    async fn async_fn() -> () {}
    
    async_fn()
}

emits

error[E0308]: mismatched types
 --> src/lib.rs:4:5
  |
1 | fn foo() -> u8 {
  |             -- expected `u8` because of return type
2 |     async fn async_fn() -> () {}
  |                            -- the `Output` of this `async fn`'s found opaque type
3 |
4 |     async_fn()
  |     ^^^^^^^^^^ expected `u8`, found opaque type
  |
  = note:     expected type `u8`
          found opaque type `impl Future`

The note "the Output of this async fn's found opaque type" is kind of hard to understand. If the return type of async_fn isn't explicitly given, it doesn't even point at a type:

2 |     async fn async_fn() {}
  |                         - the `Output` of this `async fn`'s found opaque type

Perhaps the note should instead look like this:

2 |     async fn async_fn() {}
  |     ----- the found opaque type is the `impl Future` returned by this `async fn`

@rustbot label A-async-await A-diagnostics D-confusing T-compiler

The text was updated successfully, but these errors were encountered:

nellshamrell · 2021-01-10T23:28:17Z

Looks like #66463 touched areas of code that are relevant to this issue (not to say that it caused the issue, only that it provides a potential pointer to the parts of the code related to generating this error message)

tmandry · 2021-01-28T19:59:50Z

@nellshamrell Are you still planning to work on this? If not no worries, feel free to release your assignment.

…tebank Reword labels on E0308 involving async fn return type Fix for rust-lang#80658. When someone writes code like this: ```rust fn foo() -> u8 { async fn async_fn() -> () {} async_fn() } ``` And they try to compile it, they will see an error that looks like this: ```bash error[E0308]: mismatched types --> test.rs:4:5 | 1 | fn foo() -> u8 { | -- expected `u8` because of return type 2 | async fn async_fn() -> () {} | -- checked the `Output` of this `async fn`, found opaque type 3 | 4 | async_fn() | ^^^^^^^^^^ expected `u8`, found opaque type | = note: while checking the return type of this `async fn` = note: expected type `u8` found opaque type `impl Future` ```

henryboisdequin · 2021-03-11T08:01:42Z

Can't this issue be closed (#82165) or is there still more work to be done?

camelid · 2021-04-02T02:48:37Z

The note seems clearer now:

error[E0308]: mismatched types
 --> src/lib.rs:4:5
  |
1 | fn foo() -> u8 {
  |             -- expected `u8` because of return type
2 |     async fn async_fn() -> () {}
  |                            -- checked the `Output` of this `async fn`, found opaque type
3 |     
4 |     async_fn()
  |     ^^^^^^^^^^ expected `u8`, found opaque type
  |
  = note: while checking the return type of the `async fn`
  = note:     expected type `u8`
          found opaque type `impl Future`

But it would be good to get confirmation that this is fixed before closing.

SNCPlay42 · 2021-04-02T02:59:01Z

"checked the Output of this async fn, found opaque type" still seems confusing to me; that makes it sound like the mismatch is in the Output of the Future returned by the function, which isn't the case. The mismatch is that it is a Future<Output = T>, regardless of what T is, instead of just a u8.

(Oops, did I confuse the issue by giving foo and async_fn different nominal return types? It would still be a mismatch if async_fn was declared as async fn async_fn() -> u8.)

nikomatsakis · 2021-04-13T18:37:58Z

This is going to be a very common scenario.

I'd prefer to see a more radically improved error message. What I posted on #84166 was something like

error[E0308]: missing await on future
 --> src/main.rs:8:12
  |
3 | async fn return_number() -> usize {
  | ----- calling an async function returns a future
...
8 |     return return_number();
  |            ^^^^^^^^^^^^^^^ expected `usize`, found future
  |
help: consider `await`ing on the `Future`
  |
8 |     return return_number().await;
  |                           ^^^^^^

error: aborting due to previous error

tmandry · 2021-04-16T17:31:20Z

@rustbot assign @nellshamrell

nikomatsakis · 2021-04-21T23:29:48Z

So I was looking at this in order to write mentoring instructions. I note that the example in the OP contains a kind of type error (the async function is returning (), but the outer function is returning u8) -- @SNCPlay42 was that intentional?

If we rewrite to this example:

fn foo() -> u8 {
    async fn async_fn() -> u8 {  22 }
    
    async_fn()
}

we presently get this error:

error[E0308]: mismatched types
 --> src/lib.rs:4:5
  |
1 | fn foo() -> u8 {
  |             -- expected `u8` because of return type
2 |     async fn async_fn() -> u8 {  22 }
  |                            -- the `Output` of this `async fn`'s found opaque type
3 |     
4 |     async_fn()
  |     ^^^^^^^^^^ expected `u8`, found opaque type
  |
  = note:     expected type `u8`
          found opaque type `impl Future`
help: consider `await`ing on the `Future`
  |
4 |     async_fn().await
  |               ^^^^^^

nikomatsakis · 2021-04-21T23:31:35Z

I would like to give this error;

error[E0308]: missing await on future
 --> src/main.rs:8:12
  |
1 | fn foo() -> u8 {
  |             -- expected `u8` because of return type
2 |     async fn async_fn() -> u8 {  22 }
  |     ----- calling an async function returns a future
3 |     
4 |     async_fn()
  |     ^^^^^^^^^^ expected `u8`, found future
  |
help: consider `await`ing on the `Future`
  |
4 |     async_fn().await
  |               ^^^^^^

error: aborting due to previous error

which isn't that far apart.

nikomatsakis · 2021-04-21T23:33:46Z

I believe the current "help" is generated by this function:

rust/compiler/rustc_infer/src/infer/error_reporting/mod.rs

Lines 1731 to 1755 in e5615dc

    
           /// A possible error is to forget to add `.await` when using futures: 
        
           /// 
        
           /// ``` 
        
           /// async fn make_u32() -> u32 { 
        
           ///     22 
        
           /// } 
        
           /// 
        
           /// fn take_u32(x: u32) {} 
        
           /// 
        
           /// async fn foo() { 
        
           ///     let x = make_u32(); 
        
           ///     take_u32(x); 
        
           /// } 
        
           /// ``` 
        
           /// 
        
           /// This routine checks if the found type `T` implements `Future<Output=U>` where `U` is the 
        
           /// expected type. If this is the case, and we are inside of an async body, it suggests adding 
        
           /// `.await` to the tail of the expression. 
        
           fn suggest_await_on_expect_found( 
        
               &self, 
        
               cause: &ObligationCause<'tcx>, 
        
               exp_span: Span, 
        
               exp_found: &ty::error::ExpectedFound<Ty<'tcx>>, 
        
               diag: &mut DiagnosticBuilder<'tcx>, 
        
           ) {

although there are some other places that generate similar messages (e.g., here).

nikomatsakis · 2021-04-21T23:34:50Z

This in turn is invoked from

rust/compiler/rustc_infer/src/infer/error_reporting/mod.rs

Lines 1424 to 1431 in e5615dc

    
           pub fn note_type_err( 
        
               &self, 
        
               diag: &mut DiagnosticBuilder<'tcx>, 
        
               cause: &ObligationCause<'tcx>, 
        
               secondary_span: Option<(Span, String)>, 
        
               mut values: Option<ValuePairs<'tcx>>, 
        
               terr: &TypeError<'tcx>, 
        
           ) {

nikomatsakis · 2021-04-21T23:36:42Z

This could be a bit difficult because the setup is currently very oriented at adding helps and notes to an existing error (diag). To generate the error the way I wanted it would require "resetting' diag to a whole different error pattern, probably by detecting the situation here instead:

rust/compiler/rustc_infer/src/infer/error_reporting/mod.rs

Lines 1941 to 1946 in e5615dc

    
           pub fn report_and_explain_type_error( 
        
               &self, 
        
               trace: TypeTrace<'tcx>, 
        
               terr: &TypeError<'tcx>, 
        
           ) -> DiagnosticBuilder<'tcx> { 
        
               debug!("report_and_explain_type_error(trace={:?}, terr={:?})", trace, terr);

although note_type_err is also called from other places, like here.

nikomatsakis · 2021-04-21T23:39:02Z

You'll have to dig a bit through the code to see just how hard it is to decide when the await message applies, although you can see from the OP that even if the types aren't exactly equal, there's probably a better error to be given when one type is a future and the other is not.

I think if I were going to do this I might keep the logic in note_type_err, but also have report_and_explain_type_error discover the situation and report a different sort of error, although it'd be good to make some examples where note_type_err' logic still triggers.

nikomatsakis · 2021-04-21T23:39:10Z

Not sure @nellshamrell if that helps at all =)

nellshamrell · 2021-05-31T19:15:12Z

FINALLY have some time to devote to this. Thank you so much for the pointers, @nikomatsakis, that helps a lot!

nellshamrell · 2021-05-31T19:24:45Z

Repro steps

Adding some repro steps for my own reference (and for anyone else!)

$ cargo new troubleshooting_example
$ cd troubleshooting_example

Head into src/lib.rs and change to:

fn foo() -> u8 {
    async fn async_fn() -> u8 {  22 }
    
    async_fn()
}

Actual behavior

$ cargo build

error[E0308]: mismatched types
 --> src/lib.rs:4:5
  |
1 | fn foo() -> u8 {
  |             -- expected `u8` because of return type
2 |     async fn async_fn() -> u8 {  22 }
  |                            -- the `Output` of this `async fn`'s found opaque type
3 |     
4 |     async_fn()
  |     ^^^^^^^^^^ expected `u8`, found opaque type
  |
  = note:     expected type `u8`
          found opaque type `impl std::future::Future`

error: aborting due to previous error

For more information about this error, try `rustc --explain E0308`.
error: could not compile `troubleshooting_example`.

To learn more, run the command again with --verbose.

Desired behavior

$ cargo build

error[E0308]: missing await on future
 --> src/main.rs:8:12
  |
1 | fn foo() -> u8 {
  |             -- expected `u8` because of return type
2 |     async fn async_fn() -> u8 {  22 }
  |     ----- calling an async function returns a future
3 |     
4 |     async_fn()
  |     ^^^^^^^^^^ expected `u8`, found future
  |
help: consider `await`ing on the `Future`
  |
4 |     async_fn().await
  |               ^^^^^^

error: aborting due to previous error

nellshamrell · 2021-05-31T20:55:05Z

Notes

Relevant files/functions

compiler/rustc_infer/src/infer/error_reporting/mod.rs

add_labels_for_types

This function adds some wording async errors (this is where I focused in #82165)

            fn add_labels_for_types(
                &self,
                err: &mut DiagnosticBuilder<'_>,
                target: &str,
                types: &FxHashMap<TyCategory, FxHashSet<Span>>,
            ) {
                for (key, values) in types.iter() {
                    let count = values.len();
                    let kind = key.descr();
                    let mut returned_async_output_error = false;
                    for sp in values {
                        err.span_label(
                            *sp,
                            format!(
                                "{}{}{} {}{}",
                                if sp.is_desugaring(DesugaringKind::Async)
                                    && !returned_async_output_error
                                {
                                    "checked the `Output` of this `async fn`, "
                                } else if count == 1 {
                                    "the "
                                } else {
                                    ""
                                },
                                if count > 1 { "one of the " } else { "" },
                                target,
                                kind,
                                pluralize!(count),
                            ),
                        );
                        if sp.is_desugaring(DesugaringKind::Async)
                            && returned_async_output_error == false
                        {
                            err.note("while checking the return type of the `async fn`");
                            returned_async_output_error = true;
                        }
                    }
                }
            }
        }

suggest_await_on_expect_found

This appears to generate the help text in the relevant async error from the example, particularly this section:

            (_, Some(ty)) if ty::TyS::same_type(exp_found.expected, ty) => {
                let span = match cause.code {
                    // scrutinee's span
                    ObligationCauseCode::Pattern { span: Some(span), .. } => span,
                    _ => exp_span,
                };
                diag.span_suggestion_verbose(
                    span.shrink_to_hi(),
                    "consider `await`ing on the `Future`",
                    ".await".to_string(),
                    Applicability::MaybeIncorrect,
                );
            }

note_type_err

This function calls suggest_await_on_expect_found

        if let Some(exp_found) = exp_found {
            self.suggest_as_ref_where_appropriate(span, &exp_found, diag);
            self.suggest_accessing_field_where_appropriate(cause, &exp_found, diag);
            self.suggest_await_on_expect_found(cause, span, &exp_found, diag);
        }

nikomatsakis · 2021-06-03T15:01:24Z

@nellshamrell sounds good-- let me know if I can help

nellshamrell · 2021-06-07T01:48:58Z

I've completed a partial fix for this at this time.

When running the above example, I now get this output:

nell@DESKTOP-VBH9MU6:~/rust/troubleshooting_example$ rustc +rust-stage-1 src/lib.rs --edition 2018
error[E0308]: mismatched types
 --> src/lib.rs:4:5
  |
1 | fn foo() -> u8 {
  |             -- expected `u8` because of return type
2 |     async fn async_fn() -> u8 {  22 }
  |                            -- calling an async function returns a future
3 |
4 |     async_fn()
  |     ^^^^^^^^^^ expected `u8`, found opaque type
  |
  = note: while checking the return type of the `async fn`
  = note:     expected type `u8`
          found opaque type `impl Future`
help: consider `await`ing on the `Future`
  |
4 |     async_fn().await
  |               ^^^^^^

error: aborting due to 2 previous errors

Some errors have detailed explanations: E0308, E0601.
For more information about an error, try `rustc --explain E0308`.

Seeing if I can further improve it.

nellshamrell · 2021-06-07T01:55:19Z

I'm trying to figure out where in the code "^^^^^^^^^^ expected u8, found opaque type" is generated.

nikomatsakis · 2021-06-08T13:46:31Z

@nellshamrell there is some generic machinery to manage type mismatches, I guess it's there somewhere

nellshamrell · 2021-06-29T01:03:21Z

I've opened a PR with at least a partial fix for this issue: #86705

eholk · 2022-11-21T16:55:57Z

Is this still an issue?

The current output for the test case (playground) is:

Compiling playground v0.0.1 (/playground)
error[[E0308]](https://doc.rust-lang.org/stable/error-index.html#E0308): mismatched types
 --> src/lib.rs:4:5
  |
1 | fn foo() -> u8 {
  |             -- expected `u8` because of return type
...
4 |     async_fn()
  |     ^^^^^^^^^^ expected `u8`, found opaque type
  |
note: while checking the return type of the `async fn`
 --> src/lib.rs:2:28
  |
2 |     async fn async_fn() -> u8 {  22 }
  |                            ^^ checked the `Output` of this `async fn`, found opaque type
  = note:     expected type `u8`
          found opaque type `impl Future<Output = u8>`
help: consider `await`ing on the `Future`
  |
4 |     async_fn().await
  |               ++++++

For more information about this error, try `rustc --explain E0308`.
error: could not compile `playground` due to previous error

which looks pretty close to the desired output listed above.

vincenzopalazzo · 2022-12-08T17:37:47Z

@rustbot claim

I will take a look as discussed in one of the async team meeting

Considering the following code ```rust fn foo() -> u8 { async fn async_fn() -> u8 { 22 } async_fn() } fn main() {} ``` the error generated before this commit from the compiler is ``` ➜ rust git:(macros/async_fn_suggestion) ✗ rustc test.rs --edition 2021 error[E0308]: mismatched types --> test.rs:4:5 | 1 | fn foo() -> u8 { | -- expected `u8` because of return type ... 4 | async_fn() | ^^^^^^^^^^ expected `u8`, found opaque type | = note: expected type `u8` found opaque type `impl Future<Output = u8>` help: consider `await`ing on the `Future` | 4 | async_fn().await | ++++++ error: aborting due to previous error ``` In this case the error is nor perfect, and can confuse the user that do not know that the opaque type is the future. So this commit will propose (and conclude the work start in rust-lang#80658) to change the string `opaque type` to `future` when applicable and also remove the Expected vs Received note by adding a more specific one regarding the async function that return a future type. So the new error emitted by the compiler is ``` error[E0308]: mismatched types --> test.rs:4:5 | 1 | fn foo() -> u8 { | -- expected `u8` because of return type ... 4 | async_fn() | ^^^^^^^^^^ expected `u8`, found future | note: calling an async function returns a future --> test.rs:4:5 | 4 | async_fn() | ^^^^^^^^^^ help: consider `await`ing on the `Future` | 4 | async_fn().await | ++++++ error: aborting due to previous error ``` Signed-off-by: Vincenzo Palazzo <[email protected]>

rustbot added A-async-await Area: Async & Await A-diagnostics Area: Messages for errors, warnings, and lints D-confusing Diagnostics: Confusing error or lint that should be reworked. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Jan 3, 2021

JohnTitor added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Jan 5, 2021

nellshamrell self-assigned this Jan 7, 2021

tmandry added the AsyncAwait-Triaged Async-await issues that have been triaged during a working group meeting. label Jan 7, 2021

This was referenced Feb 15, 2021

[Work in Progress] Clarify error for opaque type in async functions #82135

Closed

Reword labels on E0308 involving async fn return type #82165

Merged

nellshamrell removed their assignment Mar 18, 2021

SNCPlay42 mentioned this issue Apr 13, 2021

improve error for missing await #84166

Closed

rustbot assigned nellshamrell Apr 16, 2021

nellshamrell mentioned this issue Jun 29, 2021

Nellshamrell/improve async error #86705

Closed

rustbot assigned vincenzopalazzo and unassigned nellshamrell Dec 8, 2022

tmandry moved this to Claimed in wg-async work Dec 8, 2022

tmandry added this to wg-async work Dec 8, 2022

vincenzopalazzo moved this from Claimed to In progress (current sprint) in wg-async work Feb 7, 2023

vincenzopalazzo mentioned this issue Feb 10, 2023

fix: improve the suggestion on future not awaited #107902

Merged

bors closed this as completed in 73b022b Feb 14, 2023

github-project-automation bot moved this from In progress (current sprint) to Done in wg-async work Feb 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Note when opaque future from `async fn` is involved in a type mismatch is unclear #80658

Note when opaque future from `async fn` is involved in a type mismatch is unclear #80658

SNCPlay42 commented Jan 3, 2021 •

edited by rustbot

Loading

nellshamrell commented Jan 10, 2021

tmandry commented Jan 28, 2021

henryboisdequin commented Mar 11, 2021

camelid commented Apr 2, 2021

SNCPlay42 commented Apr 2, 2021

nikomatsakis commented Apr 13, 2021 •

edited

Loading

tmandry commented Apr 16, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nellshamrell commented May 31, 2021

nellshamrell commented May 31, 2021 •

edited

Loading

nellshamrell commented May 31, 2021

nikomatsakis commented Jun 3, 2021

nellshamrell commented Jun 7, 2021 •

edited

Loading

nellshamrell commented Jun 7, 2021

nikomatsakis commented Jun 8, 2021

nellshamrell commented Jun 29, 2021

eholk commented Nov 21, 2022

vincenzopalazzo commented Dec 8, 2022

Note when opaque future from async fn is involved in a type mismatch is unclear #80658

Note when opaque future from async fn is involved in a type mismatch is unclear #80658

Comments

SNCPlay42 commented Jan 3, 2021 • edited by rustbot Loading

nellshamrell commented Jan 10, 2021

tmandry commented Jan 28, 2021

henryboisdequin commented Mar 11, 2021

camelid commented Apr 2, 2021

SNCPlay42 commented Apr 2, 2021

nikomatsakis commented Apr 13, 2021 • edited Loading

tmandry commented Apr 16, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nikomatsakis commented Apr 21, 2021

nellshamrell commented May 31, 2021

nellshamrell commented May 31, 2021 • edited Loading

Repro steps

Actual behavior

Desired behavior

nellshamrell commented May 31, 2021

Notes

Relevant files/functions

compiler/rustc_infer/src/infer/error_reporting/mod.rs

nikomatsakis commented Jun 3, 2021

nellshamrell commented Jun 7, 2021 • edited Loading

nellshamrell commented Jun 7, 2021

nikomatsakis commented Jun 8, 2021

nellshamrell commented Jun 29, 2021

eholk commented Nov 21, 2022

vincenzopalazzo commented Dec 8, 2022

Note when opaque future from `async fn` is involved in a type mismatch is unclear #80658

Note when opaque future from `async fn` is involved in a type mismatch is unclear #80658

SNCPlay42 commented Jan 3, 2021 •

edited by rustbot

Loading

nikomatsakis commented Apr 13, 2021 •

edited

Loading

nellshamrell commented May 31, 2021 •

edited

Loading

nellshamrell commented Jun 7, 2021 •

edited

Loading