2 DerivedObligationCause, EvaluationResult, ImplDerivedObligationCause, Obligation,
3 ObligationCause, ObligationCauseCode, PredicateObligation, SelectionContext,
6 use crate::autoderef::Autoderef;
7 use crate::infer::InferCtxt;
8 use crate::traits::normalize_projection_type;
10 use rustc_data_structures::fx::FxHashSet;
11 use rustc_data_structures::stack::ensure_sufficient_stack;
13 error_code, pluralize, struct_span_err, Applicability, Diagnostic, DiagnosticBuilder,
14 ErrorGuaranteed, Style,
17 use rustc_hir::def::DefKind;
18 use rustc_hir::def_id::DefId;
19 use rustc_hir::intravisit::Visitor;
20 use rustc_hir::lang_items::LangItem;
21 use rustc_hir::{AsyncGeneratorKind, GeneratorKind, Node};
22 use rustc_middle::ty::{
23 self, suggest_arbitrary_trait_bound, suggest_constraining_type_param, AdtKind, DefIdTree,
24 Infer, InferTy, ToPredicate, Ty, TyCtxt, TypeFoldable,
26 use rustc_middle::ty::{TypeAndMut, TypeckResults};
27 use rustc_session::Limit;
28 use rustc_span::def_id::LOCAL_CRATE;
29 use rustc_span::symbol::{kw, sym, Ident, Symbol};
30 use rustc_span::{BytePos, DesugaringKind, ExpnKind, MultiSpan, Span, DUMMY_SP};
31 use rustc_target::spec::abi;
34 use super::InferCtxtPrivExt;
35 use crate::infer::InferCtxtExt as _;
36 use crate::traits::query::evaluate_obligation::InferCtxtExt as _;
37 use rustc_middle::ty::print::with_no_trimmed_paths;
40 pub enum GeneratorInteriorOrUpvar {
41 // span of interior type
47 // This trait is public to expose the diagnostics methods to clippy.
48 pub trait InferCtxtExt<'tcx> {
49 fn suggest_restricting_param_bound(
52 trait_pred: ty::PolyTraitPredicate<'tcx>,
56 fn suggest_dereferences(
58 obligation: &PredicateObligation<'tcx>,
60 trait_pred: ty::PolyTraitPredicate<'tcx>,
63 fn get_closure_name(&self, def_id: DefId, err: &mut Diagnostic, msg: &str) -> Option<String>;
67 obligation: &PredicateObligation<'tcx>,
69 trait_pred: ty::PolyTraitPredicate<'tcx>,
72 fn suggest_add_reference_to_arg(
74 obligation: &PredicateObligation<'tcx>,
76 trait_pred: ty::PolyTraitPredicate<'tcx>,
77 has_custom_message: bool,
80 fn suggest_remove_reference(
82 obligation: &PredicateObligation<'tcx>,
84 trait_pred: ty::PolyTraitPredicate<'tcx>,
87 fn suggest_remove_await(&self, obligation: &PredicateObligation<'tcx>, err: &mut Diagnostic);
89 fn suggest_change_mut(
91 obligation: &PredicateObligation<'tcx>,
93 trait_pred: ty::PolyTraitPredicate<'tcx>,
96 fn suggest_semicolon_removal(
98 obligation: &PredicateObligation<'tcx>,
101 trait_pred: ty::PolyTraitPredicate<'tcx>,
104 fn return_type_span(&self, obligation: &PredicateObligation<'tcx>) -> Option<Span>;
106 fn suggest_impl_trait(
108 err: &mut Diagnostic,
110 obligation: &PredicateObligation<'tcx>,
111 trait_pred: ty::PolyTraitPredicate<'tcx>,
114 fn point_at_returns_when_relevant(
116 err: &mut Diagnostic,
117 obligation: &PredicateObligation<'tcx>,
120 fn report_closure_arg_mismatch(
123 found_span: Option<Span>,
124 expected_ref: ty::PolyTraitRef<'tcx>,
125 found: ty::PolyTraitRef<'tcx>,
126 ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed>;
128 fn suggest_fully_qualified_path(
130 err: &mut Diagnostic,
136 fn maybe_note_obligation_cause_for_async_await(
138 err: &mut Diagnostic,
139 obligation: &PredicateObligation<'tcx>,
142 fn note_obligation_cause_for_async_await(
144 err: &mut Diagnostic,
145 interior_or_upvar_span: GeneratorInteriorOrUpvar,
146 interior_extra_info: Option<(Option<Span>, Span, Option<hir::HirId>, Option<Span>)>,
147 inner_generator_body: Option<&hir::Body<'tcx>>,
148 outer_generator: Option<DefId>,
149 trait_pred: ty::TraitPredicate<'tcx>,
151 typeck_results: Option<&ty::TypeckResults<'tcx>>,
152 obligation: &PredicateObligation<'tcx>,
153 next_code: Option<&ObligationCauseCode<'tcx>>,
156 fn note_obligation_cause_code<T>(
158 err: &mut Diagnostic,
160 param_env: ty::ParamEnv<'tcx>,
161 cause_code: &ObligationCauseCode<'tcx>,
162 obligated_types: &mut Vec<Ty<'tcx>>,
163 seen_requirements: &mut FxHashSet<DefId>,
167 fn suggest_new_overflow_limit(&self, err: &mut Diagnostic);
169 /// Suggest to await before try: future? => future.await?
170 fn suggest_await_before_try(
172 err: &mut Diagnostic,
173 obligation: &PredicateObligation<'tcx>,
174 trait_pred: ty::PolyTraitPredicate<'tcx>,
178 fn suggest_floating_point_literal(
180 obligation: &PredicateObligation<'tcx>,
181 err: &mut Diagnostic,
182 trait_ref: &ty::PolyTraitRef<'tcx>,
186 fn predicate_constraint(generics: &hir::Generics<'_>, pred: String) -> (Span, String) {
188 generics.where_clause.tail_span_for_suggestion(),
191 if !generics.where_clause.predicates.is_empty() { "," } else { " where" },
197 /// Type parameter needs more bounds. The trivial case is `T` `where T: Bound`, but
198 /// it can also be an `impl Trait` param that needs to be decomposed to a type
199 /// param for cleaner code.
200 fn suggest_restriction<'tcx>(
202 generics: &hir::Generics<'tcx>,
204 err: &mut Diagnostic,
205 fn_sig: Option<&hir::FnSig<'_>>,
206 projection: Option<&ty::ProjectionTy<'_>>,
207 trait_pred: ty::PolyTraitPredicate<'tcx>,
208 super_traits: Option<(&Ident, &hir::GenericBounds<'_>)>,
210 // When we are dealing with a trait, `super_traits` will be `Some`:
211 // Given `trait T: A + B + C {}`
212 // - ^^^^^^^^^ GenericBounds
215 let span = generics.where_clause.span_for_predicates_or_empty_place();
216 if span.from_expansion() || span.desugaring_kind().is_some() {
219 // Given `fn foo(t: impl Trait)` where `Trait` requires assoc type `A`...
220 if let Some((bound_str, fn_sig)) =
221 fn_sig.zip(projection).and_then(|(sig, p)| match p.self_ty().kind() {
222 // Shenanigans to get the `Trait` from the `impl Trait`.
223 ty::Param(param) => {
224 // `fn foo(t: impl Trait)`
225 // ^^^^^ get this string
226 param.name.as_str().strip_prefix("impl").map(|s| (s.trim_start().to_string(), sig))
231 // We know we have an `impl Trait` that doesn't satisfy a required projection.
233 // Find all of the occurrences of `impl Trait` for `Trait` in the function arguments'
234 // types. There should be at least one, but there might be *more* than one. In that
235 // case we could just ignore it and try to identify which one needs the restriction,
236 // but instead we choose to suggest replacing all instances of `impl Trait` with `T`
238 let mut ty_spans = vec![];
239 let impl_trait_str = format!("impl {}", bound_str);
240 for input in fn_sig.decl.inputs {
241 if let hir::TyKind::Path(hir::QPath::Resolved(
243 hir::Path { segments: [segment], .. },
246 if segment.ident.as_str() == impl_trait_str.as_str() {
247 // `fn foo(t: impl Trait)`
248 // ^^^^^^^^^^ get this to suggest `T` instead
250 // There might be more than one `impl Trait`.
251 ty_spans.push(input.span);
256 let type_param_name = generics.params.next_type_param_name(Some(&bound_str));
257 // The type param `T: Trait` we will suggest to introduce.
258 let type_param = format!("{}: {}", type_param_name, bound_str);
260 // FIXME: modify the `trait_pred` instead of string shenanigans.
261 // Turn `<impl Trait as Foo>::Bar: Qux` into `<T as Foo>::Bar: Qux`.
262 let pred = trait_pred.to_predicate(tcx).to_string();
263 let pred = pred.replace(&impl_trait_str, &type_param_name);
265 // Find the last of the generic parameters contained within the span of
270 .map(|p| p.bounds_span_for_suggestions().unwrap_or(p.span.shrink_to_hi()))
271 .filter(|&span| generics.span.contains(span) && span.can_be_used_for_suggestions())
272 .max_by_key(|span| span.hi())
274 // `fn foo(t: impl Trait)`
275 // ^ suggest `<T: Trait>` here
276 None => (generics.span, format!("<{}>", type_param)),
277 // `fn foo<A>(t: impl Trait)`
278 // ^^^ suggest `<A, T: Trait>` here
279 Some(span) => (span, format!(", {}", type_param)),
281 // `fn foo(t: impl Trait)`
282 // ^ suggest `where <T as Trait>::A: Bound`
283 predicate_constraint(generics, pred),
285 sugg.extend(ty_spans.into_iter().map(|s| (s, type_param_name.to_string())));
287 // Suggest `fn foo<T: Trait>(t: T) where <T as Trait>::A: Bound`.
288 // FIXME: once `#![feature(associated_type_bounds)]` is stabilized, we should suggest
289 // `fn foo(t: impl Trait<A: Bound>)` instead.
290 err.multipart_suggestion(
291 "introduce a type parameter with a trait bound instead of using `impl Trait`",
293 Applicability::MaybeIncorrect,
296 // Trivial case: `T` needs an extra bound: `T: Bound`.
297 let (sp, suggestion) = match (
301 .find(|p| !matches!(p.kind, hir::GenericParamKind::Type { synthetic: true, .. })),
304 (_, None) => predicate_constraint(generics, trait_pred.to_predicate(tcx).to_string()),
305 (None, Some((ident, []))) => (
306 ident.span.shrink_to_hi(),
307 format!(": {}", trait_pred.print_modifiers_and_trait_path()),
309 (_, Some((_, [.., bounds]))) => (
310 bounds.span().shrink_to_hi(),
311 format!(" + {}", trait_pred.print_modifiers_and_trait_path()),
313 (Some(_), Some((_, []))) => (
314 generics.span.shrink_to_hi(),
315 format!(": {}", trait_pred.print_modifiers_and_trait_path()),
319 err.span_suggestion_verbose(
321 &format!("consider further restricting {}", msg),
323 Applicability::MachineApplicable,
328 impl<'a, 'tcx> InferCtxtExt<'tcx> for InferCtxt<'a, 'tcx> {
329 fn suggest_restricting_param_bound(
331 mut err: &mut Diagnostic,
332 trait_pred: ty::PolyTraitPredicate<'tcx>,
335 let self_ty = trait_pred.skip_binder().self_ty();
336 let (param_ty, projection) = match self_ty.kind() {
337 ty::Param(_) => (true, None),
338 ty::Projection(projection) => (false, Some(projection)),
342 // FIXME: Add check for trait bound that is already present, particularly `?Sized` so we
343 // don't suggest `T: Sized + ?Sized`.
344 let mut hir_id = body_id;
345 while let Some(node) = self.tcx.hir().find(hir_id) {
347 hir::Node::Item(hir::Item {
349 kind: hir::ItemKind::Trait(_, _, generics, bounds, _),
351 }) if self_ty == self.tcx.types.self_param => {
353 // Restricting `Self` for a single method.
362 Some((ident, bounds)),
367 hir::Node::TraitItem(hir::TraitItem {
369 kind: hir::TraitItemKind::Fn(..),
371 }) if self_ty == self.tcx.types.self_param => {
373 // Restricting `Self` for a single method.
375 self.tcx, &generics, "`Self`", err, None, projection, trait_pred, None,
380 hir::Node::TraitItem(hir::TraitItem {
382 kind: hir::TraitItemKind::Fn(fn_sig, ..),
385 | hir::Node::ImplItem(hir::ImplItem {
387 kind: hir::ImplItemKind::Fn(fn_sig, ..),
390 | hir::Node::Item(hir::Item {
391 kind: hir::ItemKind::Fn(fn_sig, generics, _), ..
392 }) if projection.is_some() => {
393 // Missing restriction on associated type of type parameter (unmet projection).
397 "the associated type",
406 hir::Node::Item(hir::Item {
408 hir::ItemKind::Trait(_, _, generics, ..)
409 | hir::ItemKind::Impl(hir::Impl { generics, .. }),
411 }) if projection.is_some() => {
412 // Missing restriction on associated type of type parameter (unmet projection).
416 "the associated type",
426 hir::Node::Item(hir::Item {
428 hir::ItemKind::Struct(_, generics)
429 | hir::ItemKind::Enum(_, generics)
430 | hir::ItemKind::Union(_, generics)
431 | hir::ItemKind::Trait(_, _, generics, ..)
432 | hir::ItemKind::Impl(hir::Impl { generics, .. })
433 | hir::ItemKind::Fn(_, generics, _)
434 | hir::ItemKind::TyAlias(_, generics)
435 | hir::ItemKind::TraitAlias(generics, _)
436 | hir::ItemKind::OpaqueTy(hir::OpaqueTy { generics, .. }),
439 | hir::Node::TraitItem(hir::TraitItem { generics, .. })
440 | hir::Node::ImplItem(hir::ImplItem { generics, .. })
443 // Missing generic type parameter bound.
444 let param_name = self_ty.to_string();
445 let constraint = with_no_trimmed_paths!(
446 trait_pred.print_modifiers_and_trait_path().to_string()
448 if suggest_constraining_type_param(
454 Some(trait_pred.def_id()),
460 hir::Node::Item(hir::Item {
462 hir::ItemKind::Struct(_, generics)
463 | hir::ItemKind::Enum(_, generics)
464 | hir::ItemKind::Union(_, generics)
465 | hir::ItemKind::Trait(_, _, generics, ..)
466 | hir::ItemKind::Impl(hir::Impl { generics, .. })
467 | hir::ItemKind::Fn(_, generics, _)
468 | hir::ItemKind::TyAlias(_, generics)
469 | hir::ItemKind::TraitAlias(generics, _)
470 | hir::ItemKind::OpaqueTy(hir::OpaqueTy { generics, .. }),
473 // Missing generic type parameter bound.
474 let param_name = self_ty.to_string();
475 let constraint = trait_pred.print_modifiers_and_trait_path().to_string();
476 if suggest_arbitrary_trait_bound(generics, &mut err, ¶m_name, &constraint) {
480 hir::Node::Crate(..) => return,
485 hir_id = self.tcx.hir().local_def_id_to_hir_id(self.tcx.hir().get_parent_item(hir_id));
489 /// When after several dereferencing, the reference satisfies the trait
490 /// binding. This function provides dereference suggestion for this
491 /// specific situation.
492 fn suggest_dereferences(
494 obligation: &PredicateObligation<'tcx>,
495 err: &mut Diagnostic,
496 trait_pred: ty::PolyTraitPredicate<'tcx>,
498 // It only make sense when suggesting dereferences for arguments
499 let ObligationCauseCode::FunctionArgumentObligation { .. } = obligation.cause.code() else {
502 let param_env = obligation.param_env;
503 let body_id = obligation.cause.body_id;
504 let span = obligation.cause.span;
505 let mut real_trait_pred = trait_pred;
506 let mut code = obligation.cause.code();
509 ObligationCauseCode::FunctionArgumentObligation { parent_code, .. } => {
512 ObligationCauseCode::ImplDerivedObligation(box ImplDerivedObligationCause {
513 derived: DerivedObligationCause { parent_code, parent_trait_pred },
516 | ObligationCauseCode::BuiltinDerivedObligation(DerivedObligationCause {
520 | ObligationCauseCode::DerivedObligation(DerivedObligationCause {
525 real_trait_pred = *parent_trait_pred;
529 let Some(real_ty) = real_trait_pred.self_ty().no_bound_vars() else {
533 if let ty::Ref(region, base_ty, mutbl) = *real_ty.kind() {
534 let mut autoderef = Autoderef::new(self, param_env, body_id, span, base_ty, span);
535 if let Some(steps) = autoderef.find_map(|(ty, steps)| {
537 let ty = self.tcx.mk_ref(region, TypeAndMut { ty, mutbl });
539 self.mk_trait_obligation_with_new_self_ty(param_env, real_trait_pred, ty);
540 Some(steps).filter(|_| self.predicate_may_hold(&obligation))
543 if let Ok(src) = self.tcx.sess.source_map().span_to_snippet(span) {
544 // Don't care about `&mut` because `DerefMut` is used less
545 // often and user will not expect autoderef happens.
546 if src.starts_with('&') && !src.starts_with("&mut ") {
547 let derefs = "*".repeat(steps);
550 "consider dereferencing here",
551 format!("&{}{}", derefs, &src[1..]),
552 Applicability::MachineApplicable,
558 } else if real_trait_pred != trait_pred {
559 // This branch addresses #87437.
561 self.mk_trait_obligation_with_new_self_ty(param_env, real_trait_pred, base_ty);
562 if self.predicate_may_hold(&obligation) {
563 err.span_suggestion_verbose(
565 "consider dereferencing here",
567 Applicability::MachineApplicable,
577 /// Given a closure's `DefId`, return the given name of the closure.
579 /// This doesn't account for reassignments, but it's only used for suggestions.
580 fn get_closure_name(&self, def_id: DefId, err: &mut Diagnostic, msg: &str) -> Option<String> {
581 let get_name = |err: &mut Diagnostic, kind: &hir::PatKind<'_>| -> Option<String> {
582 // Get the local name of this closure. This can be inaccurate because
583 // of the possibility of reassignment, but this should be good enough.
585 hir::PatKind::Binding(hir::BindingAnnotation::Unannotated, _, name, None) => {
586 Some(format!("{}", name))
595 let hir = self.tcx.hir();
596 let hir_id = hir.local_def_id_to_hir_id(def_id.as_local()?);
597 let parent_node = hir.get_parent_node(hir_id);
598 match hir.find(parent_node) {
599 Some(hir::Node::Stmt(hir::Stmt { kind: hir::StmtKind::Local(local), .. })) => {
600 get_name(err, &local.pat.kind)
602 // Different to previous arm because one is `&hir::Local` and the other
603 // is `P<hir::Local>`.
604 Some(hir::Node::Local(local)) => get_name(err, &local.pat.kind),
609 /// We tried to apply the bound to an `fn` or closure. Check whether calling it would
610 /// evaluate to a type that *would* satisfy the trait binding. If it would, suggest calling
611 /// it: `bar(foo)` → `bar(foo())`. This case is *very* likely to be hit if `foo` is `async`.
614 obligation: &PredicateObligation<'tcx>,
615 err: &mut Diagnostic,
616 trait_pred: ty::PolyTraitPredicate<'tcx>,
618 let Some(self_ty) = trait_pred.self_ty().no_bound_vars() else {
622 let (def_id, output_ty, callable) = match *self_ty.kind() {
623 ty::Closure(def_id, substs) => (def_id, substs.as_closure().sig().output(), "closure"),
624 ty::FnDef(def_id, _) => (def_id, self_ty.fn_sig(self.tcx).output(), "function"),
627 let msg = format!("use parentheses to call the {}", callable);
629 // `mk_trait_obligation_with_new_self_ty` only works for types with no escaping bound
630 // variables, so bail out if we have any.
631 let Some(output_ty) = output_ty.no_bound_vars() else {
636 self.mk_trait_obligation_with_new_self_ty(obligation.param_env, trait_pred, output_ty);
638 match self.evaluate_obligation(&new_obligation) {
640 EvaluationResult::EvaluatedToOk
641 | EvaluationResult::EvaluatedToOkModuloRegions
642 | EvaluationResult::EvaluatedToAmbig,
646 let hir = self.tcx.hir();
647 // Get the name of the callable and the arguments to be used in the suggestion.
648 let (snippet, sugg) = match hir.get_if_local(def_id) {
649 Some(hir::Node::Expr(hir::Expr {
650 kind: hir::ExprKind::Closure(_, decl, _, span, ..),
653 err.span_label(*span, "consider calling this closure");
654 let Some(name) = self.get_closure_name(def_id, err, &msg) else {
657 let args = decl.inputs.iter().map(|_| "_").collect::<Vec<_>>().join(", ");
658 let sugg = format!("({})", args);
659 (format!("{}{}", name, sugg), sugg)
661 Some(hir::Node::Item(hir::Item {
663 kind: hir::ItemKind::Fn(.., body_id),
666 err.span_label(ident.span, "consider calling this function");
667 let body = hir.body(*body_id);
671 .map(|arg| match &arg.pat.kind {
672 hir::PatKind::Binding(_, _, ident, None)
673 // FIXME: provide a better suggestion when encountering `SelfLower`, it
674 // should suggest a method call.
675 if ident.name != kw::SelfLower => ident.to_string(),
676 _ => "_".to_string(),
680 let sugg = format!("({})", args);
681 (format!("{}{}", ident, sugg), sugg)
685 if matches!(obligation.cause.code(), ObligationCauseCode::FunctionArgumentObligation { .. })
687 // When the obligation error has been ensured to have been caused by
688 // an argument, the `obligation.cause.span` points at the expression
689 // of the argument, so we can provide a suggestion. Otherwise, we give
690 // a more general note.
691 err.span_suggestion_verbose(
692 obligation.cause.span.shrink_to_hi(),
695 Applicability::HasPlaceholders,
698 err.help(&format!("{}: `{}`", msg, snippet));
703 fn suggest_add_reference_to_arg(
705 obligation: &PredicateObligation<'tcx>,
706 err: &mut Diagnostic,
707 poly_trait_pred: ty::PolyTraitPredicate<'tcx>,
708 has_custom_message: bool,
710 let span = obligation.cause.span;
712 let code = if let ObligationCauseCode::FunctionArgumentObligation { parent_code, .. } =
713 obligation.cause.code()
716 } else if let ExpnKind::Desugaring(DesugaringKind::ForLoop) =
717 span.ctxt().outer_expn_data().kind
719 obligation.cause.code()
724 // List of traits for which it would be nonsensical to suggest borrowing.
725 // For instance, immutable references are always Copy, so suggesting to
726 // borrow would always succeed, but it's probably not what the user wanted.
727 let mut never_suggest_borrow: Vec<_> =
728 [LangItem::Copy, LangItem::Clone, LangItem::Unpin, LangItem::Sized]
730 .filter_map(|lang_item| self.tcx.lang_items().require(*lang_item).ok())
733 if let Some(def_id) = self.tcx.get_diagnostic_item(sym::Send) {
734 never_suggest_borrow.push(def_id);
737 let param_env = obligation.param_env;
739 // Try to apply the original trait binding obligation by borrowing.
740 let mut try_borrowing = |old_pred: ty::PolyTraitPredicate<'tcx>,
743 if blacklist.contains(&old_pred.def_id()) {
747 let orig_ty = old_pred.self_ty().skip_binder();
748 let mk_result = |new_ty| {
750 self.mk_trait_obligation_with_new_self_ty(param_env, old_pred, new_ty);
751 self.predicate_must_hold_modulo_regions(&obligation)
753 let imm_result = mk_result(self.tcx.mk_imm_ref(self.tcx.lifetimes.re_static, orig_ty));
754 let mut_result = mk_result(self.tcx.mk_mut_ref(self.tcx.lifetimes.re_static, orig_ty));
756 if imm_result || mut_result {
757 if let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) {
758 // We have a very specific type of error, where just borrowing this argument
759 // might solve the problem. In cases like this, the important part is the
760 // original type obligation, not the last one that failed, which is arbitrary.
761 // Because of this, we modify the error to refer to the original obligation and
762 // return early in the caller.
765 "the trait bound `{}: {}` is not satisfied",
767 old_pred.print_modifiers_and_trait_path(),
769 if has_custom_message {
772 err.message = vec![(msg, Style::NoStyle)];
774 if snippet.starts_with('&') {
775 // This is already a literal borrow and the obligation is failing
776 // somewhere else in the obligation chain. Do not suggest non-sense.
782 "expected an implementor of trait `{}`",
783 old_pred.print_modifiers_and_trait_path(),
787 // This if is to prevent a special edge-case
789 span.ctxt().outer_expn_data().kind,
790 ExpnKind::Root | ExpnKind::Desugaring(DesugaringKind::ForLoop)
792 // We don't want a borrowing suggestion on the fields in structs,
795 // the_foos: Vec<Foo>
799 if imm_result && mut_result {
800 err.span_suggestions(
802 "consider borrowing here",
803 ["&".to_string(), "&mut ".to_string()].into_iter(),
804 Applicability::MaybeIncorrect,
807 err.span_suggestion_verbose(
810 "consider{} borrowing here",
811 if mut_result { " mutably" } else { "" }
813 format!("&{}", if mut_result { "mut " } else { "" }),
814 Applicability::MaybeIncorrect,
824 if let ObligationCauseCode::ImplDerivedObligation(cause) = &*code {
825 try_borrowing(cause.derived.parent_trait_pred, &[])
826 } else if let ObligationCauseCode::BindingObligation(_, _)
827 | ObligationCauseCode::ItemObligation(_) = code
829 try_borrowing(poly_trait_pred, &never_suggest_borrow)
835 /// Whenever references are used by mistake, like `for (i, e) in &vec.iter().enumerate()`,
836 /// suggest removing these references until we reach a type that implements the trait.
837 fn suggest_remove_reference(
839 obligation: &PredicateObligation<'tcx>,
840 err: &mut Diagnostic,
841 trait_pred: ty::PolyTraitPredicate<'tcx>,
843 let span = obligation.cause.span;
845 let mut suggested = false;
846 if let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) {
848 snippet.chars().filter(|c| !c.is_whitespace()).take_while(|c| *c == '&').count();
849 if let Some('\'') = snippet.chars().filter(|c| !c.is_whitespace()).nth(refs_number) {
850 // Do not suggest removal of borrow from type arguments.
854 let Some(mut suggested_ty) = trait_pred.self_ty().no_bound_vars() else {
858 for refs_remaining in 0..refs_number {
859 let ty::Ref(_, inner_ty, _) = suggested_ty.kind() else {
862 suggested_ty = *inner_ty;
864 let new_obligation = self.mk_trait_obligation_with_new_self_ty(
865 obligation.param_env,
870 if self.predicate_may_hold(&new_obligation) {
875 .span_take_while(span, |c| c.is_whitespace() || *c == '&');
877 let remove_refs = refs_remaining + 1;
879 let msg = if remove_refs == 1 {
880 "consider removing the leading `&`-reference".to_string()
882 format!("consider removing {} leading `&`-references", remove_refs)
885 err.span_suggestion_short(
889 Applicability::MachineApplicable,
899 fn suggest_remove_await(&self, obligation: &PredicateObligation<'tcx>, err: &mut Diagnostic) {
900 let span = obligation.cause.span;
902 if let ObligationCauseCode::AwaitableExpr(hir_id) = obligation.cause.code().peel_derives() {
903 let hir = self.tcx.hir();
904 if let Some(node) = hir_id.and_then(|hir_id| hir.find(hir_id)) {
905 if let hir::Node::Expr(expr) = node {
906 // FIXME: use `obligation.predicate.kind()...trait_ref.self_ty()` to see if we have `()`
907 // and if not maybe suggest doing something else? If we kept the expression around we
908 // could also check if it is an fn call (very likely) and suggest changing *that*, if
909 // it is from the local crate.
910 err.span_suggestion_verbose(
911 expr.span.shrink_to_hi().with_hi(span.hi()),
912 "remove the `.await`",
914 Applicability::MachineApplicable,
916 // FIXME: account for associated `async fn`s.
917 if let hir::Expr { span, kind: hir::ExprKind::Call(base, _), .. } = expr {
918 if let ty::PredicateKind::Trait(pred) =
919 obligation.predicate.kind().skip_binder()
923 &format!("this call returns `{}`", pred.self_ty()),
926 if let Some(typeck_results) =
927 self.in_progress_typeck_results.map(|t| t.borrow())
928 && let ty = typeck_results.expr_ty_adjusted(base)
929 && let ty::FnDef(def_id, _substs) = ty.kind()
930 && let Some(hir::Node::Item(hir::Item { span, ident, .. })) =
931 hir.get_if_local(*def_id)
933 err.span_suggestion_verbose(
936 "alternatively, consider making `fn {}` asynchronous",
939 "async ".to_string(),
940 Applicability::MaybeIncorrect,
949 /// Check if the trait bound is implemented for a different mutability and note it in the
951 fn suggest_change_mut(
953 obligation: &PredicateObligation<'tcx>,
954 err: &mut Diagnostic,
955 trait_pred: ty::PolyTraitPredicate<'tcx>,
957 let points_at_arg = matches!(
958 obligation.cause.code(),
959 ObligationCauseCode::FunctionArgumentObligation { .. },
962 let span = obligation.cause.span;
963 if let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) {
965 snippet.chars().filter(|c| !c.is_whitespace()).take_while(|c| *c == '&').count();
966 if let Some('\'') = snippet.chars().filter(|c| !c.is_whitespace()).nth(refs_number) {
967 // Do not suggest removal of borrow from type arguments.
970 let trait_pred = self.resolve_vars_if_possible(trait_pred);
971 if trait_pred.has_infer_types_or_consts() {
972 // Do not ICE while trying to find if a reborrow would succeed on a trait with
973 // unresolved bindings.
977 if let ty::Ref(region, t_type, mutability) = *trait_pred.skip_binder().self_ty().kind()
979 if region.is_late_bound() || t_type.has_escaping_bound_vars() {
980 // Avoid debug assertion in `mk_obligation_for_def_id`.
982 // If the self type has escaping bound vars then it's not
983 // going to be the type of an expression, so the suggestion
984 // probably won't apply anyway.
988 let suggested_ty = match mutability {
989 hir::Mutability::Mut => self.tcx.mk_imm_ref(region, t_type),
990 hir::Mutability::Not => self.tcx.mk_mut_ref(region, t_type),
993 let new_obligation = self.mk_trait_obligation_with_new_self_ty(
994 obligation.param_env,
998 let suggested_ty_would_satisfy_obligation = self
999 .evaluate_obligation_no_overflow(&new_obligation)
1000 .must_apply_modulo_regions();
1001 if suggested_ty_would_satisfy_obligation {
1006 .span_take_while(span, |c| c.is_whitespace() || *c == '&');
1007 if points_at_arg && mutability == hir::Mutability::Not && refs_number > 0 {
1008 err.span_suggestion_verbose(
1010 "consider changing this borrow's mutability",
1011 "&mut ".to_string(),
1012 Applicability::MachineApplicable,
1016 "`{}` is implemented for `{:?}`, but not for `{:?}`",
1017 trait_pred.print_modifiers_and_trait_path(),
1019 trait_pred.skip_binder().self_ty(),
1027 fn suggest_semicolon_removal(
1029 obligation: &PredicateObligation<'tcx>,
1030 err: &mut Diagnostic,
1032 trait_pred: ty::PolyTraitPredicate<'tcx>,
1034 let hir = self.tcx.hir();
1035 let parent_node = hir.get_parent_node(obligation.cause.body_id);
1036 let node = hir.find(parent_node);
1037 if let Some(hir::Node::Item(hir::Item { kind: hir::ItemKind::Fn(sig, _, body_id), .. })) = node
1038 && let body = hir.body(*body_id)
1039 && let hir::ExprKind::Block(blk, _) = &body.value.kind
1040 && sig.decl.output.span().overlaps(span)
1041 && blk.expr.is_none()
1042 && *trait_pred.self_ty().skip_binder().kind() == ty::Tuple(ty::List::empty())
1043 // FIXME(estebank): When encountering a method with a trait
1044 // bound not satisfied in the return type with a body that has
1045 // no return, suggest removal of semicolon on last statement.
1046 // Once that is added, close #54771.
1047 && let Some(stmt) = blk.stmts.last()
1048 && let hir::StmtKind::Semi(_) = stmt.kind
1050 let sp = self.tcx.sess.source_map().end_point(stmt.span);
1051 err.span_label(sp, "consider removing this semicolon");
1057 fn return_type_span(&self, obligation: &PredicateObligation<'tcx>) -> Option<Span> {
1058 let hir = self.tcx.hir();
1059 let parent_node = hir.get_parent_node(obligation.cause.body_id);
1060 let Some(hir::Node::Item(hir::Item { kind: hir::ItemKind::Fn(sig, ..), .. })) = hir.find(parent_node) else {
1064 if let hir::FnRetTy::Return(ret_ty) = sig.decl.output { Some(ret_ty.span) } else { None }
1067 /// If all conditions are met to identify a returned `dyn Trait`, suggest using `impl Trait` if
1068 /// applicable and signal that the error has been expanded appropriately and needs to be
1070 fn suggest_impl_trait(
1072 err: &mut Diagnostic,
1074 obligation: &PredicateObligation<'tcx>,
1075 trait_pred: ty::PolyTraitPredicate<'tcx>,
1077 match obligation.cause.code().peel_derives() {
1078 // Only suggest `impl Trait` if the return type is unsized because it is `dyn Trait`.
1079 ObligationCauseCode::SizedReturnType => {}
1083 let hir = self.tcx.hir();
1084 let parent_node = hir.get_parent_node(obligation.cause.body_id);
1085 let node = hir.find(parent_node);
1086 let Some(hir::Node::Item(hir::Item {
1087 kind: hir::ItemKind::Fn(sig, _, body_id),
1093 let body = hir.body(*body_id);
1094 let trait_pred = self.resolve_vars_if_possible(trait_pred);
1095 let ty = trait_pred.skip_binder().self_ty();
1096 let is_object_safe = match ty.kind() {
1097 ty::Dynamic(predicates, _) => {
1098 // If the `dyn Trait` is not object safe, do not suggest `Box<dyn Trait>`.
1101 .map_or(true, |def_id| self.tcx.object_safety_violations(def_id).is_empty())
1103 // We only want to suggest `impl Trait` to `dyn Trait`s.
1104 // For example, `fn foo() -> str` needs to be filtered out.
1108 let hir::FnRetTy::Return(ret_ty) = sig.decl.output else {
1112 // Use `TypeVisitor` instead of the output type directly to find the span of `ty` for
1113 // cases like `fn foo() -> (dyn Trait, i32) {}`.
1114 // Recursively look for `TraitObject` types and if there's only one, use that span to
1115 // suggest `impl Trait`.
1117 // Visit to make sure there's a single `return` type to suggest `impl Trait`,
1118 // otherwise suggest using `Box<dyn Trait>` or an enum.
1119 let mut visitor = ReturnsVisitor::default();
1120 visitor.visit_body(&body);
1122 let typeck_results = self.in_progress_typeck_results.map(|t| t.borrow()).unwrap();
1124 let mut ret_types = visitor
1127 .filter_map(|expr| typeck_results.node_type_opt(expr.hir_id))
1128 .map(|ty| self.resolve_vars_if_possible(ty));
1129 let (last_ty, all_returns_have_same_type, only_never_return) = ret_types.clone().fold(
1131 |(last_ty, mut same, only_never_return): (std::option::Option<Ty<'_>>, bool, bool),
1133 let ty = self.resolve_vars_if_possible(ty);
1135 !matches!(ty.kind(), ty::Error(_))
1136 && last_ty.map_or(true, |last_ty| {
1137 // FIXME: ideally we would use `can_coerce` here instead, but `typeck` comes
1138 // *after* in the dependency graph.
1139 match (ty.kind(), last_ty.kind()) {
1140 (Infer(InferTy::IntVar(_)), Infer(InferTy::IntVar(_)))
1141 | (Infer(InferTy::FloatVar(_)), Infer(InferTy::FloatVar(_)))
1142 | (Infer(InferTy::FreshIntTy(_)), Infer(InferTy::FreshIntTy(_)))
1144 Infer(InferTy::FreshFloatTy(_)),
1145 Infer(InferTy::FreshFloatTy(_)),
1150 (Some(ty), same, only_never_return && matches!(ty.kind(), ty::Never))
1153 let all_returns_conform_to_trait =
1154 if let Some(ty_ret_ty) = typeck_results.node_type_opt(ret_ty.hir_id) {
1155 match ty_ret_ty.kind() {
1156 ty::Dynamic(predicates, _) => {
1157 let cause = ObligationCause::misc(ret_ty.span, ret_ty.hir_id);
1158 let param_env = ty::ParamEnv::empty();
1160 || ret_types.all(|returned_ty| {
1161 predicates.iter().all(|predicate| {
1162 let pred = predicate.with_self_ty(self.tcx, returned_ty);
1163 let obl = Obligation::new(cause.clone(), param_env, pred);
1164 self.predicate_may_hold(&obl)
1174 let sm = self.tcx.sess.source_map();
1175 let (true, hir::TyKind::TraitObject(..), Ok(snippet), true) = (
1176 // Verify that we're dealing with a return `dyn Trait`
1177 ret_ty.span.overlaps(span),
1179 sm.span_to_snippet(ret_ty.span),
1180 // If any of the return types does not conform to the trait, then we can't
1181 // suggest `impl Trait` nor trait objects: it is a type mismatch error.
1182 all_returns_conform_to_trait,
1186 err.code(error_code!(E0746));
1187 err.set_primary_message("return type cannot have an unboxed trait object");
1188 err.children.clear();
1189 let impl_trait_msg = "for information on `impl Trait`, see \
1190 <https://doc.rust-lang.org/book/ch10-02-traits.html\
1191 #returning-types-that-implement-traits>";
1192 let trait_obj_msg = "for information on trait objects, see \
1193 <https://doc.rust-lang.org/book/ch17-02-trait-objects.html\
1194 #using-trait-objects-that-allow-for-values-of-different-types>";
1195 let has_dyn = snippet.split_whitespace().next().map_or(false, |s| s == "dyn");
1196 let trait_obj = if has_dyn { &snippet[4..] } else { &snippet };
1197 if only_never_return {
1198 // No return paths, probably using `panic!()` or similar.
1199 // Suggest `-> T`, `-> impl Trait`, and if `Trait` is object safe, `-> Box<dyn Trait>`.
1200 suggest_trait_object_return_type_alternatives(
1206 } else if let (Some(last_ty), true) = (last_ty, all_returns_have_same_type) {
1207 // Suggest `-> impl Trait`.
1208 err.span_suggestion(
1211 "use `impl {1}` as the return type, as all return paths are of type `{}`, \
1212 which implements `{1}`",
1215 format!("impl {}", trait_obj),
1216 Applicability::MachineApplicable,
1218 err.note(impl_trait_msg);
1221 // Suggest `-> Box<dyn Trait>` and `Box::new(returned_value)`.
1222 // Get all the return values and collect their span and suggestion.
1223 let mut suggestions: Vec<_> = visitor
1228 (expr.span.shrink_to_lo(), "Box::new(".to_string()),
1229 (expr.span.shrink_to_hi(), ")".to_string()),
1234 if !suggestions.is_empty() {
1235 // Add the suggestion for the return type.
1236 suggestions.push((ret_ty.span, format!("Box<dyn {}>", trait_obj)));
1237 err.multipart_suggestion(
1238 "return a boxed trait object instead",
1240 Applicability::MaybeIncorrect,
1244 // This is currently not possible to trigger because E0038 takes precedence, but
1245 // leave it in for completeness in case anything changes in an earlier stage.
1247 "if trait `{}` were object-safe, you could return a trait object",
1251 err.note(trait_obj_msg);
1253 "if all the returned values were of the same type you could use `impl {}` as the \
1257 err.note(impl_trait_msg);
1258 err.note("you can create a new `enum` with a variant for each returned type");
1263 fn point_at_returns_when_relevant(
1265 err: &mut Diagnostic,
1266 obligation: &PredicateObligation<'tcx>,
1268 match obligation.cause.code().peel_derives() {
1269 ObligationCauseCode::SizedReturnType => {}
1273 let hir = self.tcx.hir();
1274 let parent_node = hir.get_parent_node(obligation.cause.body_id);
1275 let node = hir.find(parent_node);
1276 if let Some(hir::Node::Item(hir::Item { kind: hir::ItemKind::Fn(_, _, body_id), .. })) =
1279 let body = hir.body(*body_id);
1280 // Point at all the `return`s in the function as they have failed trait bounds.
1281 let mut visitor = ReturnsVisitor::default();
1282 visitor.visit_body(&body);
1283 let typeck_results = self.in_progress_typeck_results.map(|t| t.borrow()).unwrap();
1284 for expr in &visitor.returns {
1285 if let Some(returned_ty) = typeck_results.node_type_opt(expr.hir_id) {
1286 let ty = self.resolve_vars_if_possible(returned_ty);
1287 err.span_label(expr.span, &format!("this returned value is of type `{}`", ty));
1293 fn report_closure_arg_mismatch(
1296 found_span: Option<Span>,
1297 expected_ref: ty::PolyTraitRef<'tcx>,
1298 found: ty::PolyTraitRef<'tcx>,
1299 ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
1300 crate fn build_fn_sig_string<'tcx>(
1302 trait_ref: ty::PolyTraitRef<'tcx>,
1304 let inputs = trait_ref.skip_binder().substs.type_at(1);
1305 let sig = match inputs.kind() {
1307 if tcx.fn_trait_kind_from_lang_item(trait_ref.def_id()).is_some() =>
1311 tcx.mk_ty_infer(ty::TyVar(ty::TyVid::from_u32(0))),
1313 hir::Unsafety::Normal,
1318 std::iter::once(inputs),
1319 tcx.mk_ty_infer(ty::TyVar(ty::TyVid::from_u32(0))),
1321 hir::Unsafety::Normal,
1325 trait_ref.rebind(sig).to_string()
1328 let argument_kind = match expected_ref.skip_binder().self_ty().kind() {
1329 ty::Closure(..) => "closure",
1330 ty::Generator(..) => "generator",
1333 let span = self.tcx.sess.source_map().guess_head_span(span);
1334 let mut err = struct_span_err!(
1338 "type mismatch in {} arguments",
1342 let found_str = format!("expected signature of `{}`", build_fn_sig_string(self.tcx, found));
1343 err.span_label(span, found_str);
1345 let found_span = found_span.unwrap_or(span);
1347 format!("found signature of `{}`", build_fn_sig_string(self.tcx, expected_ref));
1348 err.span_label(found_span, expected_str);
1353 fn suggest_fully_qualified_path(
1355 err: &mut Diagnostic,
1360 if let Some(assoc_item) = self.tcx.opt_associated_item(item_def_id) {
1361 if let ty::AssocKind::Const | ty::AssocKind::Type = assoc_item.kind {
1363 "{}s cannot be accessed directly on a `trait`, they can only be \
1364 accessed through a specific `impl`",
1365 assoc_item.kind.as_def_kind().descr(item_def_id)
1367 err.span_suggestion(
1369 "use the fully qualified path to an implementation",
1370 format!("<Type as {}>::{}", self.tcx.def_path_str(trait_ref), assoc_item.name),
1371 Applicability::HasPlaceholders,
1377 /// Adds an async-await specific note to the diagnostic when the future does not implement
1378 /// an auto trait because of a captured type.
1381 /// note: future does not implement `Qux` as this value is used across an await
1382 /// --> $DIR/issue-64130-3-other.rs:17:5
1384 /// LL | let x = Foo;
1385 /// | - has type `Foo`
1386 /// LL | baz().await;
1387 /// | ^^^^^^^^^^^ await occurs here, with `x` maybe used later
1389 /// | - `x` is later dropped here
1392 /// When the diagnostic does not implement `Send` or `Sync` specifically, then the diagnostic
1393 /// is "replaced" with a different message and a more specific error.
1396 /// error: future cannot be sent between threads safely
1397 /// --> $DIR/issue-64130-2-send.rs:21:5
1399 /// LL | fn is_send<T: Send>(t: T) { }
1400 /// | ---- required by this bound in `is_send`
1402 /// LL | is_send(bar());
1403 /// | ^^^^^^^ future returned by `bar` is not send
1405 /// = help: within `impl std::future::Future`, the trait `std::marker::Send` is not
1406 /// implemented for `Foo`
1407 /// note: future is not send as this value is used across an await
1408 /// --> $DIR/issue-64130-2-send.rs:15:5
1410 /// LL | let x = Foo;
1411 /// | - has type `Foo`
1412 /// LL | baz().await;
1413 /// | ^^^^^^^^^^^ await occurs here, with `x` maybe used later
1415 /// | - `x` is later dropped here
1418 /// Returns `true` if an async-await specific note was added to the diagnostic.
1419 fn maybe_note_obligation_cause_for_async_await(
1421 err: &mut Diagnostic,
1422 obligation: &PredicateObligation<'tcx>,
1425 "maybe_note_obligation_cause_for_async_await: obligation.predicate={:?} \
1426 obligation.cause.span={:?}",
1427 obligation.predicate, obligation.cause.span
1429 let hir = self.tcx.hir();
1431 // Attempt to detect an async-await error by looking at the obligation causes, looking
1432 // for a generator to be present.
1434 // When a future does not implement a trait because of a captured type in one of the
1435 // generators somewhere in the call stack, then the result is a chain of obligations.
1437 // Given an `async fn` A that calls an `async fn` B which captures a non-send type and that
1438 // future is passed as an argument to a function C which requires a `Send` type, then the
1439 // chain looks something like this:
1441 // - `BuiltinDerivedObligation` with a generator witness (B)
1442 // - `BuiltinDerivedObligation` with a generator (B)
1443 // - `BuiltinDerivedObligation` with `std::future::GenFuture` (B)
1444 // - `BuiltinDerivedObligation` with `impl std::future::Future` (B)
1445 // - `BuiltinDerivedObligation` with `impl std::future::Future` (B)
1446 // - `BuiltinDerivedObligation` with a generator witness (A)
1447 // - `BuiltinDerivedObligation` with a generator (A)
1448 // - `BuiltinDerivedObligation` with `std::future::GenFuture` (A)
1449 // - `BuiltinDerivedObligation` with `impl std::future::Future` (A)
1450 // - `BuiltinDerivedObligation` with `impl std::future::Future` (A)
1451 // - `BindingObligation` with `impl_send (Send requirement)
1453 // The first obligation in the chain is the most useful and has the generator that captured
1454 // the type. The last generator (`outer_generator` below) has information about where the
1455 // bound was introduced. At least one generator should be present for this diagnostic to be
1457 let (mut trait_ref, mut target_ty) = match obligation.predicate.kind().skip_binder() {
1458 ty::PredicateKind::Trait(p) => (Some(p), Some(p.self_ty())),
1461 let mut generator = None;
1462 let mut outer_generator = None;
1463 let mut next_code = Some(obligation.cause.code());
1465 let mut seen_upvar_tys_infer_tuple = false;
1467 while let Some(code) = next_code {
1468 debug!("maybe_note_obligation_cause_for_async_await: code={:?}", code);
1470 ObligationCauseCode::FunctionArgumentObligation { parent_code, .. } => {
1471 next_code = Some(parent_code.as_ref());
1473 ObligationCauseCode::ImplDerivedObligation(cause) => {
1474 let ty = cause.derived.parent_trait_pred.skip_binder().self_ty();
1476 "maybe_note_obligation_cause_for_async_await: ImplDerived \
1477 parent_trait_ref={:?} self_ty.kind={:?}",
1478 cause.derived.parent_trait_pred,
1483 ty::Generator(did, ..) => {
1484 generator = generator.or(Some(did));
1485 outer_generator = Some(did);
1487 ty::GeneratorWitness(..) => {}
1488 ty::Tuple(_) if !seen_upvar_tys_infer_tuple => {
1489 // By introducing a tuple of upvar types into the chain of obligations
1490 // of a generator, the first non-generator item is now the tuple itself,
1491 // we shall ignore this.
1493 seen_upvar_tys_infer_tuple = true;
1495 _ if generator.is_none() => {
1496 trait_ref = Some(cause.derived.parent_trait_pred.skip_binder());
1497 target_ty = Some(ty);
1502 next_code = Some(cause.derived.parent_code.as_ref());
1504 ObligationCauseCode::DerivedObligation(derived_obligation)
1505 | ObligationCauseCode::BuiltinDerivedObligation(derived_obligation) => {
1506 let ty = derived_obligation.parent_trait_pred.skip_binder().self_ty();
1508 "maybe_note_obligation_cause_for_async_await: \
1509 parent_trait_ref={:?} self_ty.kind={:?}",
1510 derived_obligation.parent_trait_pred,
1515 ty::Generator(did, ..) => {
1516 generator = generator.or(Some(did));
1517 outer_generator = Some(did);
1519 ty::GeneratorWitness(..) => {}
1520 ty::Tuple(_) if !seen_upvar_tys_infer_tuple => {
1521 // By introducing a tuple of upvar types into the chain of obligations
1522 // of a generator, the first non-generator item is now the tuple itself,
1523 // we shall ignore this.
1525 seen_upvar_tys_infer_tuple = true;
1527 _ if generator.is_none() => {
1528 trait_ref = Some(derived_obligation.parent_trait_pred.skip_binder());
1529 target_ty = Some(ty);
1534 next_code = Some(derived_obligation.parent_code.as_ref());
1540 // Only continue if a generator was found.
1541 debug!(?generator, ?trait_ref, ?target_ty, "maybe_note_obligation_cause_for_async_await");
1542 let (Some(generator_did), Some(trait_ref), Some(target_ty)) = (generator, trait_ref, target_ty) else {
1546 let span = self.tcx.def_span(generator_did);
1548 let in_progress_typeck_results = self.in_progress_typeck_results.map(|t| t.borrow());
1549 let generator_did_root = self.tcx.typeck_root_def_id(generator_did);
1551 "maybe_note_obligation_cause_for_async_await: generator_did={:?} \
1552 generator_did_root={:?} in_progress_typeck_results.hir_owner={:?} span={:?}",
1555 in_progress_typeck_results.as_ref().map(|t| t.hir_owner),
1559 let generator_body = generator_did
1561 .map(|def_id| hir.local_def_id_to_hir_id(def_id))
1562 .and_then(|hir_id| hir.maybe_body_owned_by(hir_id))
1563 .map(|body_id| hir.body(body_id));
1564 let mut visitor = AwaitsVisitor::default();
1565 if let Some(body) = generator_body {
1566 visitor.visit_body(body);
1568 debug!("maybe_note_obligation_cause_for_async_await: awaits = {:?}", visitor.awaits);
1570 // Look for a type inside the generator interior that matches the target type to get
1572 let target_ty_erased = self.tcx.erase_regions(target_ty);
1573 let ty_matches = |ty| -> bool {
1574 // Careful: the regions for types that appear in the
1575 // generator interior are not generally known, so we
1576 // want to erase them when comparing (and anyway,
1577 // `Send` and other bounds are generally unaffected by
1578 // the choice of region). When erasing regions, we
1579 // also have to erase late-bound regions. This is
1580 // because the types that appear in the generator
1581 // interior generally contain "bound regions" to
1582 // represent regions that are part of the suspended
1583 // generator frame. Bound regions are preserved by
1584 // `erase_regions` and so we must also call
1585 // `erase_late_bound_regions`.
1586 let ty_erased = self.tcx.erase_late_bound_regions(ty);
1587 let ty_erased = self.tcx.erase_regions(ty_erased);
1588 let eq = ty_erased == target_ty_erased;
1590 "maybe_note_obligation_cause_for_async_await: ty_erased={:?} \
1591 target_ty_erased={:?} eq={:?}",
1592 ty_erased, target_ty_erased, eq
1597 let mut interior_or_upvar_span = None;
1598 let mut interior_extra_info = None;
1600 // Get the typeck results from the infcx if the generator is the function we are currently
1601 // type-checking; otherwise, get them by performing a query. This is needed to avoid
1602 // cycles. If we can't use resolved types because the generator comes from another crate,
1603 // we still provide a targeted error but without all the relevant spans.
1604 let query_typeck_results;
1605 let typeck_results: Option<&TypeckResults<'tcx>> = match &in_progress_typeck_results {
1606 Some(t) if t.hir_owner.to_def_id() == generator_did_root => Some(&t),
1607 _ if generator_did.is_local() => {
1608 query_typeck_results = self.tcx.typeck(generator_did.expect_local());
1609 Some(&query_typeck_results)
1611 _ => None, // Do not ICE on closure typeck (#66868).
1613 if let Some(typeck_results) = typeck_results {
1614 if let Some(upvars) = self.tcx.upvars_mentioned(generator_did) {
1615 interior_or_upvar_span = upvars.iter().find_map(|(upvar_id, upvar)| {
1616 let upvar_ty = typeck_results.node_type(*upvar_id);
1617 let upvar_ty = self.resolve_vars_if_possible(upvar_ty);
1618 if ty_matches(ty::Binder::dummy(upvar_ty)) {
1619 Some(GeneratorInteriorOrUpvar::Upvar(upvar.span))
1626 // The generator interior types share the same binders
1627 if let Some(cause) =
1628 typeck_results.generator_interior_types.as_ref().skip_binder().iter().find(
1629 |ty::GeneratorInteriorTypeCause { ty, .. }| {
1630 ty_matches(typeck_results.generator_interior_types.rebind(*ty))
1634 // Check to see if any awaited expressions have the target type.
1635 let from_awaited_ty = visitor
1638 .map(|id| hir.expect_expr(id))
1639 .find(|await_expr| {
1640 ty_matches(ty::Binder::dummy(typeck_results.expr_ty_adjusted(&await_expr)))
1642 .map(|expr| expr.span);
1643 let ty::GeneratorInteriorTypeCause { span, scope_span, yield_span, expr, .. } =
1646 interior_or_upvar_span = Some(GeneratorInteriorOrUpvar::Interior(*span));
1647 interior_extra_info = Some((*scope_span, *yield_span, *expr, from_awaited_ty));
1650 interior_or_upvar_span = Some(GeneratorInteriorOrUpvar::Interior(span));
1653 if let Some(interior_or_upvar_span) = interior_or_upvar_span {
1654 self.note_obligation_cause_for_async_await(
1656 interior_or_upvar_span,
1657 interior_extra_info,
1672 /// Unconditionally adds the diagnostic note described in
1673 /// `maybe_note_obligation_cause_for_async_await`'s documentation comment.
1674 fn note_obligation_cause_for_async_await(
1676 err: &mut Diagnostic,
1677 interior_or_upvar_span: GeneratorInteriorOrUpvar,
1678 interior_extra_info: Option<(Option<Span>, Span, Option<hir::HirId>, Option<Span>)>,
1679 inner_generator_body: Option<&hir::Body<'tcx>>,
1680 outer_generator: Option<DefId>,
1681 trait_pred: ty::TraitPredicate<'tcx>,
1682 target_ty: Ty<'tcx>,
1683 typeck_results: Option<&ty::TypeckResults<'tcx>>,
1684 obligation: &PredicateObligation<'tcx>,
1685 next_code: Option<&ObligationCauseCode<'tcx>>,
1687 let source_map = self.tcx.sess.source_map();
1689 let is_async = inner_generator_body
1690 .and_then(|body| body.generator_kind())
1691 .map(|generator_kind| matches!(generator_kind, hir::GeneratorKind::Async(..)))
1693 let (await_or_yield, an_await_or_yield) =
1694 if is_async { ("await", "an await") } else { ("yield", "a yield") };
1695 let future_or_generator = if is_async { "future" } else { "generator" };
1697 // Special case the primary error message when send or sync is the trait that was
1699 let hir = self.tcx.hir();
1700 let trait_explanation = if let Some(name @ (sym::Send | sym::Sync)) =
1701 self.tcx.get_diagnostic_name(trait_pred.def_id())
1703 let (trait_name, trait_verb) =
1704 if name == sym::Send { ("`Send`", "sent") } else { ("`Sync`", "shared") };
1707 err.set_primary_message(format!(
1708 "{} cannot be {} between threads safely",
1709 future_or_generator, trait_verb
1712 let original_span = err.span.primary_span().unwrap();
1713 let original_span = self.tcx.sess.source_map().guess_head_span(original_span);
1714 let mut span = MultiSpan::from_span(original_span);
1716 let message = outer_generator
1717 .and_then(|generator_did| {
1718 Some(match self.tcx.generator_kind(generator_did).unwrap() {
1719 GeneratorKind::Gen => format!("generator is not {}", trait_name),
1720 GeneratorKind::Async(AsyncGeneratorKind::Fn) => self
1722 .parent(generator_did)
1723 .and_then(|parent_did| parent_did.as_local())
1724 .map(|parent_did| hir.local_def_id_to_hir_id(parent_did))
1725 .and_then(|parent_hir_id| hir.opt_name(parent_hir_id))
1727 format!("future returned by `{}` is not {}", name, trait_name)
1729 GeneratorKind::Async(AsyncGeneratorKind::Block) => {
1730 format!("future created by async block is not {}", trait_name)
1732 GeneratorKind::Async(AsyncGeneratorKind::Closure) => {
1733 format!("future created by async closure is not {}", trait_name)
1737 .unwrap_or_else(|| format!("{} is not {}", future_or_generator, trait_name));
1739 span.push_span_label(original_span, message);
1742 format!("is not {}", trait_name)
1744 format!("does not implement `{}`", trait_pred.print_modifiers_and_trait_path())
1747 let mut explain_yield = |interior_span: Span,
1749 scope_span: Option<Span>| {
1750 let mut span = MultiSpan::from_span(yield_span);
1751 if let Ok(snippet) = source_map.span_to_snippet(interior_span) {
1752 // #70935: If snippet contains newlines, display "the value" instead
1753 // so that we do not emit complex diagnostics.
1754 let snippet = &format!("`{}`", snippet);
1755 let snippet = if snippet.contains('\n') { "the value" } else { snippet };
1756 // note: future is not `Send` as this value is used across an await
1757 // --> $DIR/issue-70935-complex-spans.rs:13:9
1759 // LL | baz(|| async {
1760 // | ______________-
1763 // LL | | foo(tx.clone());
1765 // | | - ^^^^^^ await occurs here, with value maybe used later
1767 // | has type `closure` which is not `Send`
1768 // note: value is later dropped here
1772 span.push_span_label(
1774 format!("{} occurs here, with {} maybe used later", await_or_yield, snippet),
1776 span.push_span_label(
1778 format!("has type `{}` which {}", target_ty, trait_explanation),
1780 // If available, use the scope span to annotate the drop location.
1781 let mut scope_note = None;
1782 if let Some(scope_span) = scope_span {
1783 let scope_span = source_map.end_point(scope_span);
1785 let msg = format!("{} is later dropped here", snippet);
1786 if source_map.is_multiline(yield_span.between(scope_span)) {
1787 span.push_span_label(scope_span, msg);
1789 scope_note = Some((scope_span, msg));
1795 "{} {} as this value is used across {}",
1796 future_or_generator, trait_explanation, an_await_or_yield
1799 if let Some((span, msg)) = scope_note {
1800 err.span_note(span, &msg);
1804 match interior_or_upvar_span {
1805 GeneratorInteriorOrUpvar::Interior(interior_span) => {
1806 if let Some((scope_span, yield_span, expr, from_awaited_ty)) = interior_extra_info {
1807 if let Some(await_span) = from_awaited_ty {
1808 // The type causing this obligation is one being awaited at await_span.
1809 let mut span = MultiSpan::from_span(await_span);
1810 span.push_span_label(
1813 "await occurs here on type `{}`, which {}",
1814 target_ty, trait_explanation
1820 "future {not_trait} as it awaits another future which {not_trait}",
1821 not_trait = trait_explanation
1825 // Look at the last interior type to get a span for the `.await`.
1827 "note_obligation_cause_for_async_await generator_interior_types: {:#?}",
1828 typeck_results.as_ref().map(|t| &t.generator_interior_types)
1830 explain_yield(interior_span, yield_span, scope_span);
1833 if let Some(expr_id) = expr {
1834 let expr = hir.expect_expr(expr_id);
1835 debug!("target_ty evaluated from {:?}", expr);
1837 let parent = hir.get_parent_node(expr_id);
1838 if let Some(hir::Node::Expr(e)) = hir.find(parent) {
1839 let parent_span = hir.span(parent);
1840 let parent_did = parent.owner.to_def_id();
1843 // fn foo(&self) -> i32 {}
1846 // ^^^^^^^ a temporary `&T` created inside this method call due to `&self`
1849 let is_region_borrow = if let Some(typeck_results) = typeck_results {
1851 .expr_adjustments(expr)
1853 .any(|adj| adj.is_region_borrow())
1859 // struct Foo(*const u8);
1860 // bar(Foo(std::ptr::null())).await;
1861 // ^^^^^^^^^^^^^^^^^^^^^ raw-ptr `*T` created inside this struct ctor.
1863 debug!("parent_def_kind: {:?}", self.tcx.def_kind(parent_did));
1864 let is_raw_borrow_inside_fn_like_call =
1865 match self.tcx.def_kind(parent_did) {
1866 DefKind::Fn | DefKind::Ctor(..) => target_ty.is_unsafe_ptr(),
1869 if let Some(typeck_results) = typeck_results {
1870 if (typeck_results.is_method_call(e) && is_region_borrow)
1871 || is_raw_borrow_inside_fn_like_call
1875 "consider moving this into a `let` \
1876 binding to create a shorter lived borrow",
1884 GeneratorInteriorOrUpvar::Upvar(upvar_span) => {
1885 // `Some(ref_ty)` if `target_ty` is `&T` and `T` fails to impl `Sync`
1886 let refers_to_non_sync = match target_ty.kind() {
1887 ty::Ref(_, ref_ty, _) => match self.evaluate_obligation(&obligation) {
1888 Ok(eval) if !eval.may_apply() => Some(ref_ty),
1894 let (span_label, span_note) = match refers_to_non_sync {
1895 // if `target_ty` is `&T` and `T` fails to impl `Sync`,
1896 // include suggestions to make `T: Sync` so that `&T: Send`
1899 "has type `{}` which {}, because `{}` is not `Sync`",
1900 target_ty, trait_explanation, ref_ty
1903 "captured value {} because `&` references cannot be sent unless their referent is `Sync`",
1908 format!("has type `{}` which {}", target_ty, trait_explanation),
1909 format!("captured value {}", trait_explanation),
1913 let mut span = MultiSpan::from_span(upvar_span);
1914 span.push_span_label(upvar_span, span_label);
1915 err.span_note(span, &span_note);
1919 // Add a note for the item obligation that remains - normally a note pointing to the
1920 // bound that introduced the obligation (e.g. `T: Send`).
1921 debug!("note_obligation_cause_for_async_await: next_code={:?}", next_code);
1922 self.note_obligation_cause_code(
1924 &obligation.predicate,
1925 obligation.param_env,
1928 &mut Default::default(),
1932 fn note_obligation_cause_code<T>(
1934 err: &mut Diagnostic,
1936 param_env: ty::ParamEnv<'tcx>,
1937 cause_code: &ObligationCauseCode<'tcx>,
1938 obligated_types: &mut Vec<Ty<'tcx>>,
1939 seen_requirements: &mut FxHashSet<DefId>,
1945 ObligationCauseCode::ExprAssignable
1946 | ObligationCauseCode::MatchExpressionArm { .. }
1947 | ObligationCauseCode::Pattern { .. }
1948 | ObligationCauseCode::IfExpression { .. }
1949 | ObligationCauseCode::IfExpressionWithNoElse
1950 | ObligationCauseCode::MainFunctionType
1951 | ObligationCauseCode::StartFunctionType
1952 | ObligationCauseCode::IntrinsicType
1953 | ObligationCauseCode::MethodReceiver
1954 | ObligationCauseCode::ReturnNoExpression
1955 | ObligationCauseCode::UnifyReceiver(..)
1956 | ObligationCauseCode::OpaqueType
1957 | ObligationCauseCode::MiscObligation
1958 | ObligationCauseCode::WellFormed(..)
1959 | ObligationCauseCode::MatchImpl(..)
1960 | ObligationCauseCode::ReturnType
1961 | ObligationCauseCode::ReturnValue(_)
1962 | ObligationCauseCode::BlockTailExpression(_)
1963 | ObligationCauseCode::AwaitableExpr(_)
1964 | ObligationCauseCode::ForLoopIterator
1965 | ObligationCauseCode::QuestionMark
1966 | ObligationCauseCode::CheckAssociatedTypeBounds { .. }
1967 | ObligationCauseCode::LetElse
1968 | ObligationCauseCode::BinOp { .. } => {}
1969 ObligationCauseCode::SliceOrArrayElem => {
1970 err.note("slice and array elements must have `Sized` type");
1972 ObligationCauseCode::TupleElem => {
1973 err.note("only the last element of a tuple may have a dynamically sized type");
1975 ObligationCauseCode::ProjectionWf(data) => {
1976 err.note(&format!("required so that the projection `{}` is well-formed", data,));
1978 ObligationCauseCode::ReferenceOutlivesReferent(ref_ty) => {
1980 "required so that reference `{}` does not outlive its referent",
1984 ObligationCauseCode::ObjectTypeBound(object_ty, region) => {
1986 "required so that the lifetime bound of `{}` for `{}` is satisfied",
1990 ObligationCauseCode::ItemObligation(_item_def_id) => {
1991 // We hold the `DefId` of the item introducing the obligation, but displaying it
1992 // doesn't add user usable information. It always point at an associated item.
1994 ObligationCauseCode::BindingObligation(item_def_id, span) => {
1995 let item_name = tcx.def_path_str(item_def_id);
1996 let mut multispan = MultiSpan::from(span);
1997 if let Some(ident) = tcx.opt_item_name(item_def_id) {
1998 let sm = tcx.sess.source_map();
2000 match (sm.lookup_line(ident.span.hi()), sm.lookup_line(span.lo())) {
2001 (Ok(l), Ok(r)) => l.line == r.line,
2004 if !ident.span.overlaps(span) && !same_line {
2006 .push_span_label(ident.span, "required by a bound in this".to_string());
2009 let descr = format!("required by a bound in `{}`", item_name);
2010 if span != DUMMY_SP {
2011 let msg = format!("required by this bound in `{}`", item_name);
2012 multispan.push_span_label(span, msg);
2013 err.span_note(multispan, &descr);
2015 err.span_note(tcx.def_span(item_def_id), &descr);
2018 ObligationCauseCode::ObjectCastObligation(object_ty) => {
2020 "required for the cast to the object type `{}`",
2021 self.ty_to_string(object_ty)
2024 ObligationCauseCode::Coercion { source: _, target } => {
2025 err.note(&format!("required by cast to type `{}`", self.ty_to_string(target)));
2027 ObligationCauseCode::RepeatElementCopy { is_const_fn } => {
2029 "the `Copy` trait is required because the repeated element will be copied",
2034 "consider creating a new `const` item and initializing it with the result \
2035 of the function call to be used in the repeat position, like \
2036 `const VAL: Type = const_fn();` and `let x = [VAL; 42];`",
2040 if self.tcx.sess.is_nightly_build() && is_const_fn {
2042 "create an inline `const` block, see RFC #2920 \
2043 <https://github.com/rust-lang/rfcs/pull/2920> for more information",
2047 ObligationCauseCode::VariableType(hir_id) => {
2048 let parent_node = self.tcx.hir().get_parent_node(hir_id);
2049 match self.tcx.hir().find(parent_node) {
2050 Some(Node::Local(hir::Local {
2051 init: Some(hir::Expr { kind: hir::ExprKind::Index(_, _), span, .. }),
2054 // When encountering an assignment of an unsized trait, like
2055 // `let x = ""[..];`, provide a suggestion to borrow the initializer in
2056 // order to use have a slice instead.
2057 err.span_suggestion_verbose(
2058 span.shrink_to_lo(),
2059 "consider borrowing here",
2061 Applicability::MachineApplicable,
2063 err.note("all local variables must have a statically known size");
2065 Some(Node::Param(param)) => {
2066 err.span_suggestion_verbose(
2067 param.ty_span.shrink_to_lo(),
2068 "function arguments must have a statically known size, borrowed types \
2069 always have a known size",
2071 Applicability::MachineApplicable,
2075 err.note("all local variables must have a statically known size");
2078 if !self.tcx.features().unsized_locals {
2079 err.help("unsized locals are gated as an unstable feature");
2082 ObligationCauseCode::SizedArgumentType(sp) => {
2083 if let Some(span) = sp {
2084 err.span_suggestion_verbose(
2085 span.shrink_to_lo(),
2086 "function arguments must have a statically known size, borrowed types \
2087 always have a known size",
2089 Applicability::MachineApplicable,
2092 err.note("all function arguments must have a statically known size");
2094 if tcx.sess.opts.unstable_features.is_nightly_build()
2095 && !self.tcx.features().unsized_fn_params
2097 err.help("unsized fn params are gated as an unstable feature");
2100 ObligationCauseCode::SizedReturnType => {
2101 err.note("the return type of a function must have a statically known size");
2103 ObligationCauseCode::SizedYieldType => {
2104 err.note("the yield type of a generator must have a statically known size");
2106 ObligationCauseCode::SizedBoxType => {
2107 err.note("the type of a box expression must have a statically known size");
2109 ObligationCauseCode::AssignmentLhsSized => {
2110 err.note("the left-hand-side of an assignment must have a statically known size");
2112 ObligationCauseCode::TupleInitializerSized => {
2113 err.note("tuples must have a statically known size to be initialized");
2115 ObligationCauseCode::StructInitializerSized => {
2116 err.note("structs must have a statically known size to be initialized");
2118 ObligationCauseCode::FieldSized { adt_kind: ref item, last, span } => {
2120 AdtKind::Struct => {
2123 "the last field of a packed struct may only have a \
2124 dynamically sized type if it does not need drop to be run",
2128 "only the last field of a struct may have a dynamically sized type",
2133 err.note("no field of a union may have a dynamically sized type");
2136 err.note("no field of an enum variant may have a dynamically sized type");
2139 err.help("change the field's type to have a statically known size");
2140 err.span_suggestion(
2141 span.shrink_to_lo(),
2142 "borrowed types always have a statically known size",
2144 Applicability::MachineApplicable,
2146 err.multipart_suggestion(
2147 "the `Box` type always has a statically known size and allocates its contents \
2150 (span.shrink_to_lo(), "Box<".to_string()),
2151 (span.shrink_to_hi(), ">".to_string()),
2153 Applicability::MachineApplicable,
2156 ObligationCauseCode::ConstSized => {
2157 err.note("constant expressions must have a statically known size");
2159 ObligationCauseCode::InlineAsmSized => {
2160 err.note("all inline asm arguments must have a statically known size");
2162 ObligationCauseCode::ConstPatternStructural => {
2163 err.note("constants used for pattern-matching must derive `PartialEq` and `Eq`");
2165 ObligationCauseCode::SharedStatic => {
2166 err.note("shared static variables must have a type that implements `Sync`");
2168 ObligationCauseCode::BuiltinDerivedObligation(ref data) => {
2169 let parent_trait_ref = self.resolve_vars_if_possible(data.parent_trait_pred);
2170 let ty = parent_trait_ref.skip_binder().self_ty();
2171 if parent_trait_ref.references_error() {
2172 // NOTE(eddyb) this was `.cancel()`, but `err`
2173 // is borrowed, so we can't fully defuse it.
2174 err.downgrade_to_delayed_bug();
2178 // If the obligation for a tuple is set directly by a Generator or Closure,
2179 // then the tuple must be the one containing capture types.
2180 let is_upvar_tys_infer_tuple = if !matches!(ty.kind(), ty::Tuple(..)) {
2183 if let ObligationCauseCode::BuiltinDerivedObligation(ref data) =
2186 let parent_trait_ref =
2187 self.resolve_vars_if_possible(data.parent_trait_pred);
2188 let ty = parent_trait_ref.skip_binder().self_ty();
2189 matches!(ty.kind(), ty::Generator(..))
2190 || matches!(ty.kind(), ty::Closure(..))
2196 // Don't print the tuple of capture types
2197 if !is_upvar_tys_infer_tuple {
2198 let msg = format!("required because it appears within the type `{}`", ty);
2200 ty::Adt(def, _) => match self.tcx.opt_item_name(def.did()) {
2201 Some(ident) => err.span_note(ident.span, &msg),
2202 None => err.note(&msg),
2204 _ => err.note(&msg),
2208 obligated_types.push(ty);
2210 let parent_predicate = parent_trait_ref.to_predicate(tcx);
2211 if !self.is_recursive_obligation(obligated_types, &data.parent_code) {
2212 // #74711: avoid a stack overflow
2213 ensure_sufficient_stack(|| {
2214 self.note_obligation_cause_code(
2224 ensure_sufficient_stack(|| {
2225 self.note_obligation_cause_code(
2229 &cause_code.peel_derives(),
2236 ObligationCauseCode::ImplDerivedObligation(ref data) => {
2237 let mut parent_trait_pred =
2238 self.resolve_vars_if_possible(data.derived.parent_trait_pred);
2239 parent_trait_pred.remap_constness_diag(param_env);
2240 let parent_def_id = parent_trait_pred.def_id();
2242 "required because of the requirements on the impl of `{}` for `{}`",
2243 parent_trait_pred.print_modifiers_and_trait_path(),
2244 parent_trait_pred.skip_binder().self_ty()
2246 let mut is_auto_trait = false;
2247 match self.tcx.hir().get_if_local(data.impl_def_id) {
2248 Some(Node::Item(hir::Item {
2249 kind: hir::ItemKind::Trait(is_auto, ..),
2253 // FIXME: we should do something else so that it works even on crate foreign
2255 is_auto_trait = matches!(is_auto, hir::IsAuto::Yes);
2256 err.span_note(ident.span, &msg)
2258 Some(Node::Item(hir::Item {
2259 kind: hir::ItemKind::Impl(hir::Impl { of_trait, self_ty, .. }),
2262 let mut spans = Vec::with_capacity(2);
2263 if let Some(trait_ref) = of_trait {
2264 spans.push(trait_ref.path.span);
2266 spans.push(self_ty.span);
2267 err.span_note(spans, &msg)
2269 _ => err.note(&msg),
2272 let mut parent_predicate = parent_trait_pred.to_predicate(tcx);
2273 let mut data = &data.derived;
2275 seen_requirements.insert(parent_def_id);
2277 // We don't want to point at the ADT saying "required because it appears within
2278 // the type `X`", like we would otherwise do in test `supertrait-auto-trait.rs`.
2279 while let ObligationCauseCode::BuiltinDerivedObligation(derived) =
2282 let child_trait_ref =
2283 self.resolve_vars_if_possible(derived.parent_trait_pred);
2284 let child_def_id = child_trait_ref.def_id();
2285 if seen_requirements.insert(child_def_id) {
2289 parent_predicate = child_trait_ref.to_predicate(tcx);
2290 parent_trait_pred = child_trait_ref;
2293 while let ObligationCauseCode::ImplDerivedObligation(child) = &*data.parent_code {
2294 // Skip redundant recursive obligation notes. See `ui/issue-20413.rs`.
2295 let child_trait_pred =
2296 self.resolve_vars_if_possible(child.derived.parent_trait_pred);
2297 let child_def_id = child_trait_pred.def_id();
2298 if seen_requirements.insert(child_def_id) {
2302 data = &child.derived;
2303 parent_predicate = child_trait_pred.to_predicate(tcx);
2304 parent_trait_pred = child_trait_pred;
2308 "{} redundant requirement{} hidden",
2313 "required because of the requirements on the impl of `{}` for `{}`",
2314 parent_trait_pred.print_modifiers_and_trait_path(),
2315 parent_trait_pred.skip_binder().self_ty()
2318 // #74711: avoid a stack overflow
2319 ensure_sufficient_stack(|| {
2320 self.note_obligation_cause_code(
2330 ObligationCauseCode::DerivedObligation(ref data) => {
2331 let parent_trait_ref = self.resolve_vars_if_possible(data.parent_trait_pred);
2332 let parent_predicate = parent_trait_ref.to_predicate(tcx);
2333 // #74711: avoid a stack overflow
2334 ensure_sufficient_stack(|| {
2335 self.note_obligation_cause_code(
2345 ObligationCauseCode::FunctionArgumentObligation {
2350 let hir = self.tcx.hir();
2351 if let Some(Node::Expr(expr @ hir::Expr { kind: hir::ExprKind::Block(..), .. })) =
2352 hir.find(arg_hir_id)
2354 let in_progress_typeck_results =
2355 self.in_progress_typeck_results.map(|t| t.borrow());
2356 let parent_id = hir.get_parent_item(arg_hir_id);
2357 let typeck_results: &TypeckResults<'tcx> = match &in_progress_typeck_results {
2358 Some(t) if t.hir_owner == parent_id => t,
2359 _ => self.tcx.typeck(parent_id),
2361 let ty = typeck_results.expr_ty_adjusted(expr);
2362 let span = expr.peel_blocks().span;
2363 if Some(span) != err.span.primary_span() {
2366 &if ty.references_error() {
2369 format!("this tail expression is of type `{:?}`", ty)
2374 if let Some(Node::Expr(hir::Expr {
2376 hir::ExprKind::Call(hir::Expr { span, .. }, _)
2377 | hir::ExprKind::MethodCall(
2378 hir::PathSegment { ident: Ident { span, .. }, .. },
2382 })) = hir.find(call_hir_id)
2384 if Some(*span) != err.span.primary_span() {
2385 err.span_label(*span, "required by a bound introduced by this call");
2388 ensure_sufficient_stack(|| {
2389 self.note_obligation_cause_code(
2399 ObligationCauseCode::CompareImplMethodObligation { trait_item_def_id, .. } => {
2400 let item_name = self.tcx.item_name(trait_item_def_id);
2402 "the requirement `{}` appears on the impl method `{}` but not on the \
2403 corresponding trait method",
2404 predicate, item_name,
2408 .opt_item_name(trait_item_def_id)
2410 .unwrap_or_else(|| self.tcx.def_span(trait_item_def_id));
2411 let mut assoc_span: MultiSpan = sp.into();
2412 assoc_span.push_span_label(
2414 format!("this trait method doesn't have the requirement `{}`", predicate),
2416 if let Some(ident) = self
2418 .opt_associated_item(trait_item_def_id)
2419 .and_then(|i| self.tcx.opt_item_name(i.container.id()))
2421 assoc_span.push_span_label(ident.span, "in this trait".into());
2423 err.span_note(assoc_span, &msg);
2425 ObligationCauseCode::CompareImplTypeObligation { trait_item_def_id, .. } => {
2426 let item_name = self.tcx.item_name(trait_item_def_id);
2428 "the requirement `{}` appears on the associated impl type `{}` but not on the \
2429 corresponding associated trait type",
2430 predicate, item_name,
2432 let sp = self.tcx.def_span(trait_item_def_id);
2433 let mut assoc_span: MultiSpan = sp.into();
2434 assoc_span.push_span_label(
2437 "this trait associated type doesn't have the requirement `{}`",
2441 if let Some(ident) = self
2443 .opt_associated_item(trait_item_def_id)
2444 .and_then(|i| self.tcx.opt_item_name(i.container.id()))
2446 assoc_span.push_span_label(ident.span, "in this trait".into());
2448 err.span_note(assoc_span, &msg);
2450 ObligationCauseCode::CompareImplConstObligation => {
2452 "the requirement `{}` appears on the associated impl constant \
2453 but not on the corresponding associated trait constant",
2457 ObligationCauseCode::TrivialBound => {
2458 err.help("see issue #48214");
2459 if tcx.sess.opts.unstable_features.is_nightly_build() {
2460 err.help("add `#![feature(trivial_bounds)]` to the crate attributes to enable");
2466 fn suggest_new_overflow_limit(&self, err: &mut Diagnostic) {
2467 let suggested_limit = match self.tcx.recursion_limit() {
2468 Limit(0) => Limit(2),
2472 "consider increasing the recursion limit by adding a \
2473 `#![recursion_limit = \"{}\"]` attribute to your crate (`{}`)",
2475 self.tcx.crate_name(LOCAL_CRATE),
2479 fn suggest_await_before_try(
2481 err: &mut Diagnostic,
2482 obligation: &PredicateObligation<'tcx>,
2483 trait_pred: ty::PolyTraitPredicate<'tcx>,
2487 "suggest_await_before_try: obligation={:?}, span={:?}, trait_pred={:?}, trait_pred_self_ty={:?}",
2491 trait_pred.self_ty()
2493 let body_hir_id = obligation.cause.body_id;
2494 let item_id = self.tcx.hir().get_parent_node(body_hir_id);
2496 if let Some(body_id) = self.tcx.hir().maybe_body_owned_by(item_id) {
2497 let body = self.tcx.hir().body(body_id);
2498 if let Some(hir::GeneratorKind::Async(_)) = body.generator_kind {
2499 let future_trait = self.tcx.require_lang_item(LangItem::Future, None);
2501 let self_ty = self.resolve_vars_if_possible(trait_pred.self_ty());
2503 // Do not check on infer_types to avoid panic in evaluate_obligation.
2504 if self_ty.has_infer_types() {
2507 let self_ty = self.tcx.erase_regions(self_ty);
2509 let impls_future = self.type_implements_trait(
2511 self_ty.skip_binder(),
2513 obligation.param_env,
2516 let item_def_id = self.tcx.associated_item_def_ids(future_trait)[0];
2517 // `<T as Future>::Output`
2518 let projection_ty = ty::ProjectionTy {
2520 substs: self.tcx.mk_substs_trait(
2521 trait_pred.self_ty().skip_binder(),
2522 &self.fresh_substs_for_item(span, item_def_id)[1..],
2528 let mut selcx = SelectionContext::new(self);
2530 let mut obligations = vec![];
2531 let normalized_ty = normalize_projection_type(
2533 obligation.param_env,
2535 obligation.cause.clone(),
2541 "suggest_await_before_try: normalized_projection_type {:?}",
2542 self.resolve_vars_if_possible(normalized_ty)
2544 let try_obligation = self.mk_trait_obligation_with_new_self_ty(
2545 obligation.param_env,
2547 normalized_ty.ty().unwrap(),
2549 debug!("suggest_await_before_try: try_trait_obligation {:?}", try_obligation);
2550 if self.predicate_may_hold(&try_obligation)
2551 && impls_future.must_apply_modulo_regions()
2552 && let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span)
2553 && snippet.ends_with('?')
2555 err.span_suggestion_verbose(
2556 span.with_hi(span.hi() - BytePos(1)).shrink_to_hi(),
2557 "consider `await`ing on the `Future`",
2558 ".await".to_string(),
2559 Applicability::MaybeIncorrect,
2566 fn suggest_floating_point_literal(
2568 obligation: &PredicateObligation<'tcx>,
2569 err: &mut Diagnostic,
2570 trait_ref: &ty::PolyTraitRef<'tcx>,
2572 let rhs_span = match obligation.cause.code() {
2573 ObligationCauseCode::BinOp { rhs_span: Some(span), is_lit } if *is_lit => span,
2577 trait_ref.skip_binder().self_ty().kind(),
2578 trait_ref.skip_binder().substs.type_at(1).kind(),
2580 (ty::Float(_), ty::Infer(InferTy::IntVar(_))) => {
2581 err.span_suggestion_verbose(
2582 rhs_span.shrink_to_hi(),
2583 "consider using a floating-point literal by writing it with `.0`",
2585 Applicability::MaybeIncorrect,
2593 /// Collect all the returned expressions within the input expression.
2594 /// Used to point at the return spans when we want to suggest some change to them.
2596 pub struct ReturnsVisitor<'v> {
2597 pub returns: Vec<&'v hir::Expr<'v>>,
2598 in_block_tail: bool,
2601 impl<'v> Visitor<'v> for ReturnsVisitor<'v> {
2602 fn visit_expr(&mut self, ex: &'v hir::Expr<'v>) {
2603 // Visit every expression to detect `return` paths, either through the function's tail
2604 // expression or `return` statements. We walk all nodes to find `return` statements, but
2605 // we only care about tail expressions when `in_block_tail` is `true`, which means that
2606 // they're in the return path of the function body.
2608 hir::ExprKind::Ret(Some(ex)) => {
2609 self.returns.push(ex);
2611 hir::ExprKind::Block(block, _) if self.in_block_tail => {
2612 self.in_block_tail = false;
2613 for stmt in block.stmts {
2614 hir::intravisit::walk_stmt(self, stmt);
2616 self.in_block_tail = true;
2617 if let Some(expr) = block.expr {
2618 self.visit_expr(expr);
2621 hir::ExprKind::If(_, then, else_opt) if self.in_block_tail => {
2622 self.visit_expr(then);
2623 if let Some(el) = else_opt {
2624 self.visit_expr(el);
2627 hir::ExprKind::Match(_, arms, _) if self.in_block_tail => {
2629 self.visit_expr(arm.body);
2632 // We need to walk to find `return`s in the entire body.
2633 _ if !self.in_block_tail => hir::intravisit::walk_expr(self, ex),
2634 _ => self.returns.push(ex),
2638 fn visit_body(&mut self, body: &'v hir::Body<'v>) {
2639 assert!(!self.in_block_tail);
2640 if body.generator_kind().is_none() {
2641 if let hir::ExprKind::Block(block, None) = body.value.kind {
2642 if block.expr.is_some() {
2643 self.in_block_tail = true;
2647 hir::intravisit::walk_body(self, body);
2651 /// Collect all the awaited expressions within the input expression.
2653 struct AwaitsVisitor {
2654 awaits: Vec<hir::HirId>,
2657 impl<'v> Visitor<'v> for AwaitsVisitor {
2658 fn visit_expr(&mut self, ex: &'v hir::Expr<'v>) {
2659 if let hir::ExprKind::Yield(_, hir::YieldSource::Await { expr: Some(id) }) = ex.kind {
2660 self.awaits.push(id)
2662 hir::intravisit::walk_expr(self, ex)
2666 pub trait NextTypeParamName {
2667 fn next_type_param_name(&self, name: Option<&str>) -> String;
2670 impl NextTypeParamName for &[hir::GenericParam<'_>] {
2671 fn next_type_param_name(&self, name: Option<&str>) -> String {
2672 // This is the list of possible parameter names that we might suggest.
2673 let name = name.and_then(|n| n.chars().next()).map(|c| c.to_string().to_uppercase());
2674 let name = name.as_deref();
2675 let possible_names = [name.unwrap_or("T"), "T", "U", "V", "X", "Y", "Z", "A", "B", "C"];
2676 let used_names = self
2678 .filter_map(|p| match p.name {
2679 hir::ParamName::Plain(ident) => Some(ident.name),
2682 .collect::<Vec<_>>();
2686 .find(|n| !used_names.contains(&Symbol::intern(n)))
2687 .unwrap_or(&"ParamName")
2692 fn suggest_trait_object_return_type_alternatives(
2693 err: &mut Diagnostic,
2696 is_object_safe: bool,
2698 err.span_suggestion(
2700 "use some type `T` that is `T: Sized` as the return type if all return paths have the \
2703 Applicability::MaybeIncorrect,
2705 err.span_suggestion(
2708 "use `impl {}` as the return type if all return paths have the same type but you \
2709 want to expose only the trait in the signature",
2712 format!("impl {}", trait_obj),
2713 Applicability::MaybeIncorrect,
2716 err.span_suggestion(
2719 "use a boxed trait object if all return paths implement trait `{}`",
2722 format!("Box<dyn {}>", trait_obj),
2723 Applicability::MaybeIncorrect,