rust/compiler
bors 5753b30676 Auto merge of #117967 - adetaylor:fix-lifetime-elision-bug, r=lcnr
Fix ambiguous cases of multiple & in elided self lifetimes

This change proposes simpler rules to identify the lifetime on `self` parameters which may be used to elide a return type lifetime.

## The old rules

(copied from [this comment](https://github.com/rust-lang/rust/pull/117967#discussion_r1420554242))

Most of the code can be found in [late.rs](https://doc.rust-lang.org/stable/nightly-rustc/src/rustc_resolve/late.rs.html) and acts on AST types. The function [resolve_fn_params](https://doc.rust-lang.org/stable/nightly-rustc/src/rustc_resolve/late.rs.html#2006), in the success case, returns a single lifetime which can be used to elide the lifetime of return types.

Here's how:
* If the first parameter is called self then we search that parameter using "`self` search rules", below
* If no unique applicable lifetime was found, search all other parameters using "regular parameter search rules", below

(In practice the code does extra work to assemble good diagnostic information, so it's not quite laid out like the above.)

### `self` search rules

This is primarily handled in [find_lifetime_for_self](https://doc.rust-lang.org/stable/nightly-rustc/src/rustc_resolve/late.rs.html#2118) , and is described slightly [here](https://github.com/rust-lang/rust/issues/117715#issuecomment-1813115477) already. The code:

1. Recursively walks the type of the `self` parameter (there's some complexity about resolving various special cases, but it's essentially just walking the type as far as I can see)
2. Each time we find a reference anywhere in the type, if the **direct** referent is `Self` (either spelled `Self` or by some alias resolution which I don't fully understand), then we'll add that to a set of candidate lifetimes
3. If there's exactly one such unique lifetime candidate found, we return this lifetime.

### Regular parameter search rules

1. Find all the lifetimes in each parameter, including implicit, explicit etc.
2. If there's exactly one parameter containing lifetimes, and if that parameter contains exactly one (unique) lifetime, *and if we didn't find a `self` lifetime parameter already*, we'll return this lifetime.

## The new rules

There are no changes to the "regular parameter search rules" or to the overall flow, only to the `self` search rules which are now:

1. Recursively walks the type of the `self` parameter, searching for lifetimes of reference types whose referent **contains** `Self`.[^1]
2. Keep a record of:
   * Whether 0, 1 or n unique lifetimes are found on references encountered during the walk
4. If no lifetime was found, we don't return a lifetime. (This means other parameters' lifetimes may be used for return type lifetime elision).
5. If there's one lifetime found, we return the lifetime.
6. If multiple lifetimes were found, we abort elision entirely (other parameters' lifetimes won't be used).

[^1]: this prevents us from considering lifetimes from inside of the self-type

## Examples that were accepted before and will now be rejected

```rust
fn a(self: &Box<&Self>) -> &u32
fn b(self: &Pin<&mut Self>) -> &String
fn c(self: &mut &Self) -> Option<&Self>
fn d(self: &mut &Box<Self>, arg: &usize) -> &usize // previously used the lt from arg
```

### Examples that change the elided lifetime

```rust
fn e(self: &mut Box<Self>, arg: &usize) -> &usize
//         ^ new                ^ previous
```

## Examples that were rejected before and will now be accepted

```rust
fn f(self: &Box<Self>) -> &u32
```

---

*edit: old PR description:*

```rust
  struct Concrete(u32);

  impl Concrete {
      fn m(self: &Box<Self>) -> &u32 {
          &self.0
      }
  }
```

resulted in a confusing error.

```rust
  impl Concrete {
      fn n(self: &Box<&Self>) -> &u32 {
          &self.0
      }
  }
```

resulted in no error or warning, despite apparent ambiguity over the elided lifetime.

Fixes https://github.com/rust-lang/rust/issues/117715
2024-07-18 13:33:38 +00:00
..
rustc The rustc crate feature is called jemalloc 2024-07-15 13:01:20 -04:00
rustc_abi Rollup merge of #127769 - compiler-errors:ed-2024-dep, r=oli-obk 2024-07-17 16:22:31 +02:00
rustc_arena
rustc_ast Rollup merge of #127806 - nnethercote:parser-improvements, r=spastorino 2024-07-17 19:53:27 -05:00
rustc_ast_ir Use dep: for crate dependencies 2024-07-15 12:40:10 -04:00
rustc_ast_lowering Delegation: support coercion for target expression 2024-07-16 18:03:15 +03:00
rustc_ast_passes Rollup merge of #126762 - compiler-errors:kw-lt, r=michaelwoerister 2024-07-16 16:15:15 -05:00
rustc_ast_pretty Rollup merge of #127092 - compiler-errors:rtn-dots-redux, r=estebank 2024-07-03 23:30:07 +02:00
rustc_attr
rustc_baked_icu_data
rustc_borrowck Rollup merge of #127810 - compiler-errors:less-tcx, r=lcnr 2024-07-18 08:09:00 +02:00
rustc_builtin_macros Rollup merge of #127308 - nnethercote:Attribute-cleanups, r=petrochenkov 2024-07-07 14:22:01 +02:00
rustc_codegen_cranelift Rollup merge of #124033 - bjorn3:ar_archive_writer_0_3_0, r=davidtwco 2024-07-16 16:15:13 -05:00
rustc_codegen_gcc Format cg_gcc with same formatting parameters 2024-07-17 20:22:07 +02:00
rustc_codegen_llvm Rollup merge of #124033 - bjorn3:ar_archive_writer_0_3_0, r=davidtwco 2024-07-16 16:15:13 -05:00
rustc_codegen_ssa valtree construction: keep track of which type was valtree-incompatible 2024-07-18 11:58:16 +02:00
rustc_const_eval valtree construction: keep track of which type was valtree-incompatible 2024-07-18 11:58:16 +02:00
rustc_data_structures Use dep: for crate dependencies 2024-07-15 12:40:10 -04:00
rustc_driver
rustc_driver_impl Move codegen_and_build_linker from Queries to Linker 2024-07-01 11:00:49 +00:00
rustc_error_codes avoid creating an Instance only to immediately disassemble it again 2024-07-18 11:58:16 +02:00
rustc_error_messages
rustc_errors Rollup merge of #120248 - WaffleLapkin:bonk-ptr-object-casts, r=compiler-errors,oli-obk,lnicola 2024-07-08 16:28:15 +02:00
rustc_expand Rollup merge of #127542 - c410-f3r:concat-again, r=petrochenkov 2024-07-17 19:53:25 -05:00
rustc_feature Rollup merge of #127630 - compiler-errors:type-ascription, r=chenyukang 2024-07-14 20:24:59 +02:00
rustc_fluent_macro
rustc_fs_util
rustc_graphviz
rustc_hir Stop using the gen keyword in the compiler 2024-07-14 14:01:01 -04:00
rustc_hir_analysis Rollup merge of #127888 - estebank:type-param-sugg, r=compiler-errors 2024-07-18 08:09:02 +02:00
rustc_hir_pretty implement new effects desugaring 2024-06-28 10:57:35 +00:00
rustc_hir_typeck Rollup merge of #125042 - long-long-float:suggest-move-arg-outside, r=fmease 2024-07-17 16:22:26 +02:00
rustc_incremental
rustc_index Fix feature gating on rustc_index to not use implicit features 2024-07-15 12:44:24 -04:00
rustc_index_macros Remove usage of specialization from newtype_index! 2024-06-30 16:42:53 +00:00
rustc_infer valtree construction: keep track of which type was valtree-incompatible 2024-07-18 11:58:16 +02:00
rustc_interface Use dep: for crate dependencies 2024-07-15 12:40:10 -04:00
rustc_lexer
rustc_lint Avoid comments that describe multiple use items. 2024-07-17 08:02:46 +10:00
rustc_lint_defs Auto merge of #127097 - compiler-errors:async-closure-lint, r=oli-obk 2024-07-11 06:59:10 +00:00
rustc_llvm Rollup merge of #124033 - bjorn3:ar_archive_writer_0_3_0, r=davidtwco 2024-07-16 16:15:13 -05:00
rustc_log
rustc_macros lift_to_tcx -> lift_to_interner 2024-07-17 10:46:10 -04:00
rustc_metadata report pat no field error no recoverd struct variant 2024-07-11 00:18:47 +08:00
rustc_middle pattern lowering: make sure we never call user-defined PartialEq instances 2024-07-18 11:58:16 +02:00
rustc_mir_build remove saw_const_match_error; check if pattern contains an Error instead 2024-07-18 11:58:16 +02:00
rustc_mir_dataflow Stop using the gen keyword in the compiler 2024-07-14 14:01:01 -04:00
rustc_mir_transform coverage: Restrict ExpressionUsed simplification to Code mappings 2024-07-15 20:54:28 +10:00
rustc_monomorphize Auto merge of #113128 - WaffleLapkin:become_trully_unuwuable, r=oli-obk,RalfJung 2024-07-08 04:35:04 +00:00
rustc_next_trait_solver Use dep: for crate dependencies 2024-07-15 12:40:10 -04:00
rustc_parse Rollup merge of #127842 - nnethercote:rm-TrailingToken, r=petrochenkov 2024-07-18 05:14:07 -05:00
rustc_parse_format
rustc_passes Report usage of lib features in ast validation 2024-07-10 16:53:41 -04:00
rustc_pattern_analysis pattern lowering: make sure we never call user-defined PartialEq instances 2024-07-18 11:58:16 +02:00
rustc_privacy
rustc_query_impl
rustc_query_system Use dep: for crate dependencies 2024-07-15 12:40:10 -04:00
rustc_resolve Auto merge of #117967 - adetaylor:fix-lifetime-elision-bug, r=lcnr 2024-07-18 13:33:38 +00:00
rustc_sanitizers Split out IntoIterator and non-Iterator constructors for AliasTy/AliasTerm/TraitRef/projection 2024-06-24 11:28:21 -04:00
rustc_serialize chore: remove duplicate words 2024-07-02 11:25:31 +08:00
rustc_session Auto merge of #127670 - compiler-errors:no-type-length-limit, r=jackh726 2024-07-14 12:44:07 +00:00
rustc_smir Avoid comments that describe multiple use items. 2024-07-17 08:02:46 +10:00
rustc_span Fix unsafe_op_in_unsafe_fn in compiler 2024-07-16 00:02:44 -04:00
rustc_symbol_mangling Fix FnMut/Fn shim for coroutine-closures that capture references 2024-06-29 17:38:02 -04:00
rustc_target cleanup: remove support for 3DNow! cpu features 2024-07-17 11:45:02 -04:00
rustc_trait_selection const_to_pat: cleanup leftovers from when we had to deal with non-structural constants 2024-07-18 11:58:16 +02:00
rustc_traits Split out overflow handling into its own module 2024-07-09 09:51:56 -04:00
rustc_transmute Use dep: for crate dependencies 2024-07-15 12:40:10 -04:00
rustc_ty_utils Auto merge of #123351 - beetrees:x86-ret-snan-rust, r=nikic,workingjubilee 2024-07-12 20:36:43 +00:00
rustc_type_ir Rollup merge of #127810 - compiler-errors:less-tcx, r=lcnr 2024-07-18 08:09:00 +02:00
rustc_type_ir_macros lift_to_tcx -> lift_to_interner 2024-07-17 10:46:10 -04:00
stable_mir Remove extern "wasm" ABI 2024-07-11 12:20:26 +02:00