1 use crate::check::FnCtxt;
2 use rustc_infer::infer::InferOk;
3 use rustc_trait_selection::infer::InferCtxtExt as _;
4 use rustc_trait_selection::traits::ObligationCause;
6 use rustc_ast::util::parser::PREC_POSTFIX;
7 use rustc_errors::{Applicability, Diagnostic, DiagnosticBuilder, ErrorGuaranteed};
9 use rustc_hir::lang_items::LangItem;
10 use rustc_hir::{is_range_literal, Node};
11 use rustc_middle::lint::in_external_macro;
12 use rustc_middle::ty::adjustment::AllowTwoPhase;
13 use rustc_middle::ty::error::{ExpectedFound, TypeError};
14 use rustc_middle::ty::print::with_no_trimmed_paths;
15 use rustc_middle::ty::{self, Article, AssocItem, Ty, TypeAndMut};
16 use rustc_span::symbol::{sym, Symbol};
17 use rustc_span::{BytePos, Span};
19 use super::method::probe;
23 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
24 pub fn emit_coerce_suggestions(
27 expr: &hir::Expr<'tcx>,
30 expected_ty_expr: Option<&'tcx hir::Expr<'tcx>>,
31 error: Option<TypeError<'tcx>>,
33 self.annotate_expected_due_to_let_ty(err, expr, error);
34 self.suggest_deref_ref_or_into(err, expr, expected, expr_ty, expected_ty_expr);
35 self.suggest_compatible_variants(err, expr, expected, expr_ty);
36 self.suggest_non_zero_new_unwrap(err, expr, expected, expr_ty);
37 if self.suggest_calling_boxed_future_when_appropriate(err, expr, expected, expr_ty) {
40 self.suggest_no_capture_closure(err, expected, expr_ty);
41 self.suggest_boxing_when_appropriate(err, expr, expected, expr_ty);
42 self.suggest_missing_parentheses(err, expr);
43 self.suggest_block_to_brackets_peeling_refs(err, expr, expr_ty, expected);
44 self.note_type_is_not_clone(err, expected, expr_ty, expr);
45 self.note_need_for_fn_pointer(err, expected, expr_ty);
46 self.note_internal_mutation_in_method(err, expr, expected, expr_ty);
47 self.report_closure_inferred_return_type(err, expected);
50 // Requires that the two types unify, and prints an error message if
52 pub fn demand_suptype(&self, sp: Span, expected: Ty<'tcx>, actual: Ty<'tcx>) {
53 if let Some(mut e) = self.demand_suptype_diag(sp, expected, actual) {
58 pub fn demand_suptype_diag(
63 ) -> Option<DiagnosticBuilder<'tcx, ErrorGuaranteed>> {
64 self.demand_suptype_with_origin(&self.misc(sp), expected, actual)
67 #[instrument(skip(self), level = "debug")]
68 pub fn demand_suptype_with_origin(
70 cause: &ObligationCause<'tcx>,
73 ) -> Option<DiagnosticBuilder<'tcx, ErrorGuaranteed>> {
74 match self.at(cause, self.param_env).sup(expected, actual) {
75 Ok(InferOk { obligations, value: () }) => {
76 self.register_predicates(obligations);
79 Err(e) => Some(self.report_mismatched_types(&cause, expected, actual, e)),
83 pub fn demand_eqtype(&self, sp: Span, expected: Ty<'tcx>, actual: Ty<'tcx>) {
84 if let Some(mut err) = self.demand_eqtype_diag(sp, expected, actual) {
89 pub fn demand_eqtype_diag(
94 ) -> Option<DiagnosticBuilder<'tcx, ErrorGuaranteed>> {
95 self.demand_eqtype_with_origin(&self.misc(sp), expected, actual)
98 pub fn demand_eqtype_with_origin(
100 cause: &ObligationCause<'tcx>,
103 ) -> Option<DiagnosticBuilder<'tcx, ErrorGuaranteed>> {
104 match self.at(cause, self.param_env).eq(expected, actual) {
105 Ok(InferOk { obligations, value: () }) => {
106 self.register_predicates(obligations);
109 Err(e) => Some(self.report_mismatched_types(cause, expected, actual, e)),
113 pub fn demand_coerce(
115 expr: &hir::Expr<'tcx>,
116 checked_ty: Ty<'tcx>,
118 expected_ty_expr: Option<&'tcx hir::Expr<'tcx>>,
119 allow_two_phase: AllowTwoPhase,
122 self.demand_coerce_diag(expr, checked_ty, expected, expected_ty_expr, allow_two_phase);
123 if let Some(mut err) = err {
129 /// Checks that the type of `expr` can be coerced to `expected`.
131 /// N.B., this code relies on `self.diverges` to be accurate. In particular, assignments to `!`
132 /// will be permitted if the diverges flag is currently "always".
133 #[tracing::instrument(level = "debug", skip(self, expr, expected_ty_expr, allow_two_phase))]
134 pub fn demand_coerce_diag(
136 expr: &hir::Expr<'tcx>,
137 checked_ty: Ty<'tcx>,
139 expected_ty_expr: Option<&'tcx hir::Expr<'tcx>>,
140 allow_two_phase: AllowTwoPhase,
141 ) -> (Ty<'tcx>, Option<DiagnosticBuilder<'tcx, ErrorGuaranteed>>) {
142 let expected = self.resolve_vars_with_obligations(expected);
144 let e = match self.try_coerce(expr, checked_ty, expected, allow_two_phase, None) {
145 Ok(ty) => return (ty, None),
149 self.set_tainted_by_errors();
150 let expr = expr.peel_drop_temps();
151 let cause = self.misc(expr.span);
152 let expr_ty = self.resolve_vars_with_obligations(checked_ty);
153 let mut err = self.report_mismatched_types(&cause, expected, expr_ty, e.clone());
155 let is_insufficiently_polymorphic =
156 matches!(e, TypeError::RegionsInsufficientlyPolymorphic(..));
158 // FIXME(#73154): For now, we do leak check when coercing function
159 // pointers in typeck, instead of only during borrowck. This can lead
160 // to these `RegionsInsufficientlyPolymorphic` errors that aren't helpful.
161 if !is_insufficiently_polymorphic {
162 self.emit_coerce_suggestions(
172 (expected, Some(err))
175 fn annotate_expected_due_to_let_ty(
177 err: &mut Diagnostic,
178 expr: &hir::Expr<'_>,
179 error: Option<TypeError<'_>>,
181 let parent = self.tcx.hir().get_parent_node(expr.hir_id);
182 match (self.tcx.hir().find(parent), error) {
183 (Some(hir::Node::Local(hir::Local { ty: Some(ty), init: Some(init), .. })), _)
184 if init.hir_id == expr.hir_id =>
186 // Point at `let` assignment type.
187 err.span_label(ty.span, "expected due to this");
190 Some(hir::Node::Expr(hir::Expr {
191 kind: hir::ExprKind::Assign(lhs, rhs, _), ..
193 Some(TypeError::Sorts(ExpectedFound { expected, .. })),
194 ) if rhs.hir_id == expr.hir_id && !expected.is_closure() => {
195 // We ignore closures explicitly because we already point at them elsewhere.
196 // Point at the assigned-to binding.
197 let mut primary_span = lhs.span;
198 let mut secondary_span = lhs.span;
199 let mut post_message = "";
201 hir::ExprKind::Path(hir::QPath::Resolved(
206 hir::def::DefKind::Static(_) | hir::def::DefKind::Const,
212 if let Some(hir::Node::Item(hir::Item {
214 kind: hir::ItemKind::Static(ty, ..) | hir::ItemKind::Const(ty, ..),
216 })) = self.tcx.hir().get_if_local(*def_id)
218 primary_span = ty.span;
219 secondary_span = ident.span;
220 post_message = " type";
223 hir::ExprKind::Path(hir::QPath::Resolved(
225 hir::Path { res: hir::def::Res::Local(hir_id), .. },
227 if let Some(hir::Node::Pat(pat)) = self.tcx.hir().find(*hir_id) {
228 let parent = self.tcx.hir().get_parent_node(pat.hir_id);
229 primary_span = pat.span;
230 secondary_span = pat.span;
231 match self.tcx.hir().find(parent) {
232 Some(hir::Node::Local(hir::Local { ty: Some(ty), .. })) => {
233 primary_span = ty.span;
234 post_message = " type";
236 Some(hir::Node::Local(hir::Local { init: Some(init), .. })) => {
237 primary_span = init.span;
238 post_message = " value";
240 Some(hir::Node::Param(hir::Param { ty_span, .. })) => {
241 primary_span = *ty_span;
242 post_message = " parameter type";
251 if primary_span != secondary_span
256 .is_multiline(secondary_span.shrink_to_hi().until(primary_span))
258 // We are pointing at the binding's type or initializer value, but it's pattern
259 // is in a different line, so we point at both.
260 err.span_label(secondary_span, "expected due to the type of this binding");
261 err.span_label(primary_span, &format!("expected due to this{post_message}"));
262 } else if post_message == "" {
263 // We are pointing at either the assignment lhs or the binding def pattern.
264 err.span_label(primary_span, "expected due to the type of this binding");
266 // We are pointing at the binding's type or initializer value.
267 err.span_label(primary_span, &format!("expected due to this{post_message}"));
270 if !lhs.is_syntactic_place_expr() {
271 // We already emitted E0070 "invalid left-hand side of assignment", so we
273 err.downgrade_to_delayed_bug();
280 /// If the expected type is an enum (Issue #55250) with any variants whose
281 /// sole field is of the found type, suggest such variants. (Issue #42764)
282 fn suggest_compatible_variants(
284 err: &mut Diagnostic,
285 expr: &hir::Expr<'_>,
289 if let ty::Adt(expected_adt, substs) = expected.kind() {
290 if let hir::ExprKind::Field(base, ident) = expr.kind {
291 let base_ty = self.typeck_results.borrow().expr_ty(base);
292 if self.can_eq(self.param_env, base_ty, expected).is_ok()
293 && let Some(base_span) = base.span.find_ancestor_inside(expr.span)
295 err.span_suggestion_verbose(
296 expr.span.with_lo(base_span.hi()),
297 format!("consider removing the tuple struct field `{ident}`"),
299 Applicability::MaybeIncorrect,
305 // If the expression is of type () and it's the return expression of a block,
306 // we suggest adding a separate return expression instead.
307 // (To avoid things like suggesting `Ok(while .. { .. })`.)
308 if expr_ty.is_unit() {
309 let mut id = expr.hir_id;
312 // Unroll desugaring, to make sure this works for `for` loops etc.
314 parent = self.tcx.hir().get_parent_node(id);
315 if let Some(parent_span) = self.tcx.hir().opt_span(parent) {
316 if parent_span.find_ancestor_inside(expr.span).is_some() {
317 // The parent node is part of the same span, so is the result of the
318 // same expansion/desugaring and not the 'real' parent node.
326 if let Some(hir::Node::Block(&hir::Block {
327 span: block_span, expr: Some(e), ..
328 })) = self.tcx.hir().find(parent)
331 if let Some(span) = expr.span.find_ancestor_inside(block_span) {
332 let return_suggestions = if self
334 .is_diagnostic_item(sym::Result, expected_adt.did())
337 } else if self.tcx.is_diagnostic_item(sym::Option, expected_adt.did()) {
338 vec!["None", "Some(())"]
342 if let Some(indent) =
343 self.tcx.sess.source_map().indentation_before(span.shrink_to_lo())
345 // Add a semicolon, except after `}`.
347 match self.tcx.sess.source_map().span_to_snippet(span) {
348 Ok(s) if s.ends_with('}') => "",
351 err.span_suggestions(
353 "try adding an expression at the end of the block",
356 .map(|r| format!("{semicolon}\n{indent}{r}")),
357 Applicability::MaybeIncorrect,
366 let compatible_variants: Vec<(String, Option<String>)> = expected_adt
370 variant.fields.len() == 1 && variant.ctor_kind == hir::def::CtorKind::Fn
372 .filter_map(|variant| {
373 let sole_field = &variant.fields[0];
375 let field_is_local = sole_field.did.is_local();
376 let field_is_accessible =
377 sole_field.vis.is_accessible_from(expr.hir_id.owner.to_def_id(), self.tcx);
379 if !field_is_local && !field_is_accessible {
383 let note_about_variant_field_privacy = (field_is_local && !field_is_accessible)
384 .then(|| format!(" (its field is private, but it's local to this crate and its privacy can be changed)"));
386 let sole_field_ty = sole_field.ty(self.tcx, substs);
387 if self.can_coerce(expr_ty, sole_field_ty) {
389 with_no_trimmed_paths!(self.tcx.def_path_str(variant.def_id));
390 // FIXME #56861: DRYer prelude filtering
391 if let Some(path) = variant_path.strip_prefix("std::prelude::")
392 && let Some((_, path)) = path.split_once("::")
394 return Some((path.to_string(), note_about_variant_field_privacy));
396 Some((variant_path, note_about_variant_field_privacy))
403 let prefix = match self.maybe_get_struct_pattern_shorthand_field(expr) {
404 Some(ident) => format!("{ident}: "),
405 None => String::new(),
408 match &compatible_variants[..] {
409 [] => { /* No variants to format */ }
410 [(variant, note)] => {
411 // Just a single matching variant.
412 err.multipart_suggestion_verbose(
414 "try wrapping the expression in `{variant}`{note}",
415 note = note.as_deref().unwrap_or("")
418 (expr.span.shrink_to_lo(), format!("{prefix}{variant}(")),
419 (expr.span.shrink_to_hi(), ")".to_string()),
421 Applicability::MaybeIncorrect,
425 // More than one matching variant.
426 err.multipart_suggestions(
428 "try wrapping the expression in a variant of `{}`",
429 self.tcx.def_path_str(expected_adt.did())
431 compatible_variants.into_iter().map(|(variant, _)| {
433 (expr.span.shrink_to_lo(), format!("{prefix}{variant}(")),
434 (expr.span.shrink_to_hi(), ")".to_string()),
437 Applicability::MaybeIncorrect,
444 fn suggest_non_zero_new_unwrap(
446 err: &mut Diagnostic,
447 expr: &hir::Expr<'_>,
452 let (adt, unwrap) = match expected.kind() {
453 // In case Option<NonZero*> is wanted, but * is provided, suggest calling new
454 ty::Adt(adt, substs) if tcx.is_diagnostic_item(sym::Option, adt.did()) => {
456 let ty::Adt(adt, _) = substs.type_at(0).kind() else { return };
460 // In case NonZero* is wanted, but * is provided also add `.unwrap()` to satisfy types
461 ty::Adt(adt, _) => (adt, ".unwrap()"),
466 (sym::NonZeroU8, tcx.types.u8),
467 (sym::NonZeroU16, tcx.types.u16),
468 (sym::NonZeroU32, tcx.types.u32),
469 (sym::NonZeroU64, tcx.types.u64),
470 (sym::NonZeroU128, tcx.types.u128),
471 (sym::NonZeroI8, tcx.types.i8),
472 (sym::NonZeroI16, tcx.types.i16),
473 (sym::NonZeroI32, tcx.types.i32),
474 (sym::NonZeroI64, tcx.types.i64),
475 (sym::NonZeroI128, tcx.types.i128),
478 let Some((s, _)) = map
480 .find(|&&(s, t)| self.tcx.is_diagnostic_item(s, adt.did()) && self.can_coerce(expr_ty, t))
483 let path = self.tcx.def_path_str(adt.non_enum_variant().def_id);
485 err.multipart_suggestion(
486 format!("consider calling `{s}::new`"),
488 (expr.span.shrink_to_lo(), format!("{path}::new(")),
489 (expr.span.shrink_to_hi(), format!("){unwrap}")),
491 Applicability::MaybeIncorrect,
495 pub fn get_conversion_methods(
499 checked_ty: Ty<'tcx>,
501 ) -> Vec<AssocItem> {
503 self.probe_for_return_type(span, probe::Mode::MethodCall, expected, checked_ty, hir_id);
505 self.has_only_self_parameter(m)
508 // This special internal attribute is used to permit
509 // "identity-like" conversion methods to be suggested here.
511 // FIXME (#46459 and #46460): ideally
512 // `std::convert::Into::into` and `std::borrow:ToOwned` would
513 // also be `#[rustc_conversion_suggestion]`, if not for
514 // method-probing false-positives and -negatives (respectively).
516 // FIXME? Other potential candidate methods: `as_ref` and
518 .has_attr(m.def_id, sym::rustc_conversion_suggestion)
524 /// This function checks whether the method is not static and does not accept other parameters than `self`.
525 fn has_only_self_parameter(&self, method: &AssocItem) -> bool {
527 ty::AssocKind::Fn => {
528 method.fn_has_self_parameter
529 && self.tcx.fn_sig(method.def_id).inputs().skip_binder().len() == 1
535 /// Identify some cases where `as_ref()` would be appropriate and suggest it.
537 /// Given the following code:
538 /// ```compile_fail,E0308
540 /// fn takes_ref(_: &Foo) {}
541 /// let ref opt = Some(Foo);
543 /// opt.map(|param| takes_ref(param));
545 /// Suggest using `opt.as_ref().map(|param| takes_ref(param));` instead.
547 /// It only checks for `Option` and `Result` and won't work with
548 /// ```ignore (illustrative)
549 /// opt.map(|param| { takes_ref(param) });
551 fn can_use_as_ref(&self, expr: &hir::Expr<'_>) -> Option<(Span, &'static str, String)> {
552 let hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) = expr.kind else {
556 let hir::def::Res::Local(local_id) = path.res else {
560 let local_parent = self.tcx.hir().get_parent_node(local_id);
561 let Some(Node::Param(hir::Param { hir_id: param_hir_id, .. })) = self.tcx.hir().find(local_parent) else {
565 let param_parent = self.tcx.hir().get_parent_node(*param_hir_id);
566 let Some(Node::Expr(hir::Expr {
568 kind: hir::ExprKind::Closure(hir::Closure { fn_decl: closure_fn_decl, .. }),
570 })) = self.tcx.hir().find(param_parent) else {
574 let expr_parent = self.tcx.hir().get_parent_node(*expr_hir_id);
575 let hir = self.tcx.hir().find(expr_parent);
576 let closure_params_len = closure_fn_decl.inputs.len();
578 Some(Node::Expr(hir::Expr {
579 kind: hir::ExprKind::MethodCall(method_path, method_expr, _),
583 ) = (hir, closure_params_len) else {
587 let self_ty = self.typeck_results.borrow().expr_ty(&method_expr[0]);
588 let self_ty = format!("{:?}", self_ty);
589 let name = method_path.ident.name;
590 let is_as_ref_able = (self_ty.starts_with("&std::option::Option")
591 || self_ty.starts_with("&std::result::Result")
592 || self_ty.starts_with("std::option::Option")
593 || self_ty.starts_with("std::result::Result"))
594 && (name == sym::map || name == sym::and_then);
595 match (is_as_ref_able, self.sess().source_map().span_to_snippet(method_path.ident.span)) {
597 let suggestion = format!("as_ref().{}", src);
598 Some((method_path.ident.span, "consider using `as_ref` instead", suggestion))
604 pub(crate) fn maybe_get_struct_pattern_shorthand_field(
606 expr: &hir::Expr<'_>,
607 ) -> Option<Symbol> {
608 let hir = self.tcx.hir();
609 let local = match expr {
612 hir::ExprKind::Path(hir::QPath::Resolved(
615 res: hir::def::Res::Local(_),
616 segments: [hir::PathSegment { ident, .. }],
625 match hir.find(hir.get_parent_node(expr.hir_id))? {
626 Node::Expr(hir::Expr { kind: hir::ExprKind::Struct(_, fields, ..), .. }) => {
627 for field in *fields {
628 if field.ident.name == local.name && field.is_shorthand {
629 return Some(local.name);
639 /// If the given `HirId` corresponds to a block with a trailing expression, return that expression
640 pub(crate) fn maybe_get_block_expr(
642 expr: &hir::Expr<'tcx>,
643 ) -> Option<&'tcx hir::Expr<'tcx>> {
645 hir::Expr { kind: hir::ExprKind::Block(block, ..), .. } => block.expr,
650 /// Returns whether the given expression is an `else if`.
651 pub(crate) fn is_else_if_block(&self, expr: &hir::Expr<'_>) -> bool {
652 if let hir::ExprKind::If(..) = expr.kind {
653 let parent_id = self.tcx.hir().get_parent_node(expr.hir_id);
654 if let Some(Node::Expr(hir::Expr {
655 kind: hir::ExprKind::If(_, _, Some(else_expr)),
657 })) = self.tcx.hir().find(parent_id)
659 return else_expr.hir_id == expr.hir_id;
665 /// This function is used to determine potential "simple" improvements or users' errors and
666 /// provide them useful help. For example:
668 /// ```compile_fail,E0308
669 /// fn some_fn(s: &str) {}
671 /// let x = "hey!".to_owned();
672 /// some_fn(x); // error
675 /// No need to find every potential function which could make a coercion to transform a
676 /// `String` into a `&str` since a `&` would do the trick!
678 /// In addition of this check, it also checks between references mutability state. If the
679 /// expected is mutable but the provided isn't, maybe we could just say "Hey, try with
683 expr: &hir::Expr<'tcx>,
684 checked_ty: Ty<'tcx>,
686 ) -> Option<(Span, String, String, Applicability, bool /* verbose */)> {
687 let sess = self.sess();
690 // If the span is from an external macro, there's no suggestion we can make.
691 if in_external_macro(sess, sp) {
695 let sm = sess.source_map();
697 let replace_prefix = |s: &str, old: &str, new: &str| {
698 s.strip_prefix(old).map(|stripped| new.to_string() + stripped)
701 // `ExprKind::DropTemps` is semantically irrelevant for these suggestions.
702 let expr = expr.peel_drop_temps();
704 match (&expr.kind, expected.kind(), checked_ty.kind()) {
705 (_, &ty::Ref(_, exp, _), &ty::Ref(_, check, _)) => match (exp.kind(), check.kind()) {
706 (&ty::Str, &ty::Array(arr, _) | &ty::Slice(arr)) if arr == self.tcx.types.u8 => {
707 if let hir::ExprKind::Lit(_) = expr.kind
708 && let Ok(src) = sm.span_to_snippet(sp)
709 && replace_prefix(&src, "b\"", "\"").is_some()
711 let pos = sp.lo() + BytePos(1);
714 "consider removing the leading `b`".to_string(),
716 Applicability::MachineApplicable,
721 (&ty::Array(arr, _) | &ty::Slice(arr), &ty::Str) if arr == self.tcx.types.u8 => {
722 if let hir::ExprKind::Lit(_) = expr.kind
723 && let Ok(src) = sm.span_to_snippet(sp)
724 && replace_prefix(&src, "\"", "b\"").is_some()
728 "consider adding a leading `b`".to_string(),
730 Applicability::MachineApplicable,
737 (_, &ty::Ref(_, _, mutability), _) => {
738 // Check if it can work when put into a ref. For example:
741 // fn bar(x: &mut i32) {}
744 // bar(&x); // error, expected &mut
746 let ref_ty = match mutability {
747 hir::Mutability::Mut => {
748 self.tcx.mk_mut_ref(self.tcx.mk_region(ty::ReStatic), checked_ty)
750 hir::Mutability::Not => {
751 self.tcx.mk_imm_ref(self.tcx.mk_region(ty::ReStatic), checked_ty)
754 if self.can_coerce(ref_ty, expected) {
755 let mut sugg_sp = sp;
756 if let hir::ExprKind::MethodCall(ref segment, ref args, _) = expr.kind {
758 self.tcx.require_lang_item(LangItem::Clone, Some(segment.ident.span));
759 if let ([arg], Some(true), sym::clone) = (
761 self.typeck_results.borrow().type_dependent_def_id(expr.hir_id).map(
763 let ai = self.tcx.associated_item(did);
764 ai.container == ty::TraitContainer(clone_trait)
769 // If this expression had a clone call when suggesting borrowing
770 // we want to suggest removing it because it'd now be unnecessary.
774 if let Ok(src) = sm.span_to_snippet(sugg_sp) {
775 let needs_parens = match expr.kind {
776 // parenthesize if needed (Issue #46756)
777 hir::ExprKind::Cast(_, _) | hir::ExprKind::Binary(_, _, _) => true,
778 // parenthesize borrows of range literals (Issue #54505)
779 _ if is_range_literal(expr) => true,
782 let sugg_expr = if needs_parens { format!("({src})") } else { src };
784 if let Some(sugg) = self.can_use_as_ref(expr) {
789 Applicability::MachineApplicable,
794 let prefix = match self.maybe_get_struct_pattern_shorthand_field(expr) {
795 Some(ident) => format!("{ident}: "),
796 None => String::new(),
799 if let Some(hir::Node::Expr(hir::Expr {
800 kind: hir::ExprKind::Assign(..),
802 })) = self.tcx.hir().find(self.tcx.hir().get_parent_node(expr.hir_id))
804 if mutability == hir::Mutability::Mut {
805 // Suppressing this diagnostic, we'll properly print it in `check_expr_assign`
810 return Some(match mutability {
811 hir::Mutability::Mut => (
813 "consider mutably borrowing here".to_string(),
814 format!("{prefix}&mut {sugg_expr}"),
815 Applicability::MachineApplicable,
818 hir::Mutability::Not => (
820 "consider borrowing here".to_string(),
821 format!("{prefix}&{sugg_expr}"),
822 Applicability::MachineApplicable,
830 hir::ExprKind::AddrOf(hir::BorrowKind::Ref, _, ref expr),
832 &ty::Ref(_, checked, _),
833 ) if self.can_sub(self.param_env, checked, expected).is_ok() => {
834 // We have `&T`, check if what was expected was `T`. If so,
835 // we may want to suggest removing a `&`.
836 if sm.is_imported(expr.span) {
837 // Go through the spans from which this span was expanded,
838 // and find the one that's pointing inside `sp`.
840 // E.g. for `&format!("")`, where we want the span to the
841 // `format!()` invocation instead of its expansion.
842 if let Some(call_span) =
843 iter::successors(Some(expr.span), |s| s.parent_callsite())
844 .find(|&s| sp.contains(s))
845 && sm.is_span_accessible(call_span)
848 sp.with_hi(call_span.lo()),
849 "consider removing the borrow".to_string(),
851 Applicability::MachineApplicable,
857 if sp.contains(expr.span)
858 && sm.is_span_accessible(expr.span)
861 sp.with_hi(expr.span.lo()),
862 "consider removing the borrow".to_string(),
864 Applicability::MachineApplicable,
871 &ty::RawPtr(TypeAndMut { ty: ty_b, mutbl: mutbl_b }),
872 &ty::Ref(_, ty_a, mutbl_a),
874 if let Some(steps) = self.deref_steps(ty_a, ty_b)
875 // Only suggest valid if dereferencing needed.
877 // The pointer type implements `Copy` trait so the suggestion is always valid.
878 && let Ok(src) = sm.span_to_snippet(sp)
880 let derefs = "*".repeat(steps);
881 if let Some((span, src, applicability)) = match mutbl_b {
882 hir::Mutability::Mut => {
883 let new_prefix = "&mut ".to_owned() + &derefs;
885 hir::Mutability::Mut => {
886 replace_prefix(&src, "&mut ", &new_prefix).map(|_| {
887 let pos = sp.lo() + BytePos(5);
888 let sp = sp.with_lo(pos).with_hi(pos);
889 (sp, derefs, Applicability::MachineApplicable)
892 hir::Mutability::Not => {
893 replace_prefix(&src, "&", &new_prefix).map(|_| {
894 let pos = sp.lo() + BytePos(1);
895 let sp = sp.with_lo(pos).with_hi(pos);
898 format!("mut {derefs}"),
899 Applicability::Unspecified,
905 hir::Mutability::Not => {
906 let new_prefix = "&".to_owned() + &derefs;
908 hir::Mutability::Mut => {
909 replace_prefix(&src, "&mut ", &new_prefix).map(|_| {
910 let lo = sp.lo() + BytePos(1);
911 let hi = sp.lo() + BytePos(5);
912 let sp = sp.with_lo(lo).with_hi(hi);
913 (sp, derefs, Applicability::MachineApplicable)
916 hir::Mutability::Not => {
917 replace_prefix(&src, "&", &new_prefix).map(|_| {
918 let pos = sp.lo() + BytePos(1);
919 let sp = sp.with_lo(pos).with_hi(pos);
920 (sp, derefs, Applicability::MachineApplicable)
928 "consider dereferencing".to_string(),
936 _ if sp == expr.span => {
937 if let Some(mut steps) = self.deref_steps(checked_ty, expected) {
938 let mut expr = expr.peel_blocks();
939 let mut prefix_span = expr.span.shrink_to_lo();
940 let mut remove = String::new();
942 // Try peeling off any existing `&` and `&mut` to reach our target type
944 if let hir::ExprKind::AddrOf(_, mutbl, inner) = expr.kind {
945 // If the expression has `&`, removing it would fix the error
946 prefix_span = prefix_span.with_hi(inner.span.lo());
948 remove += match mutbl {
949 hir::Mutability::Not => "&",
950 hir::Mutability::Mut => "&mut ",
957 // If we've reached our target type with just removing `&`, then just print now.
961 format!("consider removing the `{}`", remove.trim()),
963 // Do not remove `&&` to get to bool, because it might be something like
964 // { a } && b, which we have a separate fixup suggestion that is more
966 if remove.trim() == "&&" && expected == self.tcx.types.bool {
967 Applicability::MaybeIncorrect
969 Applicability::MachineApplicable
975 // For this suggestion to make sense, the type would need to be `Copy`,
976 // or we have to be moving out of a `Box<T>`
977 if self.type_is_copy_modulo_regions(self.param_env, expected, sp)
978 // FIXME(compiler-errors): We can actually do this if the checked_ty is
979 // `steps` layers of boxes, not just one, but this is easier and most likely.
980 || (checked_ty.is_box() && steps == 1)
982 let deref_kind = if checked_ty.is_box() {
984 } else if checked_ty.is_region_ptr() {
985 "dereferencing the borrow"
987 "dereferencing the type"
990 // Suggest removing `&` if we have removed any, otherwise suggest just
991 // dereferencing the remaining number of steps.
992 let message = if remove.is_empty() {
993 format!("consider {deref_kind}")
996 "consider removing the `{}` and {} instead",
1002 let prefix = match self.maybe_get_struct_pattern_shorthand_field(expr) {
1003 Some(ident) => format!("{ident}: "),
1004 None => String::new(),
1007 let (span, suggestion) = if self.is_else_if_block(expr) {
1008 // Don't suggest nonsense like `else *if`
1010 } else if let Some(expr) = self.maybe_get_block_expr(expr) {
1011 // prefix should be empty here..
1012 (expr.span.shrink_to_lo(), "*".to_string())
1014 (prefix_span, format!("{}{}", prefix, "*".repeat(steps)))
1021 Applicability::MachineApplicable,
1032 pub fn check_for_cast(
1034 err: &mut Diagnostic,
1035 expr: &hir::Expr<'_>,
1036 checked_ty: Ty<'tcx>,
1037 expected_ty: Ty<'tcx>,
1038 expected_ty_expr: Option<&'tcx hir::Expr<'tcx>>,
1040 if self.tcx.sess.source_map().is_imported(expr.span) {
1041 // Ignore if span is from within a macro.
1045 let Ok(src) = self.tcx.sess.source_map().span_to_snippet(expr.span) else {
1049 // If casting this expression to a given numeric type would be appropriate in case of a type
1052 // We want to minimize the amount of casting operations that are suggested, as it can be a
1053 // lossy operation with potentially bad side effects, so we only suggest when encountering
1054 // an expression that indicates that the original type couldn't be directly changed.
1056 // For now, don't suggest casting with `as`.
1057 let can_cast = false;
1059 let mut sugg = vec![];
1061 if let Some(hir::Node::Expr(hir::Expr {
1062 kind: hir::ExprKind::Struct(_, fields, _), ..
1063 })) = self.tcx.hir().find(self.tcx.hir().get_parent_node(expr.hir_id))
1065 // `expr` is a literal field for a struct, only suggest if appropriate
1068 .find(|field| field.expr.hir_id == expr.hir_id && field.is_shorthand)
1070 // This is a field literal
1072 sugg.push((field.ident.span.shrink_to_lo(), format!("{}: ", field.ident)));
1074 // Likely a field was meant, but this field wasn't found. Do not suggest anything.
1075 None => return false,
1079 if let hir::ExprKind::Call(path, args) = &expr.kind
1080 && let (hir::ExprKind::Path(hir::QPath::TypeRelative(base_ty, path_segment)), 1) =
1081 (&path.kind, args.len())
1082 // `expr` is a conversion like `u32::from(val)`, do not suggest anything (#63697).
1083 && let (hir::TyKind::Path(hir::QPath::Resolved(None, base_ty_path)), sym::from) =
1084 (&base_ty.kind, path_segment.ident.name)
1086 if let Some(ident) = &base_ty_path.segments.iter().map(|s| s.ident).next() {
1100 if base_ty_path.segments.len() == 1 =>
1110 "you can convert {} `{}` to {} `{}`",
1111 checked_ty.kind().article(),
1113 expected_ty.kind().article(),
1116 let cast_msg = format!(
1117 "you can cast {} `{}` to {} `{}`",
1118 checked_ty.kind().article(),
1120 expected_ty.kind().article(),
1123 let lit_msg = format!(
1124 "change the type of the numeric literal from `{checked_ty}` to `{expected_ty}`",
1127 let close_paren = if expr.precedence().order() < PREC_POSTFIX {
1128 sugg.push((expr.span.shrink_to_lo(), "(".to_string()));
1134 let mut cast_suggestion = sugg.clone();
1135 cast_suggestion.push((expr.span.shrink_to_hi(), format!("{close_paren} as {expected_ty}")));
1136 let mut into_suggestion = sugg.clone();
1137 into_suggestion.push((expr.span.shrink_to_hi(), format!("{close_paren}.into()")));
1138 let mut suffix_suggestion = sugg.clone();
1139 suffix_suggestion.push((
1141 (&expected_ty.kind(), &checked_ty.kind()),
1142 (ty::Int(_) | ty::Uint(_), ty::Float(_))
1144 // Remove fractional part from literal, for example `42.0f32` into `42`
1145 let src = src.trim_end_matches(&checked_ty.to_string());
1146 let len = src.split('.').next().unwrap().len();
1147 expr.span.with_lo(expr.span.lo() + BytePos(len as u32))
1149 let len = src.trim_end_matches(&checked_ty.to_string()).len();
1150 expr.span.with_lo(expr.span.lo() + BytePos(len as u32))
1152 if expr.precedence().order() < PREC_POSTFIX {
1154 format!("{expected_ty})")
1156 expected_ty.to_string()
1159 let literal_is_ty_suffixed = |expr: &hir::Expr<'_>| {
1160 if let hir::ExprKind::Lit(lit) = &expr.kind { lit.node.is_suffixed() } else { false }
1162 let is_negative_int =
1163 |expr: &hir::Expr<'_>| matches!(expr.kind, hir::ExprKind::Unary(hir::UnOp::Neg, ..));
1164 let is_uint = |ty: Ty<'_>| matches!(ty.kind(), ty::Uint(..));
1166 let in_const_context = self.tcx.hir().is_inside_const_context(expr.hir_id);
1168 let suggest_fallible_into_or_lhs_from =
1169 |err: &mut Diagnostic, exp_to_found_is_fallible: bool| {
1170 // If we know the expression the expected type is derived from, we might be able
1171 // to suggest a widening conversion rather than a narrowing one (which may
1172 // panic). For example, given x: u8 and y: u32, if we know the span of "x",
1174 // can be given the suggestion "u32::from(x) > y" rather than
1175 // "x > y.try_into().unwrap()".
1176 let lhs_expr_and_src = expected_ty_expr.and_then(|expr| {
1180 .span_to_snippet(expr.span)
1182 .map(|src| (expr, src))
1184 let (msg, suggestion) = if let (Some((lhs_expr, lhs_src)), false) =
1185 (lhs_expr_and_src, exp_to_found_is_fallible)
1188 "you can convert `{lhs_src}` from `{expected_ty}` to `{checked_ty}`, matching the type of `{src}`",
1190 let suggestion = vec![
1191 (lhs_expr.span.shrink_to_lo(), format!("{checked_ty}::from(")),
1192 (lhs_expr.span.shrink_to_hi(), ")".to_string()),
1196 let msg = format!("{msg} and panic if the converted value doesn't fit");
1197 let mut suggestion = sugg.clone();
1199 expr.span.shrink_to_hi(),
1200 format!("{close_paren}.try_into().unwrap()"),
1204 err.multipart_suggestion_verbose(
1207 Applicability::MachineApplicable,
1211 let suggest_to_change_suffix_or_into =
1212 |err: &mut Diagnostic,
1213 found_to_exp_is_fallible: bool,
1214 exp_to_found_is_fallible: bool| {
1216 expected_ty_expr.map(|e| self.tcx.hir().is_lhs(e.hir_id)).unwrap_or(false);
1222 let always_fallible = found_to_exp_is_fallible
1223 && (exp_to_found_is_fallible || expected_ty_expr.is_none());
1224 let msg = if literal_is_ty_suffixed(expr) {
1226 } else if always_fallible && (is_negative_int(expr) && is_uint(expected_ty)) {
1227 // We now know that converting either the lhs or rhs is fallible. Before we
1228 // suggest a fallible conversion, check if the value can never fit in the
1230 let msg = format!("`{src}` cannot fit into type `{expected_ty}`");
1233 } else if in_const_context {
1234 // Do not recommend `into` or `try_into` in const contexts.
1236 } else if found_to_exp_is_fallible {
1237 return suggest_fallible_into_or_lhs_from(err, exp_to_found_is_fallible);
1241 let suggestion = if literal_is_ty_suffixed(expr) {
1242 suffix_suggestion.clone()
1244 into_suggestion.clone()
1246 err.multipart_suggestion_verbose(msg, suggestion, Applicability::MachineApplicable);
1249 match (&expected_ty.kind(), &checked_ty.kind()) {
1250 (&ty::Int(ref exp), &ty::Int(ref found)) => {
1251 let (f2e_is_fallible, e2f_is_fallible) = match (exp.bit_width(), found.bit_width())
1253 (Some(exp), Some(found)) if exp < found => (true, false),
1254 (Some(exp), Some(found)) if exp > found => (false, true),
1255 (None, Some(8 | 16)) => (false, true),
1256 (Some(8 | 16), None) => (true, false),
1257 (None, _) | (_, None) => (true, true),
1258 _ => (false, false),
1260 suggest_to_change_suffix_or_into(err, f2e_is_fallible, e2f_is_fallible);
1263 (&ty::Uint(ref exp), &ty::Uint(ref found)) => {
1264 let (f2e_is_fallible, e2f_is_fallible) = match (exp.bit_width(), found.bit_width())
1266 (Some(exp), Some(found)) if exp < found => (true, false),
1267 (Some(exp), Some(found)) if exp > found => (false, true),
1268 (None, Some(8 | 16)) => (false, true),
1269 (Some(8 | 16), None) => (true, false),
1270 (None, _) | (_, None) => (true, true),
1271 _ => (false, false),
1273 suggest_to_change_suffix_or_into(err, f2e_is_fallible, e2f_is_fallible);
1276 (&ty::Int(exp), &ty::Uint(found)) => {
1277 let (f2e_is_fallible, e2f_is_fallible) = match (exp.bit_width(), found.bit_width())
1279 (Some(exp), Some(found)) if found < exp => (false, true),
1280 (None, Some(8)) => (false, true),
1283 suggest_to_change_suffix_or_into(err, f2e_is_fallible, e2f_is_fallible);
1286 (&ty::Uint(exp), &ty::Int(found)) => {
1287 let (f2e_is_fallible, e2f_is_fallible) = match (exp.bit_width(), found.bit_width())
1289 (Some(exp), Some(found)) if found > exp => (true, false),
1290 (Some(8), None) => (true, false),
1293 suggest_to_change_suffix_or_into(err, f2e_is_fallible, e2f_is_fallible);
1296 (&ty::Float(ref exp), &ty::Float(ref found)) => {
1297 if found.bit_width() < exp.bit_width() {
1298 suggest_to_change_suffix_or_into(err, false, true);
1299 } else if literal_is_ty_suffixed(expr) {
1300 err.multipart_suggestion_verbose(
1303 Applicability::MachineApplicable,
1305 } else if can_cast {
1306 // Missing try_into implementation for `f64` to `f32`
1307 err.multipart_suggestion_verbose(
1308 &format!("{cast_msg}, producing the closest possible value"),
1310 Applicability::MaybeIncorrect, // lossy conversion
1315 (&ty::Uint(_) | &ty::Int(_), &ty::Float(_)) => {
1316 if literal_is_ty_suffixed(expr) {
1317 err.multipart_suggestion_verbose(
1320 Applicability::MachineApplicable,
1322 } else if can_cast {
1323 // Missing try_into implementation for `{float}` to `{integer}`
1324 err.multipart_suggestion_verbose(
1325 &format!("{msg}, rounding the float towards zero"),
1327 Applicability::MaybeIncorrect, // lossy conversion
1332 (&ty::Float(ref exp), &ty::Uint(ref found)) => {
1333 // if `found` is `None` (meaning found is `usize`), don't suggest `.into()`
1334 if exp.bit_width() > found.bit_width().unwrap_or(256) {
1335 err.multipart_suggestion_verbose(
1337 "{msg}, producing the floating point representation of the integer",
1340 Applicability::MachineApplicable,
1342 } else if literal_is_ty_suffixed(expr) {
1343 err.multipart_suggestion_verbose(
1346 Applicability::MachineApplicable,
1349 // Missing try_into implementation for `{integer}` to `{float}`
1350 err.multipart_suggestion_verbose(
1352 "{cast_msg}, producing the floating point representation of the integer, \
1353 rounded if necessary",
1356 Applicability::MaybeIncorrect, // lossy conversion
1361 (&ty::Float(ref exp), &ty::Int(ref found)) => {
1362 // if `found` is `None` (meaning found is `isize`), don't suggest `.into()`
1363 if exp.bit_width() > found.bit_width().unwrap_or(256) {
1364 err.multipart_suggestion_verbose(
1366 "{}, producing the floating point representation of the integer",
1370 Applicability::MachineApplicable,
1372 } else if literal_is_ty_suffixed(expr) {
1373 err.multipart_suggestion_verbose(
1376 Applicability::MachineApplicable,
1379 // Missing try_into implementation for `{integer}` to `{float}`
1380 err.multipart_suggestion_verbose(
1382 "{}, producing the floating point representation of the integer, \
1383 rounded if necessary",
1387 Applicability::MaybeIncorrect, // lossy conversion
1393 &ty::Uint(ty::UintTy::U32 | ty::UintTy::U64 | ty::UintTy::U128)
1394 | &ty::Int(ty::IntTy::I32 | ty::IntTy::I64 | ty::IntTy::I128),
1397 err.multipart_suggestion_verbose(
1398 &format!("{cast_msg}, since a `char` always occupies 4 bytes"),
1400 Applicability::MachineApplicable,
1408 // Report the type inferred by the return statement.
1409 fn report_closure_inferred_return_type(&self, err: &mut Diagnostic, expected: Ty<'tcx>) {
1410 if let Some(sp) = self.ret_coercion_span.get()
1411 // If the closure has an explicit return type annotation, or if
1412 // the closure's return type has been inferred from outside
1413 // requirements (such as an Fn* trait bound), then a type error
1414 // may occur at the first return expression we see in the closure
1415 // (if it conflicts with the declared return type). Skip adding a
1416 // note in this case, since it would be incorrect.
1417 && !self.return_type_pre_known
1422 "return type inferred to be `{}` here",
1423 self.resolve_vars_if_possible(expected)