mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-23 15:23:46 +00:00
800221b5b8
Refine error spans for "The trait bound `T: Trait` is not satisfied" when passing literal structs/tuples
This PR adds a new heuristic which refines the error span reported for "`T: Trait` is not satisfied" errors, by "drilling down" into individual fields of structs/enums/tuples to point to the "problematic" value.
Here's a self-contained example of the difference in error span:
```rs
struct Burrito<Filling> {
filling: Filling,
}
impl <Filling: Delicious> Delicious for Burrito<Filling> {}
fn eat_delicious_food<Food: Delicious>(food: Food) {}
fn will_type_error() {
eat_delicious_food(Burrito { filling: Kale });
// ^~~~~~~~~~~~~~~~~~~~~~~~~ (before) The trait bound `Kale: Delicious` is not satisfied
// ^~~~ (after) The trait bound `Kale: Delicious` is not satisfied
}
```
(kale is fine, this is just a silly food-based example)
Before this PR, the error span is identified as the entire argument to the generic function `eat_delicious_food`. However, since only `Kale` is the "problematic" part, we can point at it specifically. In particular, the primary error message itself mentions the missing `Kale: Delicious` trait bound, so it's much clearer if this part is called out explicitly.
---
The _existing_ heuristic tries to label the right function argument in `point_at_arg_if_possible`. It goes something like this:
- Look at the broken base trait `Food: Delicious` and find which generics it mentions (in this case, only `Food`)
- Look at the parameter type definitions and find which of them mention `Filling` (in this case, only `food`)
- If there is exactly one relevant parameter, label the corresponding argument with the error span, instead of the entire call
This PR extends this heuristic by further refining the resulting expression span in the new `point_at_specific_expr_if_possible` function. For each `impl` in the (broken) chain, we apply the following strategy:
The strategy to determine this span involves connecting information about our generic `impl`
with information about our (struct) type and the (struct) literal expression:
- Find the `impl` (`impl <Filling: Delicious> Delicious for Burrito<Filling>`)
that links our obligation (`Kale: Delicious`) with the parent obligation (`Burrito<Kale>: Delicious`)
- Find the "original" predicate constraint in the impl (`Filling: Delicious`) which produced our obligation.
- Find all of the generics that are mentioned in the predicate (`Filling`).
- Examine the `Self` type in the `impl`, and see which of its type argument(s) mention any of those generics.
- Examing the definition for the `Self` type, and identify (for each of its variants) if there's a unique field
which uses those generic arguments.
- If there is a unique field mentioning the "blameable" arguments, use that field for the error span.
Before we do any of this logic, we recursively call `point_at_specific_expr_if_possible` on the parent
obligation. Hence we refine the `expr` "outwards-in" and bail at the first kind of expression/impl we don't recognize.
This function returns a `Result<&Expr, &Expr>` - either way, it returns the `Expr` whose span should be
reported as an error. If it is `Ok`, then it means it refined successfull. If it is `Err`, then it may be
only a partial success - but it cannot be refined even further.
---
I added a new test file which exercises this new behavior. A few existing tests were affected, since their error spans are now different. In one case, this leads to a different code suggestion for the autofix - although the new suggestion isn't _wrong_, it is different from what used to be.
This change doesn't create any new errors or remove any existing ones, it just adjusts the spans where they're presented.
---
Some considerations: right now, this check occurs in addition to some similar logic in `adjust_fulfillment_error_for_expr_obligation` function, which tidies up various kinds of error spans (not just trait-fulfillment error). It's possible that this new code would be better integrated into that function (or another one) - but I haven't looked into this yet.
Although this code only occurs when there's a type error, it's definitely not as efficient as possible. In particular, there are definitely some cases where it degrades to quadratic performance (e.g. for a trait `impl` with 100+ generic parameters or 100 levels deep nesting of generic types). I'm not sure if these are realistic enough to worry about optimizing yet.
There's also still a lot of repetition in some of the logic, where the behavior for different types (namely, `struct` vs `enum` variant) is _similar_ but not the same.
---
I think the biggest win here is better targeting for tuples; in particular, if you're using tuples + traits to express variadic-like functions, the compiler can't tell you which part of a tuple has the wrong type, since the span will cover the entire argument. This change allows the individual field in the tuple to be highlighted, as in this example:
```
// NEW
LL | want(Wrapper { value: (3, q) });
| ---- ^ the trait `T3` is not implemented for `Q`
// OLD
LL | want(Wrapper { value: (3, q) });
| ---- ^~~~~~~~~~~~~~~~~~~~~~~~~ the trait `T3` is not implemented for `Q`
```
Especially with large tuples, the existing error spans are not very effective at quickly narrowing down the source of the problem.
|
||
|---|---|---|
| .. | ||
| auxiliary | ||
| clone-debug-dead-code-in-the-same-struct.rs | ||
| clone-debug-dead-code-in-the-same-struct.stderr | ||
| clone-debug-dead-code.rs | ||
| clone-debug-dead-code.stderr | ||
| derive-assoc-type-not-impl.rs | ||
| derive-assoc-type-not-impl.stderr | ||
| derive-deadlock.rs | ||
| derive-deadlock.stderr | ||
| derive-Debug-use-ufcs-struct.rs | ||
| derive-Debug-use-ufcs-tuple.rs | ||
| derive-hygiene.rs | ||
| derive-macro-const-default.rs | ||
| derive-marker-tricky.rs | ||
| derive-multiple-with-packed.rs | ||
| derive-on-trait-item-or-impl-item.rs | ||
| derive-on-trait-item-or-impl-item.stderr | ||
| derive-partial-ord.rs | ||
| derive-renamed.rs | ||
| derives-span-Clone-enum-struct-variant.rs | ||
| derives-span-Clone-enum-struct-variant.stderr | ||
| derives-span-Clone-enum.rs | ||
| derives-span-Clone-enum.stderr | ||
| derives-span-Clone-struct.rs | ||
| derives-span-Clone-struct.stderr | ||
| derives-span-Clone-tuple-struct.rs | ||
| derives-span-Clone-tuple-struct.stderr | ||
| derives-span-Debug-enum-struct-variant.rs | ||
| derives-span-Debug-enum-struct-variant.stderr | ||
| derives-span-Debug-enum.rs | ||
| derives-span-Debug-enum.stderr | ||
| derives-span-Debug-struct.rs | ||
| derives-span-Debug-struct.stderr | ||
| derives-span-Debug-tuple-struct.rs | ||
| derives-span-Debug-tuple-struct.stderr | ||
| derives-span-Default-struct.rs | ||
| derives-span-Default-struct.stderr | ||
| derives-span-Default-tuple-struct.rs | ||
| derives-span-Default-tuple-struct.stderr | ||
| derives-span-Eq-enum-struct-variant.rs | ||
| derives-span-Eq-enum-struct-variant.stderr | ||
| derives-span-Eq-enum.rs | ||
| derives-span-Eq-enum.stderr | ||
| derives-span-Eq-struct.rs | ||
| derives-span-Eq-struct.stderr | ||
| derives-span-Eq-tuple-struct.rs | ||
| derives-span-Eq-tuple-struct.stderr | ||
| derives-span-Hash-enum-struct-variant.rs | ||
| derives-span-Hash-enum-struct-variant.stderr | ||
| derives-span-Hash-enum.rs | ||
| derives-span-Hash-enum.stderr | ||
| derives-span-Hash-struct.rs | ||
| derives-span-Hash-struct.stderr | ||
| derives-span-Hash-tuple-struct.rs | ||
| derives-span-Hash-tuple-struct.stderr | ||
| derives-span-Ord-enum-struct-variant.rs | ||
| derives-span-Ord-enum-struct-variant.stderr | ||
| derives-span-Ord-enum.rs | ||
| derives-span-Ord-enum.stderr | ||
| derives-span-Ord-struct.rs | ||
| derives-span-Ord-struct.stderr | ||
| derives-span-Ord-tuple-struct.rs | ||
| derives-span-Ord-tuple-struct.stderr | ||
| derives-span-PartialEq-enum-struct-variant.rs | ||
| derives-span-PartialEq-enum-struct-variant.stderr | ||
| derives-span-PartialEq-enum.rs | ||
| derives-span-PartialEq-enum.stderr | ||
| derives-span-PartialEq-struct.rs | ||
| derives-span-PartialEq-struct.stderr | ||
| derives-span-PartialEq-tuple-struct.rs | ||
| derives-span-PartialEq-tuple-struct.stderr | ||
| derives-span-PartialOrd-enum-struct-variant.rs | ||
| derives-span-PartialOrd-enum-struct-variant.stderr | ||
| derives-span-PartialOrd-enum.rs | ||
| derives-span-PartialOrd-enum.stderr | ||
| derives-span-PartialOrd-struct.rs | ||
| derives-span-PartialOrd-struct.stderr | ||
| derives-span-PartialOrd-tuple-struct.rs | ||
| derives-span-PartialOrd-tuple-struct.stderr | ||
| deriving-bounds.rs | ||
| deriving-bounds.stderr | ||
| deriving-copyclone.rs | ||
| deriving-copyclone.stderr | ||
| deriving-meta-empty-trait-list.rs | ||
| deriving-meta-unknown-trait.rs | ||
| deriving-meta-unknown-trait.stderr | ||
| deriving-no-inner-impl-error-message.rs | ||
| deriving-no-inner-impl-error-message.stderr | ||
| deriving-non-type.rs | ||
| deriving-non-type.stderr | ||
| deriving-primitive.rs | ||
| deriving-primitive.stderr | ||
| deriving-with-repr-packed-2.rs | ||
| deriving-with-repr-packed-2.stderr | ||
| deriving-with-repr-packed.rs | ||
| deriving-with-repr-packed.stderr | ||
| issue-36617.rs | ||
| issue-36617.stderr | ||
| issue-43023.rs | ||
| issue-43023.stderr | ||
| issue-91492.rs | ||
| issue-91492.stderr | ||
| issue-91550.rs | ||
| issue-91550.stderr | ||
| issue-97343.rs | ||
| issue-97343.stderr | ||