Tweak &mut self suggestion span

estebank · estebank · commit 130b0d294a34 · 2025-01-28T19:35:51.000Z
```
error[E0596]: cannot borrow `*self.s` as mutable, as it is behind a `&amp;` reference
  --&gt; $DIR/issue-38147-1.rs:17:9
   |
LL |         self.s.push('x');
   |         ^^^^^^ `self` is a `&amp;` reference, so the data it refers to cannot be borrowed as mutable
   |
help: consider changing this to be a mutable reference
   |
LL |     fn f(&amp;mut self) {
   |           +++
```

Note the suggestion to add `mut` instead of replacing the entire `&amp;self` with `&amp;mut self`.
diff --git a/compiler/rustc_borrowck/src/diagnostics/mutability_errors.rs b/compiler/rustc_borrowck/src/diagnostics/mutability_errors.rs
@@ -1140,10 +1140,9 @@ impl<'infcx, 'tcx> MirBorrowckCtxt<'_, 'infcx, 'tcx> {
 
         let amp_mut_sugg = match *local_decl.local_info() {
             LocalInfo::User(mir::BindingForm::ImplicitSelf(_)) => {
-                let suggestion = suggest_ampmut_self(self.infcx.tcx, decl_span);
-                let additional =
-                    local_trait.map(|span| (span, suggest_ampmut_self(self.infcx.tcx, span)));
-                Some(AmpMutSugg { has_sugg: true, span: decl_span, suggestion, additional })
+                let (span, suggestion) = suggest_ampmut_self(self.infcx.tcx, decl_span);
+                let additional = local_trait.map(|span| suggest_ampmut_self(self.infcx.tcx, span));
+                Some(AmpMutSugg { has_sugg: true, span, suggestion, additional })
             }
 
             LocalInfo::User(mir::BindingForm::Var(mir::VarBindingForm {
@@ -1202,10 +1201,11 @@ impl<'infcx, 'tcx> MirBorrowckCtxt<'_, 'infcx, 'tcx> {
                                     opt_ty_info: None,
                                     ..
                                 })) => {
-                                    let sugg = suggest_ampmut_self(self.infcx.tcx, decl_span);
+                                    let (span, sugg) =
+                                        suggest_ampmut_self(self.infcx.tcx, decl_span);
                                     Some(AmpMutSugg {
                                         has_sugg: true,
-                                        span: decl_span,
+                                        span,
                                         suggestion: sugg,
                                         additional: None,
                                     })
@@ -1461,17 +1461,12 @@ fn mut_borrow_of_mutable_ref(local_decl: &LocalDecl<'_>, local_name: Option<Symb
     }
 }
 
-fn suggest_ampmut_self<'tcx>(tcx: TyCtxt<'tcx>, span: Span) -> String {
+fn suggest_ampmut_self(tcx: TyCtxt<'_>, span: Span) -> (Span, String) {
     match tcx.sess.source_map().span_to_snippet(span) {
-        Ok(snippet) => {
-            let lt_pos = snippet.find('\'');
-            if let Some(lt_pos) = lt_pos {
-                format!("&{}mut self", &snippet[lt_pos..snippet.len() - 4])
-            } else {
-                "&mut self".to_string()
-            }
+        Ok(snippet) if snippet.ends_with("self") => {
+            (span.with_hi(span.hi() - BytePos(4)).shrink_to_hi(), "mut ".to_string())
         }
-        _ => "&mut self".to_string(),
+        _ => (span, "&mut self".to_string()),
     }
 }
 
diff --git a/tests/ui/borrowck/issue-93093.rs b/tests/ui/borrowck/issue-93093.rs
@@ -4,7 +4,7 @@ struct S {
 }
 impl S {
     async fn bar(&self) { //~ HELP consider changing this to be a mutable reference
-        //~| SUGGESTION &mut self
+        //~| SUGGESTION mut
         self.foo += 1; //~ ERROR cannot assign to `self.foo`, which is behind a `&` reference [E0594]
     }
 }
diff --git a/tests/ui/borrowck/issue-93093.stderr b/tests/ui/borrowck/issue-93093.stderr
@@ -7,7 +7,7 @@ LL |         self.foo += 1;
 help: consider changing this to be a mutable reference
    |
 LL |     async fn bar(&mut self) {
-   |                  ~~~~~~~~~
+   |                   +++
 
 error: aborting due to 1 previous error
 
diff --git a/tests/ui/borrowck/trait-impl-argument-difference-ice.stderr b/tests/ui/borrowck/trait-impl-argument-difference-ice.stderr
@@ -41,7 +41,7 @@ LL |         let a16 = self.read_word() as u16;
 help: consider changing this to be a mutable reference in the `impl` method and the `trait` definition
    |
 LL |     extern "C" fn read_dword(&'_ mut self) -> u16 {
-   |                              ~~~~~~~~~~~~
+   |                                  +++
 
 error[E0596]: cannot borrow `*self` as mutable, as it is behind a `&` reference
   --> $DIR/trait-impl-argument-difference-ice.rs:18:19
@@ -52,7 +52,7 @@ LL |         let b16 = self.read_word() as u16;
 help: consider changing this to be a mutable reference in the `impl` method and the `trait` definition
    |
 LL |     extern "C" fn read_dword(&'_ mut self) -> u16 {
-   |                              ~~~~~~~~~~~~
+   |                                  +++
 
 error: aborting due to 5 previous errors; 1 warning emitted
 
diff --git a/tests/ui/did_you_mean/issue-38147-1.stderr b/tests/ui/did_you_mean/issue-38147-1.stderr
@@ -7,7 +7,7 @@ LL |         self.s.push('x');
 help: consider changing this to be a mutable reference
    |
 LL |     fn f(&mut self) {
-   |          ~~~~~~~~~
+   |           +++
 
 error: aborting due to 1 previous error
 
diff --git a/tests/ui/did_you_mean/issue-39544.stderr b/tests/ui/did_you_mean/issue-39544.stderr
@@ -18,7 +18,7 @@ LL |         let _ = &mut self.x;
 help: consider changing this to be a mutable reference
    |
 LL |     fn foo<'z>(&'z mut self) {
-   |                ~~~~~~~~~~~~
+   |                    +++
 
 error[E0596]: cannot borrow `self.x` as mutable, as it is behind a `&` reference
   --> $DIR/issue-39544.rs:20:17
@@ -29,7 +29,7 @@ LL |         let _ = &mut self.x;
 help: consider changing this to be a mutable reference
    |
 LL |     fn foo1(&mut self, other: &Z) {
-   |             ~~~~~~~~~
+   |              +++
 
 error[E0596]: cannot borrow `other.x` as mutable, as it is behind a `&` reference
   --> $DIR/issue-39544.rs:21:17
@@ -51,7 +51,7 @@ LL |         let _ = &mut self.x;
 help: consider changing this to be a mutable reference
    |
 LL |     fn foo2<'a>(&'a mut self, other: &Z) {
-   |                 ~~~~~~~~~~~~
+   |                     +++
 
 error[E0596]: cannot borrow `other.x` as mutable, as it is behind a `&` reference
   --> $DIR/issue-39544.rs:26:17
diff --git a/tests/ui/mut/mutable-class-fields-2.stderr b/tests/ui/mut/mutable-class-fields-2.stderr
@@ -7,7 +7,7 @@ LL |     self.how_hungry -= 5;
 help: consider changing this to be a mutable reference
    |
 LL |   pub fn eat(&mut self) {
-   |              ~~~~~~~~~
+   |               +++
 
 error: aborting due to 1 previous error
 
diff --git a/tests/ui/suggestions/suggest-ref-mut.rs b/tests/ui/suggestions/suggest-ref-mut.rs
@@ -3,7 +3,7 @@ struct X(usize);
 impl X {
     fn zap(&self) {
         //~^ HELP
-        //~| SUGGESTION &mut self
+        //~| SUGGESTION mut
         self.0 = 32;
         //~^ ERROR
     }
diff --git a/tests/ui/suggestions/suggest-ref-mut.stderr b/tests/ui/suggestions/suggest-ref-mut.stderr
@@ -7,7 +7,7 @@ LL |         self.0 = 32;
 help: consider changing this to be a mutable reference
    |
 LL |     fn zap(&mut self) {
-   |            ~~~~~~~~~
+   |             +++
 
 error[E0594]: cannot assign to `*foo`, which is behind a `&` reference
   --> $DIR/suggest-ref-mut.rs:15:5

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ struct S {`
`4`	`4`	`}`
`5`	`5`	`impl S {`
`6`	`6`	`async fn bar(&self) { //~ HELP consider changing this to be a mutable reference`
`7`		`- //~\| SUGGESTION &mut self`
	`7`	`+ //~\| SUGGESTION mut`
`8`	`8`	self.foo += 1; //~ ERROR cannot assign to `self.foo`, which is behind a `&` reference [E0594]
`9`	`9`	`}`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ LL \| self.foo += 1;`
`7`	`7`	`help: consider changing this to be a mutable reference`
`8`	`8`	`\|`
`9`	`9`	`LL \| async fn bar(&mut self) {`
`10`		`- \| ~~~~~~~~~`
	`10`	`+ \| +++`
`11`	`11`
`12`	`12`	`error: aborting due to 1 previous error`
`13`	`13`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ LL \| let a16 = self.read_word() as u16;`
`41`	`41`	help: consider changing this to be a mutable reference in the `impl` method and the `trait` definition
`42`	`42`	`\|`
`43`	`43`	`LL \| extern "C" fn read_dword(&'_ mut self) -> u16 {`
`44`		`- \| ~~~~~~~~~~~~`
	`44`	`+ \| +++`
`45`	`45`
`46`	`46`	error[E0596]: cannot borrow `*self` as mutable, as it is behind a `&` reference
`47`	`47`	`--> $DIR/trait-impl-argument-difference-ice.rs:18:19`
`@@ -52,7 +52,7 @@ LL \| let b16 = self.read_word() as u16;`
`52`	`52`	help: consider changing this to be a mutable reference in the `impl` method and the `trait` definition
`53`	`53`	`\|`
`54`	`54`	`LL \| extern "C" fn read_dword(&'_ mut self) -> u16 {`
`55`		`- \| ~~~~~~~~~~~~`
	`55`	`+ \| +++`
`56`	`56`
`57`	`57`	`error: aborting due to 5 previous errors; 1 warning emitted`
`58`	`58`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ LL \| self.s.push('x');`
`7`	`7`	`help: consider changing this to be a mutable reference`
`8`	`8`	`\|`
`9`	`9`	`LL \| fn f(&mut self) {`
`10`		`- \| ~~~~~~~~~`
	`10`	`+ \| +++`
`11`	`11`
`12`	`12`	`error: aborting due to 1 previous error`
`13`	`13`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ LL \| self.how_hungry -= 5;`
`7`	`7`	`help: consider changing this to be a mutable reference`
`8`	`8`	`\|`
`9`	`9`	`LL \| pub fn eat(&mut self) {`
`10`		`- \| ~~~~~~~~~`
	`10`	`+ \| +++`
`11`	`11`
`12`	`12`	`error: aborting due to 1 previous error`
`13`	`13`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ struct X(usize);`
`3`	`3`	`impl X {`
`4`	`4`	`fn zap(&self) {`
`5`	`5`	`//~^ HELP`
`6`		`- //~\| SUGGESTION &mut self`
	`6`	`+ //~\| SUGGESTION mut`
`7`	`7`	`self.0 = 32;`
`8`	`8`	`//~^ ERROR`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ LL \| self.0 = 32;`
`7`	`7`	`help: consider changing this to be a mutable reference`
`8`	`8`	`\|`
`9`	`9`	`LL \| fn zap(&mut self) {`
`10`		`- \| ~~~~~~~~~`
	`10`	`+ \| +++`
`11`	`11`
`12`	`12`	error[E0594]: cannot assign to `*foo`, which is behind a `&` reference
`13`	`13`	`--> $DIR/suggest-ref-mut.rs:15:5`