mirror of https://github.com/rust-lang/rust.git
5753b30676
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 |
||
|---|---|---|
| .. | ||
| auxiliary | ||
| elision | ||
| arbitrary-self-from-method-substs-ice.rs | ||
| arbitrary-self-from-method-substs-ice.stderr | ||
| arbitrary-self-from-method-substs.default.stderr | ||
| arbitrary-self-from-method-substs.feature.stderr | ||
| arbitrary-self-from-method-substs.rs | ||
| arbitrary-self-opaque.rs | ||
| arbitrary-self-opaque.stderr | ||
| arbitrary-self-types-not-object-safe.curr.stderr | ||
| arbitrary-self-types-not-object-safe.object_safe_for_dispatch.stderr | ||
| arbitrary-self-types-not-object-safe.rs | ||
| arbitrary_self_type_mut_difference.rs | ||
| arbitrary_self_type_mut_difference.stderr | ||
| arbitrary_self_types_needing_box_or_arc_wrapping.fixed | ||
| arbitrary_self_types_needing_box_or_arc_wrapping.rs | ||
| arbitrary_self_types_needing_box_or_arc_wrapping.stderr | ||
| arbitrary_self_types_needing_mut_pin.fixed | ||
| arbitrary_self_types_needing_mut_pin.rs | ||
| arbitrary_self_types_needing_mut_pin.stderr | ||
| arbitrary_self_types_nested.rs | ||
| arbitrary_self_types_pin_lifetime-async.rs | ||
| arbitrary_self_types_pin_lifetime.rs | ||
| arbitrary_self_types_pin_lifetime_impl_trait-async.rs | ||
| arbitrary_self_types_pin_lifetime_impl_trait-async.stderr | ||
| arbitrary_self_types_pin_lifetime_impl_trait.rs | ||
| arbitrary_self_types_pin_lifetime_impl_trait.stderr | ||
| arbitrary_self_types_pin_lifetime_mismatch-async.rs | ||
| arbitrary_self_types_pin_lifetime_mismatch-async.stderr | ||
| arbitrary_self_types_pin_lifetime_mismatch.rs | ||
| arbitrary_self_types_pin_lifetime_mismatch.stderr | ||
| arbitrary_self_types_pin_needing_borrow.rs | ||
| arbitrary_self_types_pin_needing_borrow.stderr | ||
| arbitrary_self_types_pointers_and_wrappers.rs | ||
| arbitrary_self_types_raw_pointer_struct.rs | ||
| arbitrary_self_types_raw_pointer_trait.rs | ||
| arbitrary_self_types_silly.rs | ||
| arbitrary_self_types_stdlib_pointers.rs | ||
| arbitrary_self_types_struct.rs | ||
| arbitrary_self_types_trait.rs | ||
| arbitrary_self_types_unsized_struct.rs | ||
| builtin-superkinds-self-type.rs | ||
| by-value-self-in-mut-slot.rs | ||
| class-missing-self.rs | ||
| class-missing-self.stderr | ||
| explicit-self-closures.rs | ||
| explicit-self-generic.rs | ||
| explicit-self-objects-uniq.rs | ||
| explicit-self.rs | ||
| explicit_self_xcrate_exe.rs | ||
| issue-61882-2.rs | ||
| issue-61882-2.stderr | ||
| issue-61882.rs | ||
| issue-61882.stderr | ||
| move-self.rs | ||
| object-safety-sized-self-by-value-self.rs | ||
| object-safety-sized-self-generic-method.rs | ||
| object-safety-sized-self-return-Self.rs | ||
| objects-owned-object-owned-method.rs | ||
| point-at-arbitrary-self-type-method.rs | ||
| point-at-arbitrary-self-type-method.stderr | ||
| point-at-arbitrary-self-type-trait-method.rs | ||
| point-at-arbitrary-self-type-trait-method.stderr | ||
| self-ctor-nongeneric.rs | ||
| self-ctor-nongeneric.stderr | ||
| self-ctor.rs | ||
| self-ctor.stderr | ||
| self-impl-2.rs | ||
| self-impl.rs | ||
| self-impl.stderr | ||
| self-in-mut-slot-default-method.rs | ||
| self-in-mut-slot-immediate-value.rs | ||
| self-in-typedefs.rs | ||
| self-infer.rs | ||
| self-infer.stderr | ||
| self-re-assign.rs | ||
| self-shadowing-import.rs | ||
| self-type-param.rs | ||
| self-vs-path-ambiguity.rs | ||
| self-vs-path-ambiguity.stderr | ||
| self_lifetime-async.rs | ||
| self_lifetime.rs | ||
| self_type_keyword-2.rs | ||
| self_type_keyword-2.stderr | ||
| self_type_keyword.rs | ||
| self_type_keyword.stderr | ||
| string-self-append.rs | ||
| suggest-self-2.rs | ||
| suggest-self-2.stderr | ||
| suggest-self.rs | ||
| suggest-self.stderr | ||
| ufcs-explicit-self.rs | ||
| uniq-self-in-mut-slot.rs | ||
| where-for-self.rs | ||