Skip to content

Error message for question mark operator should message conversion #60917

Closed
@sunjay

Description

@sunjay
Member

I've been working with a lot of people who are either new to Rust or new to its latest features (like the question mark operator) and I'm noticing a lot of confusion around a specific error message.

Suppose you have the following code:

#[derive(Debug)]
struct Error1;
#[derive(Debug)]
struct Error2;

fn foo() -> Result<(), Error1> {
    Err(Error1)
}

fn main() -> Result<(), Error2> {
    foo()?;
    
    Ok(())
}

This gives you the error:

error[E0277]: the trait bound `Error2: std::convert::From<Error1>` is not satisfied
  --> src/main.rs:11:5
   |
11 |     foo()?;
   |     ^^^^^^ the trait `std::convert::From<Error1>` is not implemented for `Error2`
   |
   = note: required by `std::convert::From::from`

However, if you look at the actual code, it isn't obvious where the From trait is even being used.

The documentation for the From trait actually does mention this briefly, though most people I encounter don't go as far as looking that up. The error message is pretty daunting if you're new to the language.

I propose that we add something to the error message when we see that they are using the question mark:

help: the question mark operation (`?`) implicitly performs a conversion
      on the error value using the `From` trait. If no conversion is
      defined, you will see this error message.

This conveys exactly where the From trait is being used and why they may be running into this issue. You certainly don't have to use this exact wording. Feel free to use whatever fits. :)

Activity

added
A-diagnosticsArea: Messages for errors, warnings, and lints
C-enhancementCategory: An issue proposing an enhancement or a PR with one.
T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.
on May 17, 2019
estebank

estebank commented on May 17, 2019

@estebank
Contributor

For what it's worth, the current output points at the question mark now:

error[E0277]: `?` couldn't convert the error to `Error2`
  --> src/main.rs:11:10
   |
11 |     foo()?;
   |          ^ the trait `std::convert::From<Error1>` is not implemented for `Error2`
   |
   = note: required by `std::convert::From::from`
sunjay

sunjay commented on May 17, 2019

@sunjay
MemberAuthor

Thanks! That's a good start. I find that just pointing to it isn't enough because people don't even know that the question mark operator performs a conversion. The [edition guide] (https://doc.rust-lang.org/edition-guide/rust-2018/error-handling-and-panics/the-question-mark-operator-for-easier-error-handling.html) (a top result for looking up "rust question mark operator") doesn't even reference the From trait.

estebank

estebank commented on May 17, 2019

@estebank
Contributor

Does #60924 look like what you had in mind, @sunjay?

added a commit that references this issue on May 19, 2019

Rollup merge of rust-lang#60924 - estebank:try-msg, r=petrochenkov

80d372f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-diagnosticsArea: Messages for errors, warnings, and lintsC-enhancementCategory: An issue proposing an enhancement or a PR with one.T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @sunjay@estebank@jonas-schievink

      Issue actions

        Error message for question mark operator should message conversion · Issue #60917 · rust-lang/rust