3 use rustc_middle::hir::map::Map;
4 use rustc_middle::mir::{Mutability, Place, PlaceRef, ProjectionElem};
5 use rustc_middle::ty::{self, Ty, TyCtxt};
9 self, BindingForm, ClearCrossCrate, ImplicitSelfKind, Local, LocalDecl, LocalInfo,
13 use rustc_span::source_map::DesugaringKind;
14 use rustc_span::symbol::{kw, Symbol};
15 use rustc_span::{BytePos, Span};
17 use crate::diagnostics::BorrowedContentSource;
18 use crate::MirBorrowckCtxt;
19 use rustc_const_eval::util::collect_writes::FindAssignments;
20 use rustc_errors::{Applicability, DiagnosticBuilder};
22 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
23 pub(crate) enum AccessKind {
28 impl<'a, 'tcx> MirBorrowckCtxt<'a, 'tcx> {
29 pub(crate) fn report_mutability_error(
31 access_place: Place<'tcx>,
33 the_place_err: PlaceRef<'tcx>,
34 error_access: AccessKind,
38 "report_mutability_error(\
39 access_place={:?}, span={:?}, the_place_err={:?}, error_access={:?}, location={:?},\
41 access_place, span, the_place_err, error_access, location,
47 let mut opt_source = None;
48 let access_place_desc = self.describe_any_place(access_place.as_ref());
49 debug!("report_mutability_error: access_place_desc={:?}", access_place_desc);
52 PlaceRef { local, projection: [] } => {
53 item_msg = access_place_desc;
54 if access_place.as_local().is_some() {
55 reason = ", as it is not declared as mutable".to_string();
57 let name = self.local_names[local].expect("immutable unnamed local");
58 reason = format!(", as `{}` is not declared as mutable", name);
64 projection: [proj_base @ .., ProjectionElem::Field(upvar_index, _)],
66 debug_assert!(is_closure_or_generator(
67 Place::ty_from(local, proj_base, self.body, self.infcx.tcx).ty
70 let imm_borrow_derefed = self.upvars[upvar_index.index()]
74 .any(|ty| matches!(ty.kind(), ty::Ref(.., hir::Mutability::Not)));
76 // If the place is immutable then:
78 // - Either we deref an immutable ref to get to our final place.
79 // - We don't capture derefs of raw ptrs
80 // - Or the final place is immut because the root variable of the capture
81 // isn't marked mut and we should suggest that to the user.
82 if imm_borrow_derefed {
83 // If we deref an immutable ref then the suggestion here doesn't help.
86 item_msg = access_place_desc;
87 if self.is_upvar_field_projection(access_place.as_ref()).is_some() {
88 reason = ", as it is not declared as mutable".to_string();
90 let name = self.upvars[upvar_index.index()].place.to_string(self.infcx.tcx);
91 reason = format!(", as `{}` is not declared as mutable", name);
96 PlaceRef { local, projection: [ProjectionElem::Deref] }
97 if self.body.local_decls[local].is_ref_for_guard() =>
99 item_msg = access_place_desc;
100 reason = ", as it is immutable for the pattern guard".to_string();
102 PlaceRef { local, projection: [ProjectionElem::Deref] }
103 if self.body.local_decls[local].is_ref_to_static() =>
105 if access_place.projection.len() == 1 {
106 item_msg = format!("immutable static item {}", access_place_desc);
107 reason = String::new();
109 item_msg = access_place_desc;
110 let local_info = &self.body.local_decls[local].local_info;
111 if let Some(box LocalInfo::StaticRef { def_id, .. }) = *local_info {
112 let static_name = &self.infcx.tcx.item_name(def_id);
113 reason = format!(", as `{}` is an immutable static item", static_name);
115 bug!("is_ref_to_static return true, but not ref to static?");
119 PlaceRef { local: _, projection: [proj_base @ .., ProjectionElem::Deref] } => {
120 if the_place_err.local == ty::CAPTURE_STRUCT_LOCAL
121 && proj_base.is_empty()
122 && !self.upvars.is_empty()
124 item_msg = access_place_desc;
126 self.body.local_decls[ty::CAPTURE_STRUCT_LOCAL].ty.is_region_ptr()
128 debug_assert!(is_closure_or_generator(
131 the_place_err.projection,
138 reason = if self.is_upvar_field_projection(access_place.as_ref()).is_some() {
139 ", as it is a captured variable in a `Fn` closure".to_string()
141 ", as `Fn` closures cannot mutate their captured variables".to_string()
144 let source = self.borrowed_content_source(PlaceRef {
145 local: the_place_err.local,
146 projection: proj_base,
148 let pointer_type = source.describe_for_immutable_place(self.infcx.tcx);
149 opt_source = Some(source);
150 if let Some(desc) = self.describe_place(access_place.as_ref()) {
151 item_msg = format!("`{}`", desc);
152 reason = match error_access {
153 AccessKind::Mutate => format!(", which is behind {}", pointer_type),
154 AccessKind::MutableBorrow => {
155 format!(", as it is behind {}", pointer_type)
159 item_msg = format!("data in {}", pointer_type);
160 reason = String::new();
170 ProjectionElem::Index(_)
171 | ProjectionElem::ConstantIndex { .. }
172 | ProjectionElem::Subslice { .. }
173 | ProjectionElem::Downcast(..),
175 } => bug!("Unexpected immutable place."),
178 debug!("report_mutability_error: item_msg={:?}, reason={:?}", item_msg, reason);
180 // `act` and `acted_on` are strings that let us abstract over
181 // the verbs used in some diagnostic messages.
185 let span = match error_access {
186 AccessKind::Mutate => {
187 err = self.cannot_assign(span, &(item_msg + &reason));
189 acted_on = "written";
192 AccessKind::MutableBorrow => {
193 act = "borrow as mutable";
194 acted_on = "borrowed as mutable";
196 let borrow_spans = self.borrow_spans(span, location);
197 let borrow_span = borrow_spans.args_or_use();
198 err = self.cannot_borrow_path_as_mutable_because(borrow_span, &item_msg, &reason);
199 borrow_spans.var_span_label(
202 "mutable borrow occurs due to use of {} in closure",
203 self.describe_any_place(access_place.as_ref()),
211 debug!("report_mutability_error: act={:?}, acted_on={:?}", act, acted_on);
213 match the_place_err {
214 // Suggest making an existing shared borrow in a struct definition a mutable borrow.
216 // This is applicable when we have a deref of a field access to a deref of a local -
217 // something like `*((*_1).0`. The local that we get will be a reference to the
218 // struct we've got a field access of (it must be a reference since there's a deref
219 // after the field access).
225 ProjectionElem::Deref,
226 ProjectionElem::Field(field, _),
227 ProjectionElem::Deref,
230 err.span_label(span, format!("cannot {ACT}", ACT = act));
232 if let Some(span) = get_mut_span_in_struct_field(
234 Place::ty_from(local, proj_base, self.body, self.infcx.tcx).ty,
237 err.span_suggestion_verbose(
239 "consider changing this to be mutable",
241 Applicability::MaybeIncorrect,
246 // Suggest removing a `&mut` from the use of a mutable reference.
247 PlaceRef { local, projection: [] }
252 .map(|l| mut_borrow_of_mutable_ref(l, self.local_names[local]))
255 let decl = &self.body.local_decls[local];
256 err.span_label(span, format!("cannot {ACT}", ACT = act));
257 if let Some(mir::Statement {
260 mir::StatementKind::Assign(box (
264 mir::BorrowKind::Mut { allow_two_phase_borrow: false },
269 }) = &self.body[location.block].statements.get(location.statement_index)
271 match decl.local_info {
272 Some(box LocalInfo::User(ClearCrossCrate::Set(BindingForm::Var(
273 mir::VarBindingForm {
274 binding_mode: ty::BindingMode::BindByValue(Mutability::Not),
275 opt_ty_info: Some(sp),
280 err.span_note(sp, "the binding is already a mutable borrow");
284 decl.source_info.span,
285 "the binding is already a mutable borrow",
290 self.infcx.tcx.sess.source_map().span_to_snippet(source_info.span)
292 if snippet.starts_with("&mut ") {
293 // We don't have access to the HIR to get accurate spans, but we can
294 // give a best effort structured suggestion.
295 err.span_suggestion_verbose(
296 source_info.span.with_hi(source_info.span.lo() + BytePos(5)),
297 "try removing `&mut` here",
299 Applicability::MachineApplicable,
302 // This can occur with things like `(&mut self).foo()`.
303 err.span_help(source_info.span, "try removing `&mut` here");
306 err.span_help(source_info.span, "try removing `&mut` here");
308 } else if decl.mutability == Mutability::Not
311 Some(box LocalInfo::User(ClearCrossCrate::Set(BindingForm::ImplicitSelf(
312 ImplicitSelfKind::MutRef
316 err.span_suggestion_verbose(
317 decl.source_info.span.shrink_to_lo(),
318 "consider making the binding mutable",
320 Applicability::MachineApplicable,
325 // We want to suggest users use `let mut` for local (user
326 // variable) mutations...
327 PlaceRef { local, projection: [] }
328 if self.body.local_decls[local].can_be_made_mutable() =>
330 // ... but it doesn't make sense to suggest it on
331 // variables that are `ref x`, `ref mut x`, `&self`,
332 // or `&mut self` (such variables are simply not
334 let local_decl = &self.body.local_decls[local];
335 assert_eq!(local_decl.mutability, Mutability::Not);
337 err.span_label(span, format!("cannot {ACT}", ACT = act));
339 local_decl.source_info.span,
340 "consider changing this to be mutable",
341 format!("mut {}", self.local_names[local].unwrap()),
342 Applicability::MachineApplicable,
344 let tcx = self.infcx.tcx;
345 if let ty::Closure(id, _) = the_place_err.ty(self.body, tcx).ty.kind() {
346 self.show_mutating_upvar(tcx, id, the_place_err, &mut err);
350 // Also suggest adding mut for upvars
353 projection: [proj_base @ .., ProjectionElem::Field(upvar_index, _)],
355 debug_assert!(is_closure_or_generator(
356 Place::ty_from(local, proj_base, self.body, self.infcx.tcx).ty
359 let captured_place = &self.upvars[upvar_index.index()].place;
361 err.span_label(span, format!("cannot {ACT}", ACT = act));
363 let upvar_hir_id = captured_place.get_root_variable();
365 if let Some(Node::Binding(pat)) = self.infcx.tcx.hir().find(upvar_hir_id) {
366 if let hir::PatKind::Binding(
367 hir::BindingAnnotation::Unannotated,
375 "consider changing this to be mutable",
376 format!("mut {}", upvar_ident.name),
377 Applicability::MachineApplicable,
382 let tcx = self.infcx.tcx;
383 if let ty::Ref(_, ty, Mutability::Mut) = the_place_err.ty(self.body, tcx).ty.kind()
385 if let ty::Closure(id, _) = ty.kind() {
386 self.show_mutating_upvar(tcx, id, the_place_err, &mut err);
391 // complete hack to approximate old AST-borrowck
392 // diagnostic: if the span starts with a mutable borrow of
393 // a local variable, then just suggest the user remove it.
394 PlaceRef { local: _, projection: [] }
396 if let Ok(snippet) = self.infcx.tcx.sess.source_map().span_to_snippet(span) {
397 snippet.starts_with("&mut ")
403 err.span_label(span, format!("cannot {ACT}", ACT = act));
406 "try removing `&mut` here",
408 Applicability::MaybeIncorrect,
412 PlaceRef { local, projection: [ProjectionElem::Deref] }
413 if self.body.local_decls[local].is_ref_for_guard() =>
415 err.span_label(span, format!("cannot {ACT}", ACT = act));
417 "variables bound in patterns are immutable until the end of the pattern guard",
421 // We want to point out when a `&` can be readily replaced
424 // FIXME: can this case be generalized to work for an
425 // arbitrary base for the projection?
426 PlaceRef { local, projection: [ProjectionElem::Deref] }
427 if self.body.local_decls[local].is_user_variable() =>
429 let local_decl = &self.body.local_decls[local];
431 let (pointer_sigil, pointer_desc) = if local_decl.ty.is_region_ptr() {
434 ("*const", "pointer")
437 match self.local_names[local] {
438 Some(name) if !local_decl.from_compiler_desugaring() => {
439 let label = match local_decl.local_info.as_ref().unwrap() {
440 box LocalInfo::User(ClearCrossCrate::Set(
441 mir::BindingForm::ImplicitSelf(_),
443 let (span, suggestion) =
444 suggest_ampmut_self(self.infcx.tcx, local_decl);
445 Some((true, span, suggestion))
448 box LocalInfo::User(ClearCrossCrate::Set(mir::BindingForm::Var(
449 mir::VarBindingForm {
450 binding_mode: ty::BindingMode::BindByValue(_),
455 // check if the RHS is from desugaring
456 let opt_assignment_rhs_span =
457 self.body.find_assignments(local).first().map(|&location| {
458 if let Some(mir::Statement {
461 mir::StatementKind::Assign(box (
463 mir::Rvalue::Use(mir::Operand::Copy(place)),
465 }) = self.body[location.block]
467 .get(location.statement_index)
469 self.body.local_decls[place.local].source_info.span
471 self.body.source_info(location).span
474 match opt_assignment_rhs_span.and_then(|s| s.desugaring_kind()) {
475 // on for loops, RHS points to the iterator part
476 Some(DesugaringKind::ForLoop) => {
477 self.suggest_similar_mut_method_for_for_loop(&mut err);
480 opt_assignment_rhs_span.unwrap(),
482 "this iterator yields `{SIGIL}` {DESC}s",
483 SIGIL = pointer_sigil,
488 // don't create labels for compiler-generated spans
491 let (span, suggestion) = if name != kw::SelfLower {
495 opt_assignment_rhs_span,
499 match local_decl.local_info.as_deref() {
500 Some(LocalInfo::User(ClearCrossCrate::Set(
501 mir::BindingForm::Var(mir::VarBindingForm {
506 suggest_ampmut_self(self.infcx.tcx, local_decl)
508 // explicit self (eg `self: &'a Self`)
512 opt_assignment_rhs_span,
517 Some((true, span, suggestion))
522 box LocalInfo::User(ClearCrossCrate::Set(mir::BindingForm::Var(
523 mir::VarBindingForm {
524 binding_mode: ty::BindingMode::BindByReference(_),
528 let pattern_span = local_decl.source_info.span;
529 suggest_ref_mut(self.infcx.tcx, pattern_span)
530 .map(|replacement| (true, pattern_span, replacement))
533 box LocalInfo::User(ClearCrossCrate::Clear) => {
534 bug!("saw cleared local state")
541 Some((true, err_help_span, suggested_code)) => {
542 let (is_trait_sig, local_trait) = self.is_error_in_trait(local);
547 "consider changing this to be a mutable {}",
551 Applicability::MachineApplicable,
553 } else if let Some(x) = local_trait {
557 "consider changing that to be a mutable {}",
561 Applicability::MachineApplicable,
565 Some((false, err_label_span, message)) => {
566 err.span_label(err_label_span, &message);
573 "`{NAME}` is a `{SIGIL}` {DESC}, \
574 so the data it refers to cannot be {ACTED_ON}",
576 SIGIL = pointer_sigil,
586 "cannot {ACT} through `{SIGIL}` {DESC}",
588 SIGIL = pointer_sigil,
596 PlaceRef { local, projection: [ProjectionElem::Deref] }
597 if local == ty::CAPTURE_STRUCT_LOCAL && !self.upvars.is_empty() =>
599 self.expected_fn_found_fn_mut_call(&mut err, span, act);
602 PlaceRef { local: _, projection: [.., ProjectionElem::Deref] } => {
603 err.span_label(span, format!("cannot {ACT}", ACT = act));
606 Some(BorrowedContentSource::OverloadedDeref(ty)) => {
608 "trait `DerefMut` is required to modify through a dereference, \
609 but it is not implemented for `{}`",
613 Some(BorrowedContentSource::OverloadedIndex(ty)) => {
615 "trait `IndexMut` is required to modify indexed content, \
616 but it is not implemented for `{}`",
625 err.span_label(span, format!("cannot {ACT}", ACT = act));
629 self.buffer_error(err);
632 /// User cannot make signature of a trait mutable without changing the
633 /// trait. So we find if this error belongs to a trait and if so we move
634 /// suggestion to the trait or disable it if it is out of scope of this crate
635 fn is_error_in_trait(&self, local: Local) -> (bool, Option<Span>) {
636 if self.body.local_kind(local) != LocalKind::Arg {
637 return (false, None);
639 let hir_map = self.infcx.tcx.hir();
640 let my_def = self.body.source.def_id();
641 let my_hir = hir_map.local_def_id_to_hir_id(my_def.as_local().unwrap());
643 self.infcx.tcx.impl_of_method(my_def).and_then(|x| self.infcx.tcx.trait_id_of_impl(x))
645 return (false, None);
649 td.as_local().and_then(|tld| match hir_map.find_by_def_id(tld) {
650 Some(Node::Item(hir::Item {
651 kind: hir::ItemKind::Trait(_, _, _, _, items),
654 let mut f_in_trait_opt = None;
655 for hir::TraitItemRef { id: fi, kind: k, .. } in *items {
656 let hi = fi.hir_id();
657 if !matches!(k, hir::AssocItemKind::Fn { .. }) {
660 if hir_map.name(hi) != hir_map.name(my_hir) {
663 f_in_trait_opt = Some(hi);
666 f_in_trait_opt.and_then(|f_in_trait| match hir_map.find(f_in_trait) {
667 Some(Node::TraitItem(hir::TraitItem {
669 hir::TraitItemKind::Fn(
670 hir::FnSig { decl: hir::FnDecl { inputs, .. }, .. },
675 let hir::Ty { span, .. } = inputs[local.index() - 1];
686 // point to span of upvar making closure call require mutable borrow
687 fn show_mutating_upvar(
690 id: &hir::def_id::DefId,
691 the_place_err: PlaceRef<'tcx>,
692 err: &mut DiagnosticBuilder<'_>,
694 let closure_local_def_id = id.expect_local();
695 let tables = tcx.typeck(closure_local_def_id);
696 let closure_hir_id = tcx.hir().local_def_id_to_hir_id(closure_local_def_id);
697 if let Some((span, closure_kind_origin)) =
698 &tables.closure_kind_origins().get(closure_hir_id)
700 let reason = if let PlaceBase::Upvar(upvar_id) = closure_kind_origin.base {
701 let upvar = ty::place_to_string_for_capture(tcx, closure_kind_origin);
702 let root_hir_id = upvar_id.var_path.hir_id;
703 // we have an origin for this closure kind starting at this root variable so it's safe to unwrap here
704 let captured_places = tables.closure_min_captures[id].get(&root_hir_id).unwrap();
706 let origin_projection = closure_kind_origin
709 .map(|proj| proj.kind)
710 .collect::<Vec<_>>();
711 let mut capture_reason = String::new();
712 for captured_place in captured_places {
713 let captured_place_kinds = captured_place
717 .map(|proj| proj.kind)
718 .collect::<Vec<_>>();
719 if rustc_middle::ty::is_ancestor_or_same_capture(
720 &captured_place_kinds,
723 match captured_place.info.capture_kind {
724 ty::UpvarCapture::ByRef(
725 ty::BorrowKind::MutBorrow | ty::BorrowKind::UniqueImmBorrow,
727 capture_reason = format!("mutable borrow of `{}`", upvar);
729 ty::UpvarCapture::ByValue => {
730 capture_reason = format!("possible mutation of `{}`", upvar);
732 _ => bug!("upvar `{}` borrowed, but not mutably", upvar),
737 if capture_reason.is_empty() {
738 bug!("upvar `{}` borrowed, but cannot find reason", upvar);
747 "calling `{}` requires mutable binding due to {}",
748 self.describe_place(the_place_err).unwrap(),
755 // Attempt to search similar mutable associated items for suggestion.
756 // In the future, attempt in all path but initially for RHS of for_loop
757 fn suggest_similar_mut_method_for_for_loop(&self, err: &mut DiagnosticBuilder<'_>) {
760 ExprKind::{Block, Call, DropTemps, Match, MethodCall},
761 HirId, ImplItem, ImplItemKind, Item, ItemKind,
764 fn maybe_body_id_of_fn(hir_map: Map<'_>, id: HirId) -> Option<BodyId> {
765 match hir_map.find(id) {
766 Some(Node::Item(Item { kind: ItemKind::Fn(_, _, body_id), .. }))
767 | Some(Node::ImplItem(ImplItem { kind: ImplItemKind::Fn(_, body_id), .. })) => {
773 let hir_map = self.infcx.tcx.hir();
774 let mir_body_hir_id = self.mir_hir_id();
775 if let Some(fn_body_id) = maybe_body_id_of_fn(hir_map, mir_body_hir_id) {
790 kind: MethodCall(path_segment, ..),
808 ) = hir_map.body(fn_body_id).value.kind
810 let opt_suggestions = path_segment
812 .map(|path_hir_id| self.infcx.tcx.typeck(path_hir_id.owner))
813 .and_then(|typeck| typeck.type_dependent_def_id(*hir_id))
814 .and_then(|def_id| self.infcx.tcx.impl_of_method(def_id))
815 .map(|def_id| self.infcx.tcx.associated_items(def_id))
818 .in_definition_order()
819 .map(|assoc_item_def| assoc_item_def.ident(self.infcx.tcx))
821 let original_method_ident = path_segment.ident;
822 original_method_ident != ident
825 .starts_with(&original_method_ident.name.to_string())
827 .map(|ident| format!("{}()", ident))
831 if let Some(mut suggestions) = opt_suggestions {
832 if suggestions.peek().is_some() {
833 err.span_suggestions(
834 path_segment.ident.span,
835 "use mutable method",
837 Applicability::MaybeIncorrect,
845 /// Targeted error when encountering an `FnMut` closure where an `Fn` closure was expected.
846 fn expected_fn_found_fn_mut_call(&self, err: &mut DiagnosticBuilder<'_>, sp: Span, act: &str) {
847 err.span_label(sp, format!("cannot {}", act));
849 let hir = self.infcx.tcx.hir();
850 let closure_id = self.mir_hir_id();
851 let fn_call_id = hir.get_parent_node(closure_id);
852 let node = hir.get(fn_call_id);
853 let item_id = hir.enclosing_body_owner(fn_call_id);
854 let mut look_at_return = true;
855 // If we can detect the expression to be an `fn` call where the closure was an argument,
856 // we point at the `fn` definition argument...
857 if let hir::Node::Expr(hir::Expr { kind: hir::ExprKind::Call(func, args), .. }) = node {
861 .filter(|(_, arg)| arg.span == self.body.span)
864 let def_id = hir.local_def_id(item_id);
865 let tables = self.infcx.tcx.typeck(def_id);
866 if let Some(ty::FnDef(def_id, _)) =
867 tables.node_type_opt(func.hir_id).as_ref().map(|ty| ty.kind())
869 let arg = match hir.get_if_local(*def_id) {
871 hir::Node::Item(hir::Item {
872 ident, kind: hir::ItemKind::Fn(sig, ..), ..
874 | hir::Node::TraitItem(hir::TraitItem {
876 kind: hir::TraitItemKind::Fn(sig, _),
879 | hir::Node::ImplItem(hir::ImplItem {
881 kind: hir::ImplItemKind::Fn(sig, _),
888 pos + if sig.decl.implicit_self.has_implicit_self() {
896 .unwrap_or(ident.span),
900 if let Some(span) = arg {
901 err.span_label(span, "change this to accept `FnMut` instead of `Fn`");
902 err.span_label(func.span, "expects `Fn` instead of `FnMut`");
903 if self.infcx.tcx.sess.source_map().is_multiline(self.body.span) {
904 err.span_label(self.body.span, "in this closure");
906 look_at_return = false;
911 if look_at_return && hir.get_return_block(closure_id).is_some() {
912 // ...otherwise we are probably in the tail expression of the function, point at the
914 match hir.get_by_def_id(hir.get_parent_item(fn_call_id)) {
915 hir::Node::Item(hir::Item { ident, kind: hir::ItemKind::Fn(sig, ..), .. })
916 | hir::Node::TraitItem(hir::TraitItem {
918 kind: hir::TraitItemKind::Fn(sig, _),
921 | hir::Node::ImplItem(hir::ImplItem {
923 kind: hir::ImplItemKind::Fn(sig, _),
926 err.span_label(ident.span, "");
928 sig.decl.output.span(),
929 "change this to return `FnMut` instead of `Fn`",
931 err.span_label(self.body.span, "in this closure");
939 fn mut_borrow_of_mutable_ref(local_decl: &LocalDecl<'_>, local_name: Option<Symbol>) -> bool {
940 debug!("local_info: {:?}, ty.kind(): {:?}", local_decl.local_info, local_decl.ty.kind());
942 match local_decl.local_info.as_deref() {
943 // Check if mutably borrowing a mutable reference.
944 Some(LocalInfo::User(ClearCrossCrate::Set(mir::BindingForm::Var(
945 mir::VarBindingForm {
946 binding_mode: ty::BindingMode::BindByValue(Mutability::Not), ..
948 )))) => matches!(local_decl.ty.kind(), ty::Ref(_, _, hir::Mutability::Mut)),
949 Some(LocalInfo::User(ClearCrossCrate::Set(mir::BindingForm::ImplicitSelf(kind)))) => {
950 // Check if the user variable is a `&mut self` and we can therefore
951 // suggest removing the `&mut`.
953 // Deliberately fall into this case for all implicit self types,
954 // so that we don't fall in to the next case with them.
955 *kind == mir::ImplicitSelfKind::MutRef
957 _ if Some(kw::SelfLower) == local_name => {
958 // Otherwise, check if the name is the `self` keyword - in which case
959 // we have an explicit self. Do the same thing in this case and check
960 // for a `self: &mut Self` to suggest removing the `&mut`.
961 matches!(local_decl.ty.kind(), ty::Ref(_, _, hir::Mutability::Mut))
967 fn suggest_ampmut_self<'tcx>(
969 local_decl: &mir::LocalDecl<'tcx>,
970 ) -> (Span, String) {
971 let sp = local_decl.source_info.span;
974 match tcx.sess.source_map().span_to_snippet(sp) {
976 let lt_pos = snippet.find('\'');
977 if let Some(lt_pos) = lt_pos {
978 format!("&{}mut self", &snippet[lt_pos..snippet.len() - 4])
980 "&mut self".to_string()
983 _ => "&mut self".to_string(),
988 // When we want to suggest a user change a local variable to be a `&mut`, there
989 // are three potential "obvious" things to highlight:
991 // let ident [: Type] [= RightHandSideExpression];
992 // ^^^^^ ^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
995 // We can always fallback on highlighting the first. But chances are good that
996 // the user experience will be better if we highlight one of the others if possible;
997 // for example, if the RHS is present and the Type is not, then the type is going to
998 // be inferred *from* the RHS, which means we should highlight that (and suggest
999 // that they borrow the RHS mutably).
1001 // This implementation attempts to emulate AST-borrowck prioritization
1002 // by trying (3.), then (2.) and finally falling back on (1.).
1003 fn suggest_ampmut<'tcx>(
1005 local_decl: &mir::LocalDecl<'tcx>,
1006 opt_assignment_rhs_span: Option<Span>,
1007 opt_ty_info: Option<Span>,
1008 ) -> (Span, String) {
1009 if let Some(assignment_rhs_span) = opt_assignment_rhs_span {
1010 if let Ok(src) = tcx.sess.source_map().span_to_snippet(assignment_rhs_span) {
1011 let is_mutbl = |ty: &str| -> bool {
1012 if let Some(rest) = ty.strip_prefix("mut") {
1013 match rest.chars().next() {
1015 Some(c) if c.is_whitespace() => true,
1020 // e.g. `&mutablevar`
1027 if let (true, Some(ws_pos)) = (src.starts_with("&'"), src.find(char::is_whitespace)) {
1028 let lt_name = &src[1..ws_pos];
1029 let ty = src[ws_pos..].trim_start();
1031 return (assignment_rhs_span, format!("&{} mut {}", lt_name, ty));
1033 } else if let Some(stripped) = src.strip_prefix('&') {
1034 let stripped = stripped.trim_start();
1035 if !is_mutbl(stripped) {
1036 return (assignment_rhs_span, format!("&mut {}", stripped));
1042 let highlight_span = match opt_ty_info {
1043 // if this is a variable binding with an explicit type,
1044 // try to highlight that for the suggestion.
1045 Some(ty_span) => ty_span,
1047 // otherwise, just highlight the span associated with
1048 // the (MIR) LocalDecl.
1049 None => local_decl.source_info.span,
1052 if let Ok(src) = tcx.sess.source_map().span_to_snippet(highlight_span) {
1053 if let (true, Some(ws_pos)) = (src.starts_with("&'"), src.find(char::is_whitespace)) {
1054 let lt_name = &src[1..ws_pos];
1055 let ty = &src[ws_pos..];
1056 return (highlight_span, format!("&{} mut{}", lt_name, ty));
1060 let ty_mut = local_decl.ty.builtin_deref(true).unwrap();
1061 assert_eq!(ty_mut.mutbl, hir::Mutability::Not);
1064 if local_decl.ty.is_region_ptr() {
1065 format!("&mut {}", ty_mut.ty)
1067 format!("*mut {}", ty_mut.ty)
1072 fn is_closure_or_generator(ty: Ty<'_>) -> bool {
1073 ty.is_closure() || ty.is_generator()
1076 /// Given a field that needs to be mutable, returns a span where the " mut " could go.
1077 /// This function expects the local to be a reference to a struct in order to produce a span.
1080 /// LL | s: &'a String
1081 /// | ^^^ returns a span taking up the space here
1083 fn get_mut_span_in_struct_field<'tcx>(
1088 // Expect our local to be a reference to a struct of some kind.
1089 if let ty::Ref(_, ty, _) = ty.kind() {
1090 if let ty::Adt(def, _) = ty.kind() {
1091 let field = def.all_fields().nth(field.index())?;
1092 // Use the HIR types to construct the diagnostic message.
1093 let node = tcx.hir().find_by_def_id(field.did.as_local()?)?;
1094 // Now we're dealing with the actual struct that we're going to suggest a change to,
1095 // we can expect a field that is an immutable reference to a type.
1096 if let hir::Node::Field(field) = node {
1097 if let hir::TyKind::Rptr(lifetime, hir::MutTy { mutbl: hir::Mutability::Not, ty }) =
1100 return Some(lifetime.span.between(ty.span));
1109 /// If possible, suggest replacing `ref` with `ref mut`.
1110 fn suggest_ref_mut(tcx: TyCtxt<'_>, binding_span: Span) -> Option<String> {
1111 let hi_src = tcx.sess.source_map().span_to_snippet(binding_span).ok()?;
1112 if hi_src.starts_with("ref") && hi_src["ref".len()..].starts_with(rustc_lexer::is_whitespace) {
1113 let replacement = format!("ref mut{}", &hi_src["ref".len()..]);