1 use crate::check::FnCtxt;
2 use rustc::infer::InferOk;
3 use rustc::traits::{self, ObligationCause, ObligationCauseCode};
5 use syntax::symbol::sym;
6 use syntax::util::parser::PREC_POSTFIX;
10 use rustc::hir::{print, lowering::is_range_literal};
11 use rustc::ty::{self, Ty, AssocItem};
12 use rustc::ty::adjustment::AllowTwoPhase;
13 use errors::{Applicability, DiagnosticBuilder};
15 use super::method::probe;
17 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
18 // Requires that the two types unify, and prints an error message if
20 pub fn demand_suptype(&self, sp: Span, expected: Ty<'tcx>, actual: Ty<'tcx>) {
21 self.demand_suptype_diag(sp, expected, actual).map(|mut e| e.emit());
24 pub fn demand_suptype_diag(&self,
27 actual: Ty<'tcx>) -> Option<DiagnosticBuilder<'tcx>> {
28 let cause = &self.misc(sp);
29 match self.at(cause, self.param_env).sup(expected, actual) {
30 Ok(InferOk { obligations, value: () }) => {
31 self.register_predicates(obligations);
35 Some(self.report_mismatched_types(&cause, expected, actual, e))
40 pub fn demand_eqtype(&self, sp: Span, expected: Ty<'tcx>, actual: Ty<'tcx>) {
41 if let Some(mut err) = self.demand_eqtype_diag(sp, expected, actual) {
46 pub fn demand_eqtype_diag(&self,
49 actual: Ty<'tcx>) -> Option<DiagnosticBuilder<'tcx>> {
50 self.demand_eqtype_with_origin(&self.misc(sp), expected, actual)
53 pub fn demand_eqtype_with_origin(&self,
54 cause: &ObligationCause<'tcx>,
56 actual: Ty<'tcx>) -> Option<DiagnosticBuilder<'tcx>> {
57 match self.at(cause, self.param_env).eq(expected, actual) {
58 Ok(InferOk { obligations, value: () }) => {
59 self.register_predicates(obligations);
63 Some(self.report_mismatched_types(cause, expected, actual, e))
68 pub fn demand_eqtype_pat_diag(
73 match_expr_span: Option<Span>,
74 ) -> Option<DiagnosticBuilder<'tcx>> {
75 let cause = if let Some(span) = match_expr_span {
78 ObligationCauseCode::MatchExpressionArmPattern { span, ty: expected },
83 self.demand_eqtype_with_origin(&cause, expected, actual)
86 pub fn demand_eqtype_pat(
91 match_expr_span: Option<Span>,
93 self.demand_eqtype_pat_diag(cause_span, expected, actual, match_expr_span)
94 .map(|mut err| err.emit());
97 pub fn demand_coerce(&self,
101 allow_two_phase: AllowTwoPhase)
103 let (ty, err) = self.demand_coerce_diag(expr, checked_ty, expected, allow_two_phase);
104 if let Some(mut err) = err {
110 // Checks that the type of `expr` can be coerced to `expected`.
112 // N.B., this code relies on `self.diverges` to be accurate. In
113 // particular, assignments to `!` will be permitted if the
114 // diverges flag is currently "always".
115 pub fn demand_coerce_diag(
118 checked_ty: Ty<'tcx>,
120 allow_two_phase: AllowTwoPhase,
121 ) -> (Ty<'tcx>, Option<DiagnosticBuilder<'tcx>>) {
122 let expected = self.resolve_vars_with_obligations(expected);
124 let e = match self.try_coerce(expr, checked_ty, expected, allow_two_phase) {
125 Ok(ty) => return (ty, None),
129 let expr = expr.peel_drop_temps();
130 let cause = self.misc(expr.span);
131 let expr_ty = self.resolve_vars_with_obligations(checked_ty);
132 let mut err = self.report_mismatched_types(&cause, expected, expr_ty, e);
134 if self.is_assign_to_bool(expr, expected) {
135 // Error reported in `check_assign` so avoid emitting error again.
137 return (expected, None)
140 self.annotate_expected_due_to_let_ty(&mut err, expr);
141 self.suggest_compatible_variants(&mut err, expr, expected, expr_ty);
142 self.suggest_ref_or_into(&mut err, expr, expected, expr_ty);
143 self.suggest_boxing_when_appropriate(&mut err, expr, expected, expr_ty);
144 self.suggest_missing_await(&mut err, expr, expected, expr_ty);
146 (expected, Some(err))
149 fn annotate_expected_due_to_let_ty(&self, err: &mut DiagnosticBuilder<'_>, expr: &hir::Expr) {
150 let parent = self.tcx.hir().get_parent_node(expr.hir_id);
151 if let Some(hir::Node::Local(hir::Local {
155 })) = self.tcx.hir().find(parent) {
156 if init.hir_id == expr.hir_id {
157 // Point at `let` assignment type.
158 err.span_label(ty.span, "expected due to this");
163 /// Returns whether the expected type is `bool` and the expression is `x = y`.
164 pub fn is_assign_to_bool(&self, expr: &hir::Expr, expected: Ty<'tcx>) -> bool {
165 if let hir::ExprKind::Assign(..) = expr.kind {
166 return expected == self.tcx.types.bool;
171 /// If the expected type is an enum (Issue #55250) with any variants whose
172 /// sole field is of the found type, suggest such variants. (Issue #42764)
173 fn suggest_compatible_variants(
175 err: &mut DiagnosticBuilder<'_>,
180 if let ty::Adt(expected_adt, substs) = expected.kind {
181 if !expected_adt.is_enum() {
185 let mut compatible_variants = expected_adt.variants
187 .filter(|variant| variant.fields.len() == 1)
188 .filter_map(|variant| {
189 let sole_field = &variant.fields[0];
190 let sole_field_ty = sole_field.ty(self.tcx, substs);
191 if self.can_coerce(expr_ty, sole_field_ty) {
192 let variant_path = self.tcx.def_path_str(variant.def_id);
193 // FIXME #56861: DRYer prelude filtering
194 Some(variant_path.trim_start_matches("std::prelude::v1::").to_string())
200 if compatible_variants.peek().is_some() {
201 let expr_text = self.tcx.sess
203 .span_to_snippet(expr.span)
204 .unwrap_or_else(|_| {
205 print::to_string(print::NO_ANN, |s| s.print_expr(expr))
207 let suggestions = compatible_variants
208 .map(|v| format!("{}({})", v, expr_text));
209 let msg = "try using a variant of the expected enum";
210 err.span_suggestions(expr.span, msg, suggestions, Applicability::MaybeIncorrect);
215 pub fn get_conversion_methods(&self, span: Span, expected: Ty<'tcx>, checked_ty: Ty<'tcx>)
217 let mut methods = self.probe_for_return_type(span,
218 probe::Mode::MethodCall,
223 self.has_no_input_arg(m) &&
224 self.tcx.get_attrs(m.def_id).iter()
225 // This special internal attribute is used to whitelist
226 // "identity-like" conversion methods to be suggested here.
228 // FIXME (#46459 and #46460): ideally
229 // `std::convert::Into::into` and `std::borrow:ToOwned` would
230 // also be `#[rustc_conversion_suggestion]`, if not for
231 // method-probing false-positives and -negatives (respectively).
233 // FIXME? Other potential candidate methods: `as_ref` and
235 .find(|a| a.check_name(sym::rustc_conversion_suggestion)).is_some()
241 // This function checks if the method isn't static and takes other arguments than `self`.
242 fn has_no_input_arg(&self, method: &AssocItem) -> bool {
244 ty::AssocKind::Method => {
245 self.tcx.fn_sig(method.def_id).inputs().skip_binder().len() == 1
251 /// Identify some cases where `as_ref()` would be appropriate and suggest it.
253 /// Given the following code:
256 /// fn takes_ref(_: &Foo) {}
257 /// let ref opt = Some(Foo);
259 /// opt.map(|param| takes_ref(param));
261 /// Suggest using `opt.as_ref().map(|param| takes_ref(param));` instead.
263 /// It only checks for `Option` and `Result` and won't work with
265 /// opt.map(|param| { takes_ref(param) });
270 ) -> Option<(Span, &'static str, String)> {
271 let path = match expr.kind {
272 hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) => path,
276 let local_id = match path.res {
277 hir::def::Res::Local(id) => id,
281 let local_parent = self.tcx.hir().get_parent_node(local_id);
282 let param_hir_id = match self.tcx.hir().find(local_parent) {
283 Some(Node::Param(hir::Param { hir_id, .. })) => hir_id,
287 let param_parent = self.tcx.hir().get_parent_node(*param_hir_id);
288 let (expr_hir_id, closure_fn_decl) = match self.tcx.hir().find(param_parent) {
290 hir::Expr { hir_id, kind: hir::ExprKind::Closure(_, decl, ..), .. }
291 )) => (hir_id, decl),
295 let expr_parent = self.tcx.hir().get_parent_node(*expr_hir_id);
296 let hir = self.tcx.hir().find(expr_parent);
297 let closure_params_len = closure_fn_decl.inputs.len();
298 let (method_path, method_span, method_expr) = match (hir, closure_params_len) {
300 hir::Expr { kind: hir::ExprKind::MethodCall(path, span, expr), .. }
301 )), 1) => (path, span, expr),
305 let self_ty = self.tables.borrow().node_type(method_expr[0].hir_id);
306 let self_ty = format!("{:?}", self_ty);
307 let name = method_path.ident.as_str();
308 let is_as_ref_able = (
309 self_ty.starts_with("&std::option::Option") ||
310 self_ty.starts_with("&std::result::Result") ||
311 self_ty.starts_with("std::option::Option") ||
312 self_ty.starts_with("std::result::Result")
313 ) && (name == "map" || name == "and_then");
314 match (is_as_ref_able, self.sess().source_map().span_to_snippet(*method_span)) {
316 let suggestion = format!("as_ref().{}", src);
317 Some((*method_span, "consider using `as_ref` instead", suggestion))
323 crate fn is_hir_id_from_struct_pattern_shorthand_field(
328 let cm = self.sess().source_map();
329 let parent_id = self.tcx.hir().get_parent_node(hir_id);
330 if let Some(parent) = self.tcx.hir().find(parent_id) {
331 // Account for fields
332 if let Node::Expr(hir::Expr {
333 kind: hir::ExprKind::Struct(_, fields, ..), ..
335 if let Ok(src) = cm.span_to_snippet(sp) {
336 for field in fields {
337 if field.ident.as_str() == src && field.is_shorthand {
347 /// This function is used to determine potential "simple" improvements or users' errors and
348 /// provide them useful help. For example:
351 /// fn some_fn(s: &str) {}
353 /// let x = "hey!".to_owned();
354 /// some_fn(x); // error
357 /// No need to find every potential function which could make a coercion to transform a
358 /// `String` into a `&str` since a `&` would do the trick!
360 /// In addition of this check, it also checks between references mutability state. If the
361 /// expected is mutable but the provided isn't, maybe we could just say "Hey, try with
366 checked_ty: Ty<'tcx>,
368 ) -> Option<(Span, &'static str, String)> {
369 let cm = self.sess().source_map();
371 if !cm.span_to_filename(sp).is_real() {
372 // Ignore if span is from within a macro #41858, #58298. We previously used the macro
373 // call span, but that breaks down when the type error comes from multiple calls down.
377 let is_struct_pat_shorthand_field = self.is_hir_id_from_struct_pattern_shorthand_field(
382 // If the span is from a macro, then it's hard to extract the text
383 // and make a good suggestion, so don't bother.
384 let is_macro = sp.from_expansion() && sp.desugaring_kind().is_none();
386 // `ExprKind::DropTemps` is semantically irrelevant for these suggestions.
387 let expr = expr.peel_drop_temps();
389 match (&expr.kind, &expected.kind, &checked_ty.kind) {
390 (_, &ty::Ref(_, exp, _), &ty::Ref(_, check, _)) => match (&exp.kind, &check.kind) {
391 (&ty::Str, &ty::Array(arr, _)) |
392 (&ty::Str, &ty::Slice(arr)) if arr == self.tcx.types.u8 => {
393 if let hir::ExprKind::Lit(_) = expr.kind {
394 if let Ok(src) = cm.span_to_snippet(sp) {
395 if src.starts_with("b\"") {
397 "consider removing the leading `b`",
398 src[1..].to_string()));
403 (&ty::Array(arr, _), &ty::Str) |
404 (&ty::Slice(arr), &ty::Str) if arr == self.tcx.types.u8 => {
405 if let hir::ExprKind::Lit(_) = expr.kind {
406 if let Ok(src) = cm.span_to_snippet(sp) {
407 if src.starts_with("\"") {
409 "consider adding a leading `b`",
410 format!("b{}", src)));
417 (_, &ty::Ref(_, _, mutability), _) => {
418 // Check if it can work when put into a ref. For example:
421 // fn bar(x: &mut i32) {}
424 // bar(&x); // error, expected &mut
426 let ref_ty = match mutability {
427 hir::Mutability::Mutable => {
428 self.tcx.mk_mut_ref(self.tcx.mk_region(ty::ReStatic), checked_ty)
430 hir::Mutability::Immutable => {
431 self.tcx.mk_imm_ref(self.tcx.mk_region(ty::ReStatic), checked_ty)
434 if self.can_coerce(ref_ty, expected) {
435 let mut sugg_sp = sp;
436 if let hir::ExprKind::MethodCall(segment, _sp, args) = &expr.kind {
437 let clone_trait = self.tcx.lang_items().clone_trait().unwrap();
438 if let ([arg], Some(true), sym::clone) = (
440 self.tables.borrow().type_dependent_def_id(expr.hir_id).map(|did| {
441 let ai = self.tcx.associated_item(did);
442 ai.container == ty::TraitContainer(clone_trait)
446 // If this expression had a clone call when suggesting borrowing
447 // we want to suggest removing it because it'd now be unnecessary.
451 if let Ok(src) = cm.span_to_snippet(sugg_sp) {
452 let needs_parens = match expr.kind {
453 // parenthesize if needed (Issue #46756)
454 hir::ExprKind::Cast(_, _) |
455 hir::ExprKind::Binary(_, _, _) => true,
456 // parenthesize borrows of range literals (Issue #54505)
457 _ if is_range_literal(self.tcx.sess, expr) => true,
460 let sugg_expr = if needs_parens {
466 if let Some(sugg) = self.can_use_as_ref(expr) {
469 let field_name = if is_struct_pat_shorthand_field {
470 format!("{}: ", sugg_expr)
474 if let Some(hir::Node::Expr(hir::Expr {
475 kind: hir::ExprKind::Assign(left_expr, _),
477 })) = self.tcx.hir().find(
478 self.tcx.hir().get_parent_node(expr.hir_id),
480 if mutability == hir::Mutability::Mutable {
481 // Found the following case:
482 // fn foo(opt: &mut Option<String>){ opt = None }
485 // consider dereferencing here: `*opt` |
486 // expected mutable reference, found enum `Option`
487 if let Ok(src) = cm.span_to_snippet(left_expr.span) {
490 "consider dereferencing here to assign to the mutable \
491 borrowed piece of memory",
498 return Some(match mutability {
499 hir::Mutability::Mutable => (
501 "consider mutably borrowing here",
502 format!("{}&mut {}", field_name, sugg_expr),
504 hir::Mutability::Immutable => (
506 "consider borrowing here",
507 format!("{}&{}", field_name, sugg_expr),
514 hir::ExprKind::AddrOf(hir::BorrowKind::Ref, _, ref expr),
516 &ty::Ref(_, checked, _)
518 self.infcx.can_sub(self.param_env, checked, &expected).is_ok() && !is_macro
520 // We have `&T`, check if what was expected was `T`. If so,
521 // we may want to suggest removing a `&`.
522 if !cm.span_to_filename(expr.span).is_real() {
523 if let Ok(code) = cm.span_to_snippet(sp) {
524 if code.chars().next() == Some('&') {
527 "consider removing the borrow",
528 code[1..].to_string(),
534 if let Ok(code) = cm.span_to_snippet(expr.span) {
535 return Some((sp, "consider removing the borrow", code));
538 _ if sp == expr.span && !is_macro => {
539 // Check for `Deref` implementations by constructing a predicate to
540 // prove: `<T as Deref>::Output == U`
541 let deref_trait = self.tcx.lang_items().deref_trait().unwrap();
542 let item_def_id = self.tcx.associated_items(deref_trait).next().unwrap().def_id;
543 let predicate = ty::Predicate::Projection(ty::Binder::bind(ty::ProjectionPredicate {
544 // `<T as Deref>::Output`
545 projection_ty: ty::ProjectionTy {
547 substs: self.tcx.mk_substs_trait(
549 self.fresh_substs_for_item(sp, item_def_id),
557 let obligation = traits::Obligation::new(self.misc(sp), self.param_env, predicate);
558 let impls_deref = self.infcx.predicate_may_hold(&obligation);
560 // For a suggestion to make sense, the type would need to be `Copy`.
561 let is_copy = self.infcx.type_is_copy_modulo_regions(self.param_env, expected, sp);
563 if is_copy && impls_deref {
564 if let Ok(code) = cm.span_to_snippet(sp) {
565 let message = if checked_ty.is_region_ptr() {
566 "consider dereferencing the borrow"
568 "consider dereferencing the type"
570 let suggestion = if is_struct_pat_shorthand_field {
571 format!("{}: *{}", code, code)
575 return Some((sp, message, suggestion));
584 pub fn check_for_cast(
586 err: &mut DiagnosticBuilder<'_>,
588 checked_ty: Ty<'tcx>,
589 expected_ty: Ty<'tcx>,
591 if self.tcx.hir().is_const_context(expr.hir_id) {
592 // Shouldn't suggest `.into()` on `const`s.
593 // FIXME(estebank): modify once we decide to suggest `as` casts
596 if !self.tcx.sess.source_map().span_to_filename(expr.span).is_real() {
597 // Ignore if span is from within a macro.
601 // If casting this expression to a given numeric type would be appropriate in case of a type
604 // We want to minimize the amount of casting operations that are suggested, as it can be a
605 // lossy operation with potentially bad side effects, so we only suggest when encountering
606 // an expression that indicates that the original type couldn't be directly changed.
608 // For now, don't suggest casting with `as`.
609 let can_cast = false;
611 let mut prefix = String::new();
612 if let Some(hir::Node::Expr(hir::Expr {
613 kind: hir::ExprKind::Struct(_, fields, _),
615 })) = self.tcx.hir().find(self.tcx.hir().get_parent_node(expr.hir_id)) {
616 // `expr` is a literal field for a struct, only suggest if appropriate
617 for field in fields {
618 if field.expr.hir_id == expr.hir_id && field.is_shorthand {
619 // This is a field literal
620 prefix = format!("{}: ", field.ident);
625 // Likely a field was meant, but this field wasn't found. Do not suggest anything.
629 if let hir::ExprKind::Call(path, args) = &expr.kind {
631 hir::ExprKind::Path(hir::QPath::TypeRelative(base_ty, path_segment)),
633 ) = (&path.kind, args.len()) {
634 // `expr` is a conversion like `u32::from(val)`, do not suggest anything (#63697).
636 hir::TyKind::Path(hir::QPath::Resolved(None, base_ty_path)),
638 ) = (&base_ty.kind, path_segment.ident.name) {
639 if let Some(ident) = &base_ty_path.segments.iter().map(|s| s.ident).next() {
641 sym::i128 | sym::i64 | sym::i32 | sym::i16 | sym::i8 |
642 sym::u128 | sym::u64 | sym::u32 | sym::u16 | sym::u8 |
643 sym::isize | sym::usize
644 if base_ty_path.segments.len() == 1 => {
654 let msg = format!("you can convert an `{}` to `{}`", checked_ty, expected_ty);
655 let cast_msg = format!("you can cast an `{} to `{}`", checked_ty, expected_ty);
656 let try_msg = format!("{} and panic if the converted value wouldn't fit", msg);
657 let lit_msg = format!(
658 "change the type of the numeric literal from `{}` to `{}`",
663 let needs_paren = expr.precedence().order() < (PREC_POSTFIX as i8);
665 if let Ok(src) = self.tcx.sess.source_map().span_to_snippet(expr.span) {
666 let cast_suggestion = format!(
669 if needs_paren { "(" } else { "" },
671 if needs_paren { ")" } else { "" },
674 let try_into_suggestion = format!(
675 "{}{}{}{}.try_into().unwrap()",
677 if needs_paren { "(" } else { "" },
679 if needs_paren { ")" } else { "" },
681 let into_suggestion = format!(
684 if needs_paren { "(" } else { "" },
686 if needs_paren { ")" } else { "" },
688 let suffix_suggestion = format!(
690 if needs_paren { "(" } else { "" },
691 if let (ty::Int(_), ty::Float(_)) | (ty::Uint(_), ty::Float(_)) = (
695 // Remove fractional part from literal, for example `42.0f32` into `42`
696 let src = src.trim_end_matches(&checked_ty.to_string());
697 src.split(".").next().unwrap()
699 src.trim_end_matches(&checked_ty.to_string())
702 if needs_paren { ")" } else { "" },
704 let literal_is_ty_suffixed = |expr: &hir::Expr| {
705 if let hir::ExprKind::Lit(lit) = &expr.kind {
706 lit.node.is_suffixed()
712 let suggest_to_change_suffix_or_into = |
713 err: &mut DiagnosticBuilder<'_>,
716 let into_sugg = into_suggestion.clone();
719 if literal_is_ty_suffixed(expr) {
721 } else if is_fallible {
726 if literal_is_ty_suffixed(expr) {
727 suffix_suggestion.clone()
728 } else if is_fallible {
733 Applicability::MachineApplicable,
737 match (&expected_ty.kind, &checked_ty.kind) {
738 (&ty::Int(ref exp), &ty::Int(ref found)) => {
739 let is_fallible = match (found.bit_width(), exp.bit_width()) {
740 (Some(found), Some(exp)) if found > exp => true,
741 (None, _) | (_, None) => true,
744 suggest_to_change_suffix_or_into(err, is_fallible);
747 (&ty::Uint(ref exp), &ty::Uint(ref found)) => {
748 let is_fallible = match (found.bit_width(), exp.bit_width()) {
749 (Some(found), Some(exp)) if found > exp => true,
750 (None, _) | (_, None) => true,
753 suggest_to_change_suffix_or_into(err, is_fallible);
756 (&ty::Int(_), &ty::Uint(_)) | (&ty::Uint(_), &ty::Int(_)) => {
757 suggest_to_change_suffix_or_into(err, true);
760 (&ty::Float(ref exp), &ty::Float(ref found)) => {
761 if found.bit_width() < exp.bit_width() {
762 suggest_to_change_suffix_or_into(err, false);
763 } else if literal_is_ty_suffixed(expr) {
768 Applicability::MachineApplicable,
770 } else if can_cast { // Missing try_into implementation for `f64` to `f32`
773 &format!("{}, producing the closest possible value", cast_msg),
775 Applicability::MaybeIncorrect, // lossy conversion
780 (&ty::Uint(_), &ty::Float(_)) | (&ty::Int(_), &ty::Float(_)) => {
781 if literal_is_ty_suffixed(expr) {
786 Applicability::MachineApplicable,
789 // Missing try_into implementation for `{float}` to `{integer}`
792 &format!("{}, rounding the float towards zero", msg),
794 Applicability::MaybeIncorrect // lossy conversion
796 err.warn("if the rounded value cannot be represented by the target \
797 integer type, including `Inf` and `NaN`, casting will cause \
799 (https://github.com/rust-lang/rust/issues/10184)");
803 (&ty::Float(ref exp), &ty::Uint(ref found)) => {
804 // if `found` is `None` (meaning found is `usize`), don't suggest `.into()`
805 if exp.bit_width() > found.bit_width().unwrap_or(256) {
809 "{}, producing the floating point representation of the integer",
813 Applicability::MachineApplicable
815 } else if literal_is_ty_suffixed(expr) {
820 Applicability::MachineApplicable,
823 // Missing try_into implementation for `{integer}` to `{float}`
827 "{}, producing the floating point representation of the integer,
828 rounded if necessary",
832 Applicability::MaybeIncorrect // lossy conversion
837 (&ty::Float(ref exp), &ty::Int(ref found)) => {
838 // if `found` is `None` (meaning found is `isize`), don't suggest `.into()`
839 if exp.bit_width() > found.bit_width().unwrap_or(256) {
843 "{}, producing the floating point representation of the integer",
847 Applicability::MachineApplicable
849 } else if literal_is_ty_suffixed(expr) {
854 Applicability::MachineApplicable,
857 // Missing try_into implementation for `{integer}` to `{float}`
861 "{}, producing the floating point representation of the integer, \
862 rounded if necessary",
866 Applicability::MaybeIncorrect // lossy conversion