2 EvaluationResult, Obligation, ObligationCause, ObligationCauseCode, PredicateObligation,
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;
12 use rustc_errors::{error_code, struct_span_err, Applicability, DiagnosticBuilder, Style};
14 use rustc_hir::def::DefKind;
15 use rustc_hir::def_id::DefId;
16 use rustc_hir::intravisit::Visitor;
17 use rustc_hir::lang_items::LangItem;
18 use rustc_hir::{AsyncGeneratorKind, GeneratorKind, Node};
19 use rustc_middle::ty::{
20 self, suggest_constraining_type_param, AdtKind, DefIdTree, Infer, InferTy, ToPredicate, Ty,
21 TyCtxt, TypeFoldable, WithConstness,
23 use rustc_middle::ty::{TypeAndMut, TypeckResults};
24 use rustc_span::symbol::{kw, sym, Ident, Symbol};
25 use rustc_span::{BytePos, MultiSpan, Span, DUMMY_SP};
26 use rustc_target::spec::abi;
29 use super::InferCtxtPrivExt;
30 use crate::traits::query::evaluate_obligation::InferCtxtExt as _;
33 pub enum GeneratorInteriorOrUpvar {
34 // span of interior type
40 // This trait is public to expose the diagnostics methods to clippy.
41 pub trait InferCtxtExt<'tcx> {
42 fn suggest_restricting_param_bound(
44 err: &mut DiagnosticBuilder<'_>,
45 trait_ref: ty::PolyTraitRef<'tcx>,
49 fn suggest_dereferences(
51 obligation: &PredicateObligation<'tcx>,
52 err: &mut DiagnosticBuilder<'tcx>,
53 trait_ref: ty::PolyTraitRef<'tcx>,
60 err: &mut DiagnosticBuilder<'_>,
66 obligation: &PredicateObligation<'tcx>,
67 err: &mut DiagnosticBuilder<'_>,
68 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
72 fn suggest_add_reference_to_arg(
74 obligation: &PredicateObligation<'tcx>,
75 err: &mut DiagnosticBuilder<'_>,
76 trait_ref: &ty::Binder<ty::TraitRef<'tcx>>,
78 has_custom_message: bool,
81 fn suggest_remove_reference(
83 obligation: &PredicateObligation<'tcx>,
84 err: &mut DiagnosticBuilder<'_>,
85 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
88 fn suggest_change_mut(
90 obligation: &PredicateObligation<'tcx>,
91 err: &mut DiagnosticBuilder<'_>,
92 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
96 fn suggest_semicolon_removal(
98 obligation: &PredicateObligation<'tcx>,
99 err: &mut DiagnosticBuilder<'_>,
101 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
104 fn return_type_span(&self, obligation: &PredicateObligation<'tcx>) -> Option<Span>;
106 fn suggest_impl_trait(
108 err: &mut DiagnosticBuilder<'_>,
110 obligation: &PredicateObligation<'tcx>,
111 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
114 fn point_at_returns_when_relevant(
116 err: &mut DiagnosticBuilder<'_>,
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>;
128 fn suggest_fully_qualified_path(
130 err: &mut DiagnosticBuilder<'_>,
136 fn maybe_note_obligation_cause_for_async_await(
138 err: &mut DiagnosticBuilder<'_>,
139 obligation: &PredicateObligation<'tcx>,
142 fn note_obligation_cause_for_async_await(
144 err: &mut DiagnosticBuilder<'_>,
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_ref: ty::TraitRef<'tcx>,
151 typeck_results: &ty::TypeckResults<'tcx>,
152 obligation: &PredicateObligation<'tcx>,
153 next_code: Option<&ObligationCauseCode<'tcx>>,
156 fn note_obligation_cause_code<T>(
158 err: &mut DiagnosticBuilder<'_>,
160 cause_code: &ObligationCauseCode<'tcx>,
161 obligated_types: &mut Vec<&ty::TyS<'tcx>>,
162 seen_requirements: &mut FxHashSet<DefId>,
166 fn suggest_new_overflow_limit(&self, err: &mut DiagnosticBuilder<'_>);
168 /// Suggest to await before try: future? => future.await?
169 fn suggest_await_before_try(
171 err: &mut DiagnosticBuilder<'_>,
172 obligation: &PredicateObligation<'tcx>,
173 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
178 fn predicate_constraint(generics: &hir::Generics<'_>, pred: String) -> (Span, String) {
180 generics.where_clause.tail_span_for_suggestion(),
183 if !generics.where_clause.predicates.is_empty() { "," } else { " where" },
189 /// Type parameter needs more bounds. The trivial case is `T` `where T: Bound`, but
190 /// it can also be an `impl Trait` param that needs to be decomposed to a type
191 /// param for cleaner code.
192 fn suggest_restriction(
194 generics: &hir::Generics<'tcx>,
196 err: &mut DiagnosticBuilder<'_>,
197 fn_sig: Option<&hir::FnSig<'_>>,
198 projection: Option<&ty::ProjectionTy<'_>>,
199 trait_ref: ty::PolyTraitRef<'tcx>,
200 super_traits: Option<(&Ident, &hir::GenericBounds<'_>)>,
202 // When we are dealing with a trait, `super_traits` will be `Some`:
203 // Given `trait T: A + B + C {}`
204 // - ^^^^^^^^^ GenericBounds
207 let span = generics.where_clause.span_for_predicates_or_empty_place();
208 if span.from_expansion() || span.desugaring_kind().is_some() {
211 // Given `fn foo(t: impl Trait)` where `Trait` requires assoc type `A`...
212 if let Some((bound_str, fn_sig)) =
213 fn_sig.zip(projection).and_then(|(sig, p)| match p.self_ty().kind() {
214 // Shenanigans to get the `Trait` from the `impl Trait`.
215 ty::Param(param) => {
216 // `fn foo(t: impl Trait)`
217 // ^^^^^ get this string
218 param.name.as_str().strip_prefix("impl").map(|s| (s.trim_start().to_string(), sig))
223 // We know we have an `impl Trait` that doesn't satisfy a required projection.
225 // Find all of the ocurrences of `impl Trait` for `Trait` in the function arguments'
226 // types. There should be at least one, but there might be *more* than one. In that
227 // case we could just ignore it and try to identify which one needs the restriction,
228 // but instead we choose to suggest replacing all instances of `impl Trait` with `T`
230 let mut ty_spans = vec![];
231 let impl_trait_str = format!("impl {}", bound_str);
232 for input in fn_sig.decl.inputs {
233 if let hir::TyKind::Path(hir::QPath::Resolved(
235 hir::Path { segments: [segment], .. },
238 if segment.ident.as_str() == impl_trait_str.as_str() {
239 // `fn foo(t: impl Trait)`
240 // ^^^^^^^^^^ get this to suggest `T` instead
242 // There might be more than one `impl Trait`.
243 ty_spans.push(input.span);
248 let type_param_name = generics.params.next_type_param_name(Some(&bound_str));
249 // The type param `T: Trait` we will suggest to introduce.
250 let type_param = format!("{}: {}", type_param_name, bound_str);
252 // FIXME: modify the `trait_ref` instead of string shenanigans.
253 // Turn `<impl Trait as Foo>::Bar: Qux` into `<T as Foo>::Bar: Qux`.
254 let pred = trait_ref.without_const().to_predicate(tcx).to_string();
255 let pred = pred.replace(&impl_trait_str, &type_param_name);
257 // Find the last of the generic parameters contained within the span of
262 .map(|p| p.bounds_span().unwrap_or(p.span))
263 .filter(|&span| generics.span.contains(span) && span.desugaring_kind().is_none())
264 .max_by_key(|span| span.hi())
266 // `fn foo(t: impl Trait)`
267 // ^ suggest `<T: Trait>` here
268 None => (generics.span, format!("<{}>", type_param)),
269 // `fn foo<A>(t: impl Trait)`
270 // ^^^ suggest `<A, T: Trait>` here
271 Some(span) => (span.shrink_to_hi(), format!(", {}", type_param)),
273 // `fn foo(t: impl Trait)`
274 // ^ suggest `where <T as Trait>::A: Bound`
275 predicate_constraint(generics, pred),
277 sugg.extend(ty_spans.into_iter().map(|s| (s, type_param_name.to_string())));
279 // Suggest `fn foo<T: Trait>(t: T) where <T as Trait>::A: Bound`.
280 // FIXME: once `#![feature(associated_type_bounds)]` is stabilized, we should suggest
281 // `fn foo(t: impl Trait<A: Bound>)` instead.
282 err.multipart_suggestion(
283 "introduce a type parameter with a trait bound instead of using `impl Trait`",
285 Applicability::MaybeIncorrect,
288 // Trivial case: `T` needs an extra bound: `T: Bound`.
289 let (sp, suggestion) = match (
294 |p| !matches!(p.kind, hir::GenericParamKind::Type { synthetic: Some(_), ..}),
299 (_, None) => predicate_constraint(
301 trait_ref.without_const().to_predicate(tcx).to_string(),
303 (None, Some((ident, []))) => (
304 ident.span.shrink_to_hi(),
305 format!(": {}", trait_ref.print_only_trait_path().to_string()),
307 (_, Some((_, [.., bounds]))) => (
308 bounds.span().shrink_to_hi(),
309 format!(" + {}", trait_ref.print_only_trait_path().to_string()),
311 (Some(_), Some((_, []))) => (
312 generics.span.shrink_to_hi(),
313 format!(": {}", trait_ref.print_only_trait_path().to_string()),
317 err.span_suggestion_verbose(
319 &format!("consider further restricting {}", msg),
321 Applicability::MachineApplicable,
326 impl<'a, 'tcx> InferCtxtExt<'tcx> for InferCtxt<'a, 'tcx> {
327 fn suggest_restricting_param_bound(
329 mut err: &mut DiagnosticBuilder<'_>,
330 trait_ref: ty::PolyTraitRef<'tcx>,
333 let self_ty = trait_ref.skip_binder().self_ty();
334 let (param_ty, projection) = match self_ty.kind() {
335 ty::Param(_) => (true, None),
336 ty::Projection(projection) => (false, Some(projection)),
340 // FIXME: Add check for trait bound that is already present, particularly `?Sized` so we
341 // don't suggest `T: Sized + ?Sized`.
342 let mut hir_id = body_id;
343 while let Some(node) = self.tcx.hir().find(hir_id) {
345 hir::Node::Item(hir::Item {
347 kind: hir::ItemKind::Trait(_, _, generics, bounds, _),
349 }) if self_ty == self.tcx.types.self_param => {
351 // Restricting `Self` for a single method.
360 Some((ident, bounds)),
365 hir::Node::TraitItem(hir::TraitItem {
367 kind: hir::TraitItemKind::Fn(..),
369 }) if self_ty == self.tcx.types.self_param => {
371 // Restricting `Self` for a single method.
373 self.tcx, &generics, "`Self`", err, None, projection, trait_ref, None,
378 hir::Node::TraitItem(hir::TraitItem {
380 kind: hir::TraitItemKind::Fn(fn_sig, ..),
383 | hir::Node::ImplItem(hir::ImplItem {
385 kind: hir::ImplItemKind::Fn(fn_sig, ..),
388 | hir::Node::Item(hir::Item {
389 kind: hir::ItemKind::Fn(fn_sig, generics, _), ..
390 }) if projection.is_some() => {
391 // Missing restriction on associated type of type parameter (unmet projection).
395 "the associated type",
404 hir::Node::Item(hir::Item {
406 hir::ItemKind::Trait(_, _, generics, _, _)
407 | hir::ItemKind::Impl(hir::Impl { generics, .. }),
409 }) if projection.is_some() => {
410 // Missing restriction on associated type of type parameter (unmet projection).
414 "the associated type",
424 hir::Node::Item(hir::Item {
426 hir::ItemKind::Struct(_, generics)
427 | hir::ItemKind::Enum(_, generics)
428 | hir::ItemKind::Union(_, generics)
429 | hir::ItemKind::Trait(_, _, generics, ..)
430 | hir::ItemKind::Impl(hir::Impl { generics, .. })
431 | hir::ItemKind::Fn(_, generics, _)
432 | hir::ItemKind::TyAlias(_, generics)
433 | hir::ItemKind::TraitAlias(generics, _)
434 | hir::ItemKind::OpaqueTy(hir::OpaqueTy { generics, .. }),
437 | hir::Node::TraitItem(hir::TraitItem { generics, .. })
438 | hir::Node::ImplItem(hir::ImplItem { generics, .. })
441 // Missing generic type parameter bound.
442 let param_name = self_ty.to_string();
443 let constraint = trait_ref.print_only_trait_path().to_string();
444 if suggest_constraining_type_param(
450 Some(trait_ref.def_id()),
456 hir::Node::Crate(..) => return,
461 hir_id = self.tcx.hir().get_parent_item(hir_id);
465 /// When after several dereferencing, the reference satisfies the trait
466 /// binding. This function provides dereference suggestion for this
467 /// specific situation.
468 fn suggest_dereferences(
470 obligation: &PredicateObligation<'tcx>,
471 err: &mut DiagnosticBuilder<'tcx>,
472 trait_ref: ty::PolyTraitRef<'tcx>,
475 // It only make sense when suggesting dereferences for arguments
479 let param_env = obligation.param_env;
480 let body_id = obligation.cause.body_id;
481 let span = obligation.cause.span;
482 let real_trait_ref = match &obligation.cause.code {
483 ObligationCauseCode::ImplDerivedObligation(cause)
484 | ObligationCauseCode::DerivedObligation(cause)
485 | ObligationCauseCode::BuiltinDerivedObligation(cause) => cause.parent_trait_ref,
488 let real_ty = match real_trait_ref.self_ty().no_bound_vars() {
493 if let ty::Ref(region, base_ty, mutbl) = *real_ty.kind() {
494 let mut autoderef = Autoderef::new(self, param_env, body_id, span, base_ty, span);
495 if let Some(steps) = autoderef.find_map(|(ty, steps)| {
497 let ty = self.tcx.mk_ref(region, TypeAndMut { ty, mutbl });
499 self.mk_trait_obligation_with_new_self_ty(param_env, real_trait_ref, ty);
500 Some(steps).filter(|_| self.predicate_may_hold(&obligation))
503 if let Ok(src) = self.tcx.sess.source_map().span_to_snippet(span) {
504 // Don't care about `&mut` because `DerefMut` is used less
505 // often and user will not expect autoderef happens.
506 if src.starts_with('&') && !src.starts_with("&mut ") {
507 let derefs = "*".repeat(steps);
510 "consider adding dereference here",
511 format!("&{}{}", derefs, &src[1..]),
512 Applicability::MachineApplicable,
521 /// Given a closure's `DefId`, return the given name of the closure.
523 /// This doesn't account for reassignments, but it's only used for suggestions.
527 err: &mut DiagnosticBuilder<'_>,
529 ) -> Option<String> {
531 |err: &mut DiagnosticBuilder<'_>, kind: &hir::PatKind<'_>| -> Option<String> {
532 // Get the local name of this closure. This can be inaccurate because
533 // of the possibility of reassignment, but this should be good enough.
535 hir::PatKind::Binding(hir::BindingAnnotation::Unannotated, _, name, None) => {
536 Some(format!("{}", name))
545 let hir = self.tcx.hir();
546 let hir_id = hir.local_def_id_to_hir_id(def_id.as_local()?);
547 let parent_node = hir.get_parent_node(hir_id);
548 match hir.find(parent_node) {
549 Some(hir::Node::Stmt(hir::Stmt { kind: hir::StmtKind::Local(local), .. })) => {
550 get_name(err, &local.pat.kind)
552 // Different to previous arm because one is `&hir::Local` and the other
553 // is `P<hir::Local>`.
554 Some(hir::Node::Local(local)) => get_name(err, &local.pat.kind),
559 /// We tried to apply the bound to an `fn` or closure. Check whether calling it would
560 /// evaluate to a type that *would* satisfy the trait binding. If it would, suggest calling
561 /// it: `bar(foo)` → `bar(foo())`. This case is *very* likely to be hit if `foo` is `async`.
564 obligation: &PredicateObligation<'tcx>,
565 err: &mut DiagnosticBuilder<'_>,
566 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
569 let self_ty = match trait_ref.self_ty().no_bound_vars() {
574 let (def_id, output_ty, callable) = match *self_ty.kind() {
575 ty::Closure(def_id, substs) => (def_id, substs.as_closure().sig().output(), "closure"),
576 ty::FnDef(def_id, _) => (def_id, self_ty.fn_sig(self.tcx).output(), "function"),
579 let msg = format!("use parentheses to call the {}", callable);
581 // `mk_trait_obligation_with_new_self_ty` only works for types with no escaping bound
582 // variables, so bail out if we have any.
583 let output_ty = match output_ty.no_bound_vars() {
589 self.mk_trait_obligation_with_new_self_ty(obligation.param_env, trait_ref, output_ty);
591 match self.evaluate_obligation(&new_obligation) {
593 EvaluationResult::EvaluatedToOk
594 | EvaluationResult::EvaluatedToOkModuloRegions
595 | EvaluationResult::EvaluatedToAmbig,
599 let hir = self.tcx.hir();
600 // Get the name of the callable and the arguments to be used in the suggestion.
601 let (snippet, sugg) = match hir.get_if_local(def_id) {
602 Some(hir::Node::Expr(hir::Expr {
603 kind: hir::ExprKind::Closure(_, decl, _, span, ..),
606 err.span_label(*span, "consider calling this closure");
607 let name = match self.get_closure_name(def_id, err, &msg) {
611 let args = decl.inputs.iter().map(|_| "_").collect::<Vec<_>>().join(", ");
612 let sugg = format!("({})", args);
613 (format!("{}{}", name, sugg), sugg)
615 Some(hir::Node::Item(hir::Item {
617 kind: hir::ItemKind::Fn(.., body_id),
620 err.span_label(ident.span, "consider calling this function");
621 let body = hir.body(*body_id);
625 .map(|arg| match &arg.pat.kind {
626 hir::PatKind::Binding(_, _, ident, None)
627 // FIXME: provide a better suggestion when encountering `SelfLower`, it
628 // should suggest a method call.
629 if ident.name != kw::SelfLower => ident.to_string(),
630 _ => "_".to_string(),
634 let sugg = format!("({})", args);
635 (format!("{}{}", ident, sugg), sugg)
640 // When the obligation error has been ensured to have been caused by
641 // an argument, the `obligation.cause.span` points at the expression
642 // of the argument, so we can provide a suggestion. This is signaled
643 // by `points_at_arg`. Otherwise, we give a more general note.
644 err.span_suggestion_verbose(
645 obligation.cause.span.shrink_to_hi(),
648 Applicability::HasPlaceholders,
651 err.help(&format!("{}: `{}`", msg, snippet));
655 fn suggest_add_reference_to_arg(
657 obligation: &PredicateObligation<'tcx>,
658 err: &mut DiagnosticBuilder<'_>,
659 trait_ref: &ty::Binder<ty::TraitRef<'tcx>>,
661 has_custom_message: bool,
667 let span = obligation.cause.span;
668 let param_env = obligation.param_env;
669 let trait_ref = trait_ref.skip_binder();
671 if let ObligationCauseCode::ImplDerivedObligation(obligation) = &obligation.cause.code {
672 // Try to apply the original trait binding obligation by borrowing.
673 let self_ty = trait_ref.self_ty();
674 let found = self_ty.to_string();
675 let new_self_ty = self.tcx.mk_imm_ref(self.tcx.lifetimes.re_static, self_ty);
676 let substs = self.tcx.mk_substs_trait(new_self_ty, &[]);
677 let new_trait_ref = ty::TraitRef::new(obligation.parent_trait_ref.def_id(), substs);
678 let new_obligation = Obligation::new(
679 ObligationCause::dummy(),
681 new_trait_ref.without_const().to_predicate(self.tcx),
684 if self.predicate_must_hold_modulo_regions(&new_obligation) {
685 if let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) {
686 // We have a very specific type of error, where just borrowing this argument
687 // might solve the problem. In cases like this, the important part is the
688 // original type obligation, not the last one that failed, which is arbitrary.
689 // Because of this, we modify the error to refer to the original obligation and
690 // return early in the caller.
693 "the trait bound `{}: {}` is not satisfied",
695 obligation.parent_trait_ref.skip_binder().print_only_trait_path(),
697 if has_custom_message {
700 err.message = vec![(msg, Style::NoStyle)];
702 if snippet.starts_with('&') {
703 // This is already a literal borrow and the obligation is failing
704 // somewhere else in the obligation chain. Do not suggest non-sense.
710 "expected an implementor of trait `{}`",
711 obligation.parent_trait_ref.skip_binder().print_only_trait_path(),
715 // This if is to prevent a special edge-case
716 if !span.from_expansion() {
717 // We don't want a borrowing suggestion on the fields in structs,
720 // the_foos: Vec<Foo>
726 "consider borrowing here",
727 format!("&{}", snippet),
728 Applicability::MaybeIncorrect,
738 /// Whenever references are used by mistake, like `for (i, e) in &vec.iter().enumerate()`,
739 /// suggest removing these references until we reach a type that implements the trait.
740 fn suggest_remove_reference(
742 obligation: &PredicateObligation<'tcx>,
743 err: &mut DiagnosticBuilder<'_>,
744 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
746 let span = obligation.cause.span;
748 if let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) {
750 snippet.chars().filter(|c| !c.is_whitespace()).take_while(|c| *c == '&').count();
751 if let Some('\'') = snippet.chars().filter(|c| !c.is_whitespace()).nth(refs_number) {
752 // Do not suggest removal of borrow from type arguments.
756 let mut suggested_ty = match trait_ref.self_ty().no_bound_vars() {
761 for refs_remaining in 0..refs_number {
762 if let ty::Ref(_, inner_ty, _) = suggested_ty.kind() {
763 suggested_ty = inner_ty;
765 let new_obligation = self.mk_trait_obligation_with_new_self_ty(
766 obligation.param_env,
771 if self.predicate_may_hold(&new_obligation) {
776 .span_take_while(span, |c| c.is_whitespace() || *c == '&');
778 let remove_refs = refs_remaining + 1;
780 let msg = if remove_refs == 1 {
781 "consider removing the leading `&`-reference".to_string()
783 format!("consider removing {} leading `&`-references", remove_refs)
786 err.span_suggestion_short(
790 Applicability::MachineApplicable,
801 /// Check if the trait bound is implemented for a different mutability and note it in the
803 fn suggest_change_mut(
805 obligation: &PredicateObligation<'tcx>,
806 err: &mut DiagnosticBuilder<'_>,
807 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
810 let span = obligation.cause.span;
811 if let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) {
813 snippet.chars().filter(|c| !c.is_whitespace()).take_while(|c| *c == '&').count();
814 if let Some('\'') = snippet.chars().filter(|c| !c.is_whitespace()).nth(refs_number) {
815 // Do not suggest removal of borrow from type arguments.
818 let trait_ref = self.resolve_vars_if_possible(trait_ref);
819 if trait_ref.has_infer_types_or_consts() {
820 // Do not ICE while trying to find if a reborrow would succeed on a trait with
821 // unresolved bindings.
825 if let ty::Ref(region, t_type, mutability) = *trait_ref.skip_binder().self_ty().kind() {
826 if region.is_late_bound() || t_type.has_escaping_bound_vars() {
827 // Avoid debug assertion in `mk_obligation_for_def_id`.
829 // If the self type has escaping bound vars then it's not
830 // going to be the type of an expression, so the suggestion
831 // probably won't apply anyway.
835 let suggested_ty = match mutability {
836 hir::Mutability::Mut => self.tcx.mk_imm_ref(region, t_type),
837 hir::Mutability::Not => self.tcx.mk_mut_ref(region, t_type),
840 let new_obligation = self.mk_trait_obligation_with_new_self_ty(
841 obligation.param_env,
845 let suggested_ty_would_satisfy_obligation = self
846 .evaluate_obligation_no_overflow(&new_obligation)
847 .must_apply_modulo_regions();
848 if suggested_ty_would_satisfy_obligation {
853 .span_take_while(span, |c| c.is_whitespace() || *c == '&');
854 if points_at_arg && mutability == hir::Mutability::Not && refs_number > 0 {
855 err.span_suggestion_verbose(
857 "consider changing this borrow's mutability",
859 Applicability::MachineApplicable,
863 "`{}` is implemented for `{:?}`, but not for `{:?}`",
864 trait_ref.print_only_trait_path(),
866 trait_ref.skip_binder().self_ty(),
874 fn suggest_semicolon_removal(
876 obligation: &PredicateObligation<'tcx>,
877 err: &mut DiagnosticBuilder<'_>,
879 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
882 |ty: ty::Binder<Ty<'_>>| *ty.skip_binder().kind() == ty::Tuple(ty::List::empty());
884 let hir = self.tcx.hir();
885 let parent_node = hir.get_parent_node(obligation.cause.body_id);
886 let node = hir.find(parent_node);
887 if let Some(hir::Node::Item(hir::Item {
888 kind: hir::ItemKind::Fn(sig, _, body_id), ..
891 let body = hir.body(*body_id);
892 if let hir::ExprKind::Block(blk, _) = &body.value.kind {
893 if sig.decl.output.span().overlaps(span)
894 && blk.expr.is_none()
895 && is_empty_tuple(trait_ref.self_ty())
897 // FIXME(estebank): When encountering a method with a trait
898 // bound not satisfied in the return type with a body that has
899 // no return, suggest removal of semicolon on last statement.
900 // Once that is added, close #54771.
901 if let Some(ref stmt) = blk.stmts.last() {
902 if let hir::StmtKind::Semi(_) = stmt.kind {
903 let sp = self.tcx.sess.source_map().end_point(stmt.span);
904 err.span_label(sp, "consider removing this semicolon");
912 fn return_type_span(&self, obligation: &PredicateObligation<'tcx>) -> Option<Span> {
913 let hir = self.tcx.hir();
914 let parent_node = hir.get_parent_node(obligation.cause.body_id);
915 let sig = match hir.find(parent_node) {
916 Some(hir::Node::Item(hir::Item { kind: hir::ItemKind::Fn(sig, ..), .. })) => sig,
920 if let hir::FnRetTy::Return(ret_ty) = sig.decl.output { Some(ret_ty.span) } else { None }
923 /// If all conditions are met to identify a returned `dyn Trait`, suggest using `impl Trait` if
924 /// applicable and signal that the error has been expanded appropriately and needs to be
926 fn suggest_impl_trait(
928 err: &mut DiagnosticBuilder<'_>,
930 obligation: &PredicateObligation<'tcx>,
931 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
933 match obligation.cause.code.peel_derives() {
934 // Only suggest `impl Trait` if the return type is unsized because it is `dyn Trait`.
935 ObligationCauseCode::SizedReturnType => {}
939 let hir = self.tcx.hir();
940 let parent_node = hir.get_parent_node(obligation.cause.body_id);
941 let node = hir.find(parent_node);
942 let (sig, body_id) = if let Some(hir::Node::Item(hir::Item {
943 kind: hir::ItemKind::Fn(sig, _, body_id),
951 let body = hir.body(*body_id);
952 let trait_ref = self.resolve_vars_if_possible(trait_ref);
953 let ty = trait_ref.skip_binder().self_ty();
954 let is_object_safe = match ty.kind() {
955 ty::Dynamic(predicates, _) => {
956 // If the `dyn Trait` is not object safe, do not suggest `Box<dyn Trait>`.
959 .map_or(true, |def_id| self.tcx.object_safety_violations(def_id).is_empty())
961 // We only want to suggest `impl Trait` to `dyn Trait`s.
962 // For example, `fn foo() -> str` needs to be filtered out.
966 let ret_ty = if let hir::FnRetTy::Return(ret_ty) = sig.decl.output {
972 // Use `TypeVisitor` instead of the output type directly to find the span of `ty` for
973 // cases like `fn foo() -> (dyn Trait, i32) {}`.
974 // Recursively look for `TraitObject` types and if there's only one, use that span to
975 // suggest `impl Trait`.
977 // Visit to make sure there's a single `return` type to suggest `impl Trait`,
978 // otherwise suggest using `Box<dyn Trait>` or an enum.
979 let mut visitor = ReturnsVisitor::default();
980 visitor.visit_body(&body);
982 let typeck_results = self.in_progress_typeck_results.map(|t| t.borrow()).unwrap();
984 let mut ret_types = visitor
987 .filter_map(|expr| typeck_results.node_type_opt(expr.hir_id))
988 .map(|ty| self.resolve_vars_if_possible(ty));
989 let (last_ty, all_returns_have_same_type, only_never_return) = ret_types.clone().fold(
991 |(last_ty, mut same, only_never_return): (std::option::Option<Ty<'_>>, bool, bool),
993 let ty = self.resolve_vars_if_possible(ty);
995 !matches!(ty.kind(), ty::Error(_))
996 && last_ty.map_or(true, |last_ty| {
997 // FIXME: ideally we would use `can_coerce` here instead, but `typeck` comes
998 // *after* in the dependency graph.
999 match (ty.kind(), last_ty.kind()) {
1000 (Infer(InferTy::IntVar(_)), Infer(InferTy::IntVar(_)))
1001 | (Infer(InferTy::FloatVar(_)), Infer(InferTy::FloatVar(_)))
1002 | (Infer(InferTy::FreshIntTy(_)), Infer(InferTy::FreshIntTy(_)))
1004 Infer(InferTy::FreshFloatTy(_)),
1005 Infer(InferTy::FreshFloatTy(_)),
1010 (Some(ty), same, only_never_return && matches!(ty.kind(), ty::Never))
1013 let all_returns_conform_to_trait =
1014 if let Some(ty_ret_ty) = typeck_results.node_type_opt(ret_ty.hir_id) {
1015 match ty_ret_ty.kind() {
1016 ty::Dynamic(predicates, _) => {
1017 let cause = ObligationCause::misc(ret_ty.span, ret_ty.hir_id);
1018 let param_env = ty::ParamEnv::empty();
1020 || ret_types.all(|returned_ty| {
1021 predicates.iter().all(|predicate| {
1022 let pred = predicate.with_self_ty(self.tcx, returned_ty);
1023 let obl = Obligation::new(cause.clone(), param_env, pred);
1024 self.predicate_may_hold(&obl)
1034 let sm = self.tcx.sess.source_map();
1035 let snippet = if let (true, hir::TyKind::TraitObject(..), Ok(snippet), true) = (
1036 // Verify that we're dealing with a return `dyn Trait`
1037 ret_ty.span.overlaps(span),
1039 sm.span_to_snippet(ret_ty.span),
1040 // If any of the return types does not conform to the trait, then we can't
1041 // suggest `impl Trait` nor trait objects: it is a type mismatch error.
1042 all_returns_conform_to_trait,
1048 err.code(error_code!(E0746));
1049 err.set_primary_message("return type cannot have an unboxed trait object");
1050 err.children.clear();
1051 let impl_trait_msg = "for information on `impl Trait`, see \
1052 <https://doc.rust-lang.org/book/ch10-02-traits.html\
1053 #returning-types-that-implement-traits>";
1054 let trait_obj_msg = "for information on trait objects, see \
1055 <https://doc.rust-lang.org/book/ch17-02-trait-objects.html\
1056 #using-trait-objects-that-allow-for-values-of-different-types>";
1057 let has_dyn = snippet.split_whitespace().next().map_or(false, |s| s == "dyn");
1058 let trait_obj = if has_dyn { &snippet[4..] } else { &snippet[..] };
1059 if only_never_return {
1060 // No return paths, probably using `panic!()` or similar.
1061 // Suggest `-> T`, `-> impl Trait`, and if `Trait` is object safe, `-> Box<dyn Trait>`.
1062 suggest_trait_object_return_type_alternatives(
1068 } else if let (Some(last_ty), true) = (last_ty, all_returns_have_same_type) {
1069 // Suggest `-> impl Trait`.
1070 err.span_suggestion(
1073 "use `impl {1}` as the return type, as all return paths are of type `{}`, \
1074 which implements `{1}`",
1077 format!("impl {}", trait_obj),
1078 Applicability::MachineApplicable,
1080 err.note(impl_trait_msg);
1083 // Suggest `-> Box<dyn Trait>` and `Box::new(returned_value)`.
1084 // Get all the return values and collect their span and suggestion.
1085 if let Some(mut suggestions) = visitor
1089 let snip = sm.span_to_snippet(expr.span).ok()?;
1090 Some((expr.span, format!("Box::new({})", snip)))
1092 .collect::<Option<Vec<_>>>()
1094 // Add the suggestion for the return type.
1095 suggestions.push((ret_ty.span, format!("Box<dyn {}>", trait_obj)));
1096 err.multipart_suggestion(
1097 "return a boxed trait object instead",
1099 Applicability::MaybeIncorrect,
1103 // This is currently not possible to trigger because E0038 takes precedence, but
1104 // leave it in for completeness in case anything changes in an earlier stage.
1106 "if trait `{}` was object safe, you could return a trait object",
1110 err.note(trait_obj_msg);
1112 "if all the returned values were of the same type you could use `impl {}` as the \
1116 err.note(impl_trait_msg);
1117 err.note("you can create a new `enum` with a variant for each returned type");
1122 fn point_at_returns_when_relevant(
1124 err: &mut DiagnosticBuilder<'_>,
1125 obligation: &PredicateObligation<'tcx>,
1127 match obligation.cause.code.peel_derives() {
1128 ObligationCauseCode::SizedReturnType => {}
1132 let hir = self.tcx.hir();
1133 let parent_node = hir.get_parent_node(obligation.cause.body_id);
1134 let node = hir.find(parent_node);
1135 if let Some(hir::Node::Item(hir::Item { kind: hir::ItemKind::Fn(_, _, body_id), .. })) =
1138 let body = hir.body(*body_id);
1139 // Point at all the `return`s in the function as they have failed trait bounds.
1140 let mut visitor = ReturnsVisitor::default();
1141 visitor.visit_body(&body);
1142 let typeck_results = self.in_progress_typeck_results.map(|t| t.borrow()).unwrap();
1143 for expr in &visitor.returns {
1144 if let Some(returned_ty) = typeck_results.node_type_opt(expr.hir_id) {
1145 let ty = self.resolve_vars_if_possible(returned_ty);
1146 err.span_label(expr.span, &format!("this returned value is of type `{}`", ty));
1152 fn report_closure_arg_mismatch(
1155 found_span: Option<Span>,
1156 expected_ref: ty::PolyTraitRef<'tcx>,
1157 found: ty::PolyTraitRef<'tcx>,
1158 ) -> DiagnosticBuilder<'tcx> {
1159 crate fn build_fn_sig_string<'tcx>(
1161 trait_ref: ty::PolyTraitRef<'tcx>,
1163 let inputs = trait_ref.skip_binder().substs.type_at(1);
1164 let sig = if let ty::Tuple(inputs) = inputs.kind() {
1166 inputs.iter().map(|k| k.expect_ty()),
1167 tcx.mk_ty_infer(ty::TyVar(ty::TyVid { index: 0 })),
1169 hir::Unsafety::Normal,
1174 std::iter::once(inputs),
1175 tcx.mk_ty_infer(ty::TyVar(ty::TyVid { index: 0 })),
1177 hir::Unsafety::Normal,
1181 trait_ref.rebind(sig).to_string()
1184 let argument_is_closure = expected_ref.skip_binder().substs.type_at(0).is_closure();
1185 let mut err = struct_span_err!(
1189 "type mismatch in {} arguments",
1190 if argument_is_closure { "closure" } else { "function" }
1193 let found_str = format!("expected signature of `{}`", build_fn_sig_string(self.tcx, found));
1194 err.span_label(span, found_str);
1196 let found_span = found_span.unwrap_or(span);
1198 format!("found signature of `{}`", build_fn_sig_string(self.tcx, expected_ref));
1199 err.span_label(found_span, expected_str);
1204 fn suggest_fully_qualified_path(
1206 err: &mut DiagnosticBuilder<'_>,
1211 if let Some(assoc_item) = self.tcx.opt_associated_item(def_id) {
1212 if let ty::AssocKind::Const | ty::AssocKind::Type = assoc_item.kind {
1214 "{}s cannot be accessed directly on a `trait`, they can only be \
1215 accessed through a specific `impl`",
1216 assoc_item.kind.as_def_kind().descr(def_id)
1218 err.span_suggestion(
1220 "use the fully qualified path to an implementation",
1221 format!("<Type as {}>::{}", self.tcx.def_path_str(trait_ref), assoc_item.ident),
1222 Applicability::HasPlaceholders,
1228 /// Adds an async-await specific note to the diagnostic when the future does not implement
1229 /// an auto trait because of a captured type.
1232 /// note: future does not implement `Qux` as this value is used across an await
1233 /// --> $DIR/issue-64130-3-other.rs:17:5
1235 /// LL | let x = Foo;
1236 /// | - has type `Foo`
1237 /// LL | baz().await;
1238 /// | ^^^^^^^^^^^ await occurs here, with `x` maybe used later
1240 /// | - `x` is later dropped here
1243 /// When the diagnostic does not implement `Send` or `Sync` specifically, then the diagnostic
1244 /// is "replaced" with a different message and a more specific error.
1247 /// error: future cannot be sent between threads safely
1248 /// --> $DIR/issue-64130-2-send.rs:21:5
1250 /// LL | fn is_send<T: Send>(t: T) { }
1251 /// | ---- required by this bound in `is_send`
1253 /// LL | is_send(bar());
1254 /// | ^^^^^^^ future returned by `bar` is not send
1256 /// = help: within `impl std::future::Future`, the trait `std::marker::Send` is not
1257 /// implemented for `Foo`
1258 /// note: future is not send as this value is used across an await
1259 /// --> $DIR/issue-64130-2-send.rs:15:5
1261 /// LL | let x = Foo;
1262 /// | - has type `Foo`
1263 /// LL | baz().await;
1264 /// | ^^^^^^^^^^^ await occurs here, with `x` maybe used later
1266 /// | - `x` is later dropped here
1269 /// Returns `true` if an async-await specific note was added to the diagnostic.
1270 fn maybe_note_obligation_cause_for_async_await(
1272 err: &mut DiagnosticBuilder<'_>,
1273 obligation: &PredicateObligation<'tcx>,
1276 "maybe_note_obligation_cause_for_async_await: obligation.predicate={:?} \
1277 obligation.cause.span={:?}",
1278 obligation.predicate, obligation.cause.span
1280 let hir = self.tcx.hir();
1282 // Attempt to detect an async-await error by looking at the obligation causes, looking
1283 // for a generator to be present.
1285 // When a future does not implement a trait because of a captured type in one of the
1286 // generators somewhere in the call stack, then the result is a chain of obligations.
1288 // Given a `async fn` A that calls a `async fn` B which captures a non-send type and that
1289 // future is passed as an argument to a function C which requires a `Send` type, then the
1290 // chain looks something like this:
1292 // - `BuiltinDerivedObligation` with a generator witness (B)
1293 // - `BuiltinDerivedObligation` with a generator (B)
1294 // - `BuiltinDerivedObligation` with `std::future::GenFuture` (B)
1295 // - `BuiltinDerivedObligation` with `impl std::future::Future` (B)
1296 // - `BuiltinDerivedObligation` with `impl std::future::Future` (B)
1297 // - `BuiltinDerivedObligation` with a generator witness (A)
1298 // - `BuiltinDerivedObligation` with a generator (A)
1299 // - `BuiltinDerivedObligation` with `std::future::GenFuture` (A)
1300 // - `BuiltinDerivedObligation` with `impl std::future::Future` (A)
1301 // - `BuiltinDerivedObligation` with `impl std::future::Future` (A)
1302 // - `BindingObligation` with `impl_send (Send requirement)
1304 // The first obligation in the chain is the most useful and has the generator that captured
1305 // the type. The last generator (`outer_generator` below) has information about where the
1306 // bound was introduced. At least one generator should be present for this diagnostic to be
1308 let (mut trait_ref, mut target_ty) = match obligation.predicate.kind().skip_binder() {
1309 ty::PredicateKind::Trait(p, _) => (Some(p.trait_ref), Some(p.self_ty())),
1312 let mut generator = None;
1313 let mut outer_generator = None;
1314 let mut next_code = Some(&obligation.cause.code);
1316 let mut seen_upvar_tys_infer_tuple = false;
1318 while let Some(code) = next_code {
1319 debug!("maybe_note_obligation_cause_for_async_await: code={:?}", code);
1321 ObligationCauseCode::DerivedObligation(derived_obligation)
1322 | ObligationCauseCode::BuiltinDerivedObligation(derived_obligation)
1323 | ObligationCauseCode::ImplDerivedObligation(derived_obligation) => {
1324 let ty = derived_obligation.parent_trait_ref.skip_binder().self_ty();
1326 "maybe_note_obligation_cause_for_async_await: \
1327 parent_trait_ref={:?} self_ty.kind={:?}",
1328 derived_obligation.parent_trait_ref,
1333 ty::Generator(did, ..) => {
1334 generator = generator.or(Some(did));
1335 outer_generator = Some(did);
1337 ty::GeneratorWitness(..) => {}
1338 ty::Tuple(_) if !seen_upvar_tys_infer_tuple => {
1339 // By introducing a tuple of upvar types into the chain of obligations
1340 // of a generator, the first non-generator item is now the tuple itself,
1341 // we shall ignore this.
1343 seen_upvar_tys_infer_tuple = true;
1345 _ if generator.is_none() => {
1346 trait_ref = Some(derived_obligation.parent_trait_ref.skip_binder());
1347 target_ty = Some(ty);
1352 next_code = Some(derived_obligation.parent_code.as_ref());
1358 // Only continue if a generator was found.
1360 "maybe_note_obligation_cause_for_async_await: generator={:?} trait_ref={:?} \
1362 generator, trait_ref, target_ty
1364 let (generator_did, trait_ref, target_ty) = match (generator, trait_ref, target_ty) {
1365 (Some(generator_did), Some(trait_ref), Some(target_ty)) => {
1366 (generator_did, trait_ref, target_ty)
1371 let span = self.tcx.def_span(generator_did);
1373 // Do not ICE on closure typeck (#66868).
1374 if !generator_did.is_local() {
1378 // Get the typeck results from the infcx if the generator is the function we are
1379 // currently type-checking; otherwise, get them by performing a query.
1380 // This is needed to avoid cycles.
1381 let in_progress_typeck_results = self.in_progress_typeck_results.map(|t| t.borrow());
1382 let generator_did_root = self.tcx.closure_base_def_id(generator_did);
1384 "maybe_note_obligation_cause_for_async_await: generator_did={:?} \
1385 generator_did_root={:?} in_progress_typeck_results.hir_owner={:?} span={:?}",
1388 in_progress_typeck_results.as_ref().map(|t| t.hir_owner),
1391 let query_typeck_results;
1392 let typeck_results: &TypeckResults<'tcx> = match &in_progress_typeck_results {
1393 Some(t) if t.hir_owner.to_def_id() == generator_did_root => t,
1395 query_typeck_results = self.tcx.typeck(generator_did.expect_local());
1396 &query_typeck_results
1400 let generator_body = generator_did
1402 .map(|def_id| hir.local_def_id_to_hir_id(def_id))
1403 .and_then(|hir_id| hir.maybe_body_owned_by(hir_id))
1404 .map(|body_id| hir.body(body_id));
1405 let mut visitor = AwaitsVisitor::default();
1406 if let Some(body) = generator_body {
1407 visitor.visit_body(body);
1409 debug!("maybe_note_obligation_cause_for_async_await: awaits = {:?}", visitor.awaits);
1411 // Look for a type inside the generator interior that matches the target type to get
1413 let target_ty_erased = self.tcx.erase_regions(target_ty);
1414 let ty_matches = |ty| -> bool {
1415 // Careful: the regions for types that appear in the
1416 // generator interior are not generally known, so we
1417 // want to erase them when comparing (and anyway,
1418 // `Send` and other bounds are generally unaffected by
1419 // the choice of region). When erasing regions, we
1420 // also have to erase late-bound regions. This is
1421 // because the types that appear in the generator
1422 // interior generally contain "bound regions" to
1423 // represent regions that are part of the suspended
1424 // generator frame. Bound regions are preserved by
1425 // `erase_regions` and so we must also call
1426 // `erase_late_bound_regions`.
1427 let ty_erased = self.tcx.erase_late_bound_regions(ty);
1428 let ty_erased = self.tcx.erase_regions(ty_erased);
1429 let eq = ty::TyS::same_type(ty_erased, target_ty_erased);
1431 "maybe_note_obligation_cause_for_async_await: ty_erased={:?} \
1432 target_ty_erased={:?} eq={:?}",
1433 ty_erased, target_ty_erased, eq
1438 let mut interior_or_upvar_span = None;
1439 let mut interior_extra_info = None;
1441 if let Some(upvars) = self.tcx.upvars_mentioned(generator_did) {
1442 interior_or_upvar_span = upvars.iter().find_map(|(upvar_id, upvar)| {
1443 let upvar_ty = typeck_results.node_type(*upvar_id);
1444 let upvar_ty = self.resolve_vars_if_possible(upvar_ty);
1445 if ty_matches(ty::Binder::dummy(upvar_ty)) {
1446 Some(GeneratorInteriorOrUpvar::Upvar(upvar.span))
1453 // The generator interior types share the same binders
1454 if let Some(cause) =
1455 typeck_results.generator_interior_types.as_ref().skip_binder().iter().find(
1456 |ty::GeneratorInteriorTypeCause { ty, .. }| {
1457 ty_matches(typeck_results.generator_interior_types.rebind(ty))
1461 // Check to see if any awaited expressions have the target type.
1462 let from_awaited_ty = visitor
1465 .map(|id| hir.expect_expr(id))
1466 .find(|await_expr| {
1467 let ty = typeck_results.expr_ty_adjusted(&await_expr);
1469 "maybe_note_obligation_cause_for_async_await: await_expr={:?}",
1472 ty_matches(ty::Binder::dummy(ty))
1474 .map(|expr| expr.span);
1475 let ty::GeneratorInteriorTypeCause { span, scope_span, yield_span, expr, .. } = cause;
1477 interior_or_upvar_span = Some(GeneratorInteriorOrUpvar::Interior(*span));
1478 interior_extra_info = Some((*scope_span, *yield_span, *expr, from_awaited_ty));
1482 "maybe_note_obligation_cause_for_async_await: interior_or_upvar={:?} \
1483 generator_interior_types={:?}",
1484 interior_or_upvar_span, typeck_results.generator_interior_types
1486 if let Some(interior_or_upvar_span) = interior_or_upvar_span {
1487 self.note_obligation_cause_for_async_await(
1489 interior_or_upvar_span,
1490 interior_extra_info,
1505 /// Unconditionally adds the diagnostic note described in
1506 /// `maybe_note_obligation_cause_for_async_await`'s documentation comment.
1507 fn note_obligation_cause_for_async_await(
1509 err: &mut DiagnosticBuilder<'_>,
1510 interior_or_upvar_span: GeneratorInteriorOrUpvar,
1511 interior_extra_info: Option<(Option<Span>, Span, Option<hir::HirId>, Option<Span>)>,
1512 inner_generator_body: Option<&hir::Body<'tcx>>,
1513 outer_generator: Option<DefId>,
1514 trait_ref: ty::TraitRef<'tcx>,
1515 target_ty: Ty<'tcx>,
1516 typeck_results: &ty::TypeckResults<'tcx>,
1517 obligation: &PredicateObligation<'tcx>,
1518 next_code: Option<&ObligationCauseCode<'tcx>>,
1520 let source_map = self.tcx.sess.source_map();
1522 let is_async = inner_generator_body
1523 .and_then(|body| body.generator_kind())
1524 .map(|generator_kind| matches!(generator_kind, hir::GeneratorKind::Async(..)))
1526 let (await_or_yield, an_await_or_yield) =
1527 if is_async { ("await", "an await") } else { ("yield", "a yield") };
1528 let future_or_generator = if is_async { "future" } else { "generator" };
1530 // Special case the primary error message when send or sync is the trait that was
1532 let is_send = self.tcx.is_diagnostic_item(sym::send_trait, trait_ref.def_id);
1533 let is_sync = self.tcx.is_diagnostic_item(sym::sync_trait, trait_ref.def_id);
1534 let hir = self.tcx.hir();
1535 let trait_explanation = if is_send || is_sync {
1536 let (trait_name, trait_verb) =
1537 if is_send { ("`Send`", "sent") } else { ("`Sync`", "shared") };
1540 err.set_primary_message(format!(
1541 "{} cannot be {} between threads safely",
1542 future_or_generator, trait_verb
1545 let original_span = err.span.primary_span().unwrap();
1546 let mut span = MultiSpan::from_span(original_span);
1548 let message = outer_generator
1549 .and_then(|generator_did| {
1550 Some(match self.tcx.generator_kind(generator_did).unwrap() {
1551 GeneratorKind::Gen => format!("generator is not {}", trait_name),
1552 GeneratorKind::Async(AsyncGeneratorKind::Fn) => self
1554 .parent(generator_did)
1555 .and_then(|parent_did| parent_did.as_local())
1556 .map(|parent_did| hir.local_def_id_to_hir_id(parent_did))
1557 .and_then(|parent_hir_id| hir.opt_name(parent_hir_id))
1559 format!("future returned by `{}` is not {}", name, trait_name)
1561 GeneratorKind::Async(AsyncGeneratorKind::Block) => {
1562 format!("future created by async block is not {}", trait_name)
1564 GeneratorKind::Async(AsyncGeneratorKind::Closure) => {
1565 format!("future created by async closure is not {}", trait_name)
1569 .unwrap_or_else(|| format!("{} is not {}", future_or_generator, trait_name));
1571 span.push_span_label(original_span, message);
1574 format!("is not {}", trait_name)
1576 format!("does not implement `{}`", trait_ref.print_only_trait_path())
1579 let mut explain_yield =
1580 |interior_span: Span, yield_span: Span, scope_span: Option<Span>| {
1581 let mut span = MultiSpan::from_span(yield_span);
1582 if let Ok(snippet) = source_map.span_to_snippet(interior_span) {
1583 // #70935: If snippet contains newlines, display "the value" instead
1584 // so that we do not emit complex diagnostics.
1585 let snippet = &format!("`{}`", snippet);
1586 let snippet = if snippet.contains('\n') { "the value" } else { snippet };
1587 // The multispan can be complex here, like:
1588 // note: future is not `Send` as this value is used across an await
1589 // --> $DIR/issue-70935-complex-spans.rs:13:9
1591 // LL | baz(|| async{
1592 // | __________^___-
1595 // LL | || foo(tx.clone());
1596 // LL | || }).await;
1597 // | || - ^- value is later dropped here
1598 // | ||_________|______|
1599 // | |__________| await occurs here, with value maybe used later
1600 // | has type `closure` which is not `Send`
1602 // So, detect it and separate into some notes, like:
1604 // note: future is not `Send` as this value is used across an await
1605 // --> $DIR/issue-70935-complex-spans.rs:13:9
1607 // LL | / baz(|| async{
1608 // LL | | foo(tx.clone());
1610 // | |________________^ first, await occurs here, with the value maybe used later...
1611 // note: the value is later dropped here
1612 // --> $DIR/issue-70935-complex-spans.rs:15:17
1617 // If available, use the scope span to annotate the drop location.
1618 if let Some(scope_span) = scope_span {
1619 let scope_span = source_map.end_point(scope_span);
1621 yield_span.overlaps(scope_span) || yield_span.overlaps(interior_span);
1623 span.push_span_label(
1626 "first, {} occurs here, with {} maybe used later...",
1627 await_or_yield, snippet
1633 "{} {} as this value is used across {}",
1634 future_or_generator, trait_explanation, an_await_or_yield
1637 if source_map.is_multiline(interior_span) {
1640 &format!("{} is later dropped here", snippet),
1645 "this has type `{}` which {}",
1646 target_ty, trait_explanation
1650 let mut span = MultiSpan::from_span(scope_span);
1651 span.push_span_label(
1653 format!("has type `{}` which {}", target_ty, trait_explanation),
1655 err.span_note(span, &format!("{} is later dropped here", snippet));
1658 span.push_span_label(
1661 "{} occurs here, with {} maybe used later",
1662 await_or_yield, snippet
1665 span.push_span_label(
1667 format!("{} is later dropped here", snippet),
1669 span.push_span_label(
1671 format!("has type `{}` which {}", target_ty, trait_explanation),
1676 "{} {} as this value is used across {}",
1677 future_or_generator, trait_explanation, an_await_or_yield
1682 span.push_span_label(
1685 "{} occurs here, with {} maybe used later",
1686 await_or_yield, snippet
1689 span.push_span_label(
1691 format!("has type `{}` which {}", target_ty, trait_explanation),
1696 "{} {} as this value is used across {}",
1697 future_or_generator, trait_explanation, an_await_or_yield
1703 match interior_or_upvar_span {
1704 GeneratorInteriorOrUpvar::Interior(interior_span) => {
1705 if let Some((scope_span, yield_span, expr, from_awaited_ty)) = interior_extra_info {
1706 if let Some(await_span) = from_awaited_ty {
1707 // The type causing this obligation is one being awaited at await_span.
1708 let mut span = MultiSpan::from_span(await_span);
1709 span.push_span_label(
1712 "await occurs here on type `{}`, which {}",
1713 target_ty, trait_explanation
1719 "future {not_trait} as it awaits another future which {not_trait}",
1720 not_trait = trait_explanation
1724 // Look at the last interior type to get a span for the `.await`.
1726 "note_obligation_cause_for_async_await generator_interior_types: {:#?}",
1727 typeck_results.generator_interior_types
1729 explain_yield(interior_span, yield_span, scope_span);
1732 if let Some(expr_id) = expr {
1733 let expr = hir.expect_expr(expr_id);
1734 debug!("target_ty evaluated from {:?}", expr);
1736 let parent = hir.get_parent_node(expr_id);
1737 if let Some(hir::Node::Expr(e)) = hir.find(parent) {
1738 let parent_span = hir.span(parent);
1739 let parent_did = parent.owner.to_def_id();
1742 // fn foo(&self) -> i32 {}
1745 // ^^^^^^^ a temporary `&T` created inside this method call due to `&self`
1748 let is_region_borrow = typeck_results
1749 .expr_adjustments(expr)
1751 .any(|adj| adj.is_region_borrow());
1754 // struct Foo(*const u8);
1755 // bar(Foo(std::ptr::null())).await;
1756 // ^^^^^^^^^^^^^^^^^^^^^ raw-ptr `*T` created inside this struct ctor.
1758 debug!("parent_def_kind: {:?}", self.tcx.def_kind(parent_did));
1759 let is_raw_borrow_inside_fn_like_call =
1760 match self.tcx.def_kind(parent_did) {
1761 DefKind::Fn | DefKind::Ctor(..) => target_ty.is_unsafe_ptr(),
1765 if (typeck_results.is_method_call(e) && is_region_borrow)
1766 || is_raw_borrow_inside_fn_like_call
1770 "consider moving this into a `let` \
1771 binding to create a shorter lived borrow",
1778 GeneratorInteriorOrUpvar::Upvar(upvar_span) => {
1779 let mut span = MultiSpan::from_span(upvar_span);
1780 span.push_span_label(
1782 format!("has type `{}` which {}", target_ty, trait_explanation),
1784 err.span_note(span, &format!("captured value {}", trait_explanation));
1788 // Add a note for the item obligation that remains - normally a note pointing to the
1789 // bound that introduced the obligation (e.g. `T: Send`).
1790 debug!("note_obligation_cause_for_async_await: next_code={:?}", next_code);
1791 self.note_obligation_cause_code(
1793 &obligation.predicate,
1796 &mut Default::default(),
1800 fn note_obligation_cause_code<T>(
1802 err: &mut DiagnosticBuilder<'_>,
1804 cause_code: &ObligationCauseCode<'tcx>,
1805 obligated_types: &mut Vec<&ty::TyS<'tcx>>,
1806 seen_requirements: &mut FxHashSet<DefId>,
1812 ObligationCauseCode::ExprAssignable
1813 | ObligationCauseCode::MatchExpressionArm { .. }
1814 | ObligationCauseCode::Pattern { .. }
1815 | ObligationCauseCode::IfExpression { .. }
1816 | ObligationCauseCode::IfExpressionWithNoElse
1817 | ObligationCauseCode::MainFunctionType
1818 | ObligationCauseCode::StartFunctionType
1819 | ObligationCauseCode::IntrinsicType
1820 | ObligationCauseCode::MethodReceiver
1821 | ObligationCauseCode::ReturnNoExpression
1822 | ObligationCauseCode::UnifyReceiver(..)
1823 | ObligationCauseCode::MiscObligation => {}
1824 ObligationCauseCode::SliceOrArrayElem => {
1825 err.note("slice and array elements must have `Sized` type");
1827 ObligationCauseCode::TupleElem => {
1828 err.note("only the last element of a tuple may have a dynamically sized type");
1830 ObligationCauseCode::ProjectionWf(data) => {
1831 err.note(&format!("required so that the projection `{}` is well-formed", data,));
1833 ObligationCauseCode::ReferenceOutlivesReferent(ref_ty) => {
1835 "required so that reference `{}` does not outlive its referent",
1839 ObligationCauseCode::ObjectTypeBound(object_ty, region) => {
1841 "required so that the lifetime bound of `{}` for `{}` is satisfied",
1845 ObligationCauseCode::ItemObligation(item_def_id) => {
1846 let item_name = tcx.def_path_str(item_def_id);
1847 let msg = format!("required by `{}`", item_name);
1848 if let Some(sp) = tcx.hir().span_if_local(item_def_id) {
1849 let sp = tcx.sess.source_map().guess_head_span(sp);
1850 err.span_label(sp, &msg);
1855 ObligationCauseCode::BindingObligation(item_def_id, span) => {
1856 let item_name = tcx.def_path_str(item_def_id);
1857 let msg = format!("required by this bound in `{}`", item_name);
1858 if let Some(ident) = tcx.opt_item_name(item_def_id) {
1859 let sm = tcx.sess.source_map();
1861 match (sm.lookup_line(ident.span.hi()), sm.lookup_line(span.lo())) {
1862 (Ok(l), Ok(r)) => l.line == r.line,
1865 if !ident.span.overlaps(span) && !same_line {
1866 err.span_label(ident.span, "required by a bound in this");
1869 if span != DUMMY_SP {
1870 err.span_label(span, &msg);
1875 ObligationCauseCode::ObjectCastObligation(object_ty) => {
1877 "required for the cast to the object type `{}`",
1878 self.ty_to_string(object_ty)
1881 ObligationCauseCode::Coercion { source: _, target } => {
1882 err.note(&format!("required by cast to type `{}`", self.ty_to_string(target)));
1884 ObligationCauseCode::RepeatVec(suggest_const_in_array_repeat_expressions) => {
1886 "the `Copy` trait is required because the repeated element will be copied",
1888 if suggest_const_in_array_repeat_expressions {
1890 "this array initializer can be evaluated at compile-time, see issue \
1891 #49147 <https://github.com/rust-lang/rust/issues/49147> \
1892 for more information",
1894 if tcx.sess.opts.unstable_features.is_nightly_build() {
1896 "add `#![feature(const_in_array_repeat_expressions)]` to the \
1897 crate attributes to enable",
1902 ObligationCauseCode::VariableType(hir_id) => {
1903 let parent_node = self.tcx.hir().get_parent_node(hir_id);
1904 match self.tcx.hir().find(parent_node) {
1905 Some(Node::Local(hir::Local {
1906 init: Some(hir::Expr { kind: hir::ExprKind::Index(_, _), span, .. }),
1909 // When encountering an assignment of an unsized trait, like
1910 // `let x = ""[..];`, provide a suggestion to borrow the initializer in
1911 // order to use have a slice instead.
1912 err.span_suggestion_verbose(
1913 span.shrink_to_lo(),
1914 "consider borrowing here",
1916 Applicability::MachineApplicable,
1918 err.note("all local variables must have a statically known size");
1920 Some(Node::Param(param)) => {
1921 err.span_suggestion_verbose(
1922 param.ty_span.shrink_to_lo(),
1923 "function arguments must have a statically known size, borrowed types \
1924 always have a known size",
1926 Applicability::MachineApplicable,
1930 err.note("all local variables must have a statically known size");
1933 if !self.tcx.features().unsized_locals {
1934 err.help("unsized locals are gated as an unstable feature");
1937 ObligationCauseCode::SizedArgumentType(sp) => {
1938 if let Some(span) = sp {
1939 err.span_suggestion_verbose(
1940 span.shrink_to_lo(),
1941 "function arguments must have a statically known size, borrowed types \
1942 always have a known size",
1944 Applicability::MachineApplicable,
1947 err.note("all function arguments must have a statically known size");
1949 if tcx.sess.opts.unstable_features.is_nightly_build()
1950 && !self.tcx.features().unsized_fn_params
1952 err.help("unsized fn params are gated as an unstable feature");
1955 ObligationCauseCode::SizedReturnType => {
1956 err.note("the return type of a function must have a statically known size");
1958 ObligationCauseCode::SizedYieldType => {
1959 err.note("the yield type of a generator must have a statically known size");
1961 ObligationCauseCode::AssignmentLhsSized => {
1962 err.note("the left-hand-side of an assignment must have a statically known size");
1964 ObligationCauseCode::TupleInitializerSized => {
1965 err.note("tuples must have a statically known size to be initialized");
1967 ObligationCauseCode::StructInitializerSized => {
1968 err.note("structs must have a statically known size to be initialized");
1970 ObligationCauseCode::FieldSized { adt_kind: ref item, last, span } => {
1972 AdtKind::Struct => {
1975 "the last field of a packed struct may only have a \
1976 dynamically sized type if it does not need drop to be run",
1980 "only the last field of a struct may have a dynamically sized type",
1985 err.note("no field of a union may have a dynamically sized type");
1988 err.note("no field of an enum variant may have a dynamically sized type");
1991 err.help("change the field's type to have a statically known size");
1992 err.span_suggestion(
1993 span.shrink_to_lo(),
1994 "borrowed types always have a statically known size",
1996 Applicability::MachineApplicable,
1998 err.multipart_suggestion(
1999 "the `Box` type always has a statically known size and allocates its contents \
2002 (span.shrink_to_lo(), "Box<".to_string()),
2003 (span.shrink_to_hi(), ">".to_string()),
2005 Applicability::MachineApplicable,
2008 ObligationCauseCode::ConstSized => {
2009 err.note("constant expressions must have a statically known size");
2011 ObligationCauseCode::InlineAsmSized => {
2012 err.note("all inline asm arguments must have a statically known size");
2014 ObligationCauseCode::ConstPatternStructural => {
2015 err.note("constants used for pattern-matching must derive `PartialEq` and `Eq`");
2017 ObligationCauseCode::SharedStatic => {
2018 err.note("shared static variables must have a type that implements `Sync`");
2020 ObligationCauseCode::BuiltinDerivedObligation(ref data) => {
2021 let parent_trait_ref = self.resolve_vars_if_possible(data.parent_trait_ref);
2022 let ty = parent_trait_ref.skip_binder().self_ty();
2023 if parent_trait_ref.references_error() {
2028 // If the obligation for a tuple is set directly by a Generator or Closure,
2029 // then the tuple must be the one containing capture types.
2030 let is_upvar_tys_infer_tuple = if !matches!(ty.kind(), ty::Tuple(..)) {
2033 if let ObligationCauseCode::BuiltinDerivedObligation(ref data) =
2036 let parent_trait_ref = self.resolve_vars_if_possible(data.parent_trait_ref);
2037 let ty = parent_trait_ref.skip_binder().self_ty();
2038 matches!(ty.kind(), ty::Generator(..))
2039 || matches!(ty.kind(), ty::Closure(..))
2045 // Don't print the tuple of capture types
2046 if !is_upvar_tys_infer_tuple {
2047 err.note(&format!("required because it appears within the type `{}`", ty));
2050 obligated_types.push(ty);
2052 let parent_predicate = parent_trait_ref.without_const().to_predicate(tcx);
2053 if !self.is_recursive_obligation(obligated_types, &data.parent_code) {
2054 // #74711: avoid a stack overflow
2055 ensure_sufficient_stack(|| {
2056 self.note_obligation_cause_code(
2066 ObligationCauseCode::ImplDerivedObligation(ref data) => {
2067 let mut parent_trait_ref = self.resolve_vars_if_possible(data.parent_trait_ref);
2068 let parent_def_id = parent_trait_ref.def_id();
2070 "required because of the requirements on the impl of `{}` for `{}`",
2071 parent_trait_ref.print_only_trait_path(),
2072 parent_trait_ref.skip_binder().self_ty()
2075 let mut parent_predicate = parent_trait_ref.without_const().to_predicate(tcx);
2076 let mut data = data;
2078 seen_requirements.insert(parent_def_id);
2079 while let ObligationCauseCode::ImplDerivedObligation(child) = &*data.parent_code {
2080 // Skip redundant recursive obligation notes. See `ui/issue-20413.rs`.
2081 let child_trait_ref = self.resolve_vars_if_possible(child.parent_trait_ref);
2082 let child_def_id = child_trait_ref.def_id();
2083 if seen_requirements.insert(child_def_id) {
2088 parent_predicate = child_trait_ref.without_const().to_predicate(tcx);
2089 parent_trait_ref = child_trait_ref;
2092 err.note(&format!("{} redundant requirements hidden", count));
2094 "required because of the requirements on the impl of `{}` for `{}`",
2095 parent_trait_ref.print_only_trait_path(),
2096 parent_trait_ref.skip_binder().self_ty()
2099 // #74711: avoid a stack overflow
2100 ensure_sufficient_stack(|| {
2101 self.note_obligation_cause_code(
2110 ObligationCauseCode::DerivedObligation(ref data) => {
2111 let parent_trait_ref = self.resolve_vars_if_possible(data.parent_trait_ref);
2112 let parent_predicate = parent_trait_ref.without_const().to_predicate(tcx);
2113 // #74711: avoid a stack overflow
2114 ensure_sufficient_stack(|| {
2115 self.note_obligation_cause_code(
2124 ObligationCauseCode::CompareImplMethodObligation { .. } => {
2126 "the requirement `{}` appears on the impl method but not on the corresponding \
2131 ObligationCauseCode::CompareImplTypeObligation { .. } => {
2133 "the requirement `{}` appears on the associated impl type but not on the \
2134 corresponding associated trait type",
2138 ObligationCauseCode::CompareImplConstObligation => {
2140 "the requirement `{}` appears on the associated impl constant \
2141 but not on the corresponding associated trait constant",
2145 ObligationCauseCode::ReturnType
2146 | ObligationCauseCode::ReturnValue(_)
2147 | ObligationCauseCode::BlockTailExpression(_) => (),
2148 ObligationCauseCode::TrivialBound => {
2149 err.help("see issue #48214");
2150 if tcx.sess.opts.unstable_features.is_nightly_build() {
2151 err.help("add `#![feature(trivial_bounds)]` to the crate attributes to enable");
2157 fn suggest_new_overflow_limit(&self, err: &mut DiagnosticBuilder<'_>) {
2158 let current_limit = self.tcx.sess.recursion_limit();
2159 let suggested_limit = current_limit * 2;
2161 "consider adding a `#![recursion_limit=\"{}\"]` attribute to your crate (`{}`)",
2162 suggested_limit, self.tcx.crate_name,
2166 fn suggest_await_before_try(
2168 err: &mut DiagnosticBuilder<'_>,
2169 obligation: &PredicateObligation<'tcx>,
2170 trait_ref: ty::Binder<ty::TraitRef<'tcx>>,
2174 "suggest_await_before_try: obligation={:?}, span={:?}, trait_ref={:?}, trait_ref_self_ty={:?}",
2180 let body_hir_id = obligation.cause.body_id;
2181 let item_id = self.tcx.hir().get_parent_node(body_hir_id);
2183 if let Some(body_id) = self.tcx.hir().maybe_body_owned_by(item_id) {
2184 let body = self.tcx.hir().body(body_id);
2185 if let Some(hir::GeneratorKind::Async(_)) = body.generator_kind {
2186 let future_trait = self.tcx.require_lang_item(LangItem::Future, None);
2188 let self_ty = self.resolve_vars_if_possible(trait_ref.self_ty());
2190 // Do not check on infer_types to avoid panic in evaluate_obligation.
2191 if self_ty.has_infer_types() {
2194 let self_ty = self.tcx.erase_regions(self_ty);
2196 let impls_future = self.tcx.type_implements_trait((
2198 self_ty.skip_binder(),
2200 obligation.param_env,
2203 let item_def_id = self
2205 .associated_items(future_trait)
2206 .in_definition_order()
2210 // `<T as Future>::Output`
2211 let projection_ty = ty::ProjectionTy {
2213 substs: self.tcx.mk_substs_trait(
2214 trait_ref.self_ty().skip_binder(),
2215 self.fresh_substs_for_item(span, item_def_id),
2221 let mut selcx = SelectionContext::new(self);
2223 let mut obligations = vec![];
2224 let normalized_ty = normalize_projection_type(
2226 obligation.param_env,
2228 obligation.cause.clone(),
2234 "suggest_await_before_try: normalized_projection_type {:?}",
2235 self.resolve_vars_if_possible(normalized_ty)
2237 let try_obligation = self.mk_trait_obligation_with_new_self_ty(
2238 obligation.param_env,
2242 debug!("suggest_await_before_try: try_trait_obligation {:?}", try_obligation);
2243 if self.predicate_may_hold(&try_obligation) && impls_future {
2244 if let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) {
2245 if snippet.ends_with('?') {
2246 err.span_suggestion_verbose(
2247 span.with_hi(span.hi() - BytePos(1)).shrink_to_hi(),
2248 "consider `await`ing on the `Future`",
2249 ".await".to_string(),
2250 Applicability::MaybeIncorrect,
2260 /// Collect all the returned expressions within the input expression.
2261 /// Used to point at the return spans when we want to suggest some change to them.
2263 pub struct ReturnsVisitor<'v> {
2264 pub returns: Vec<&'v hir::Expr<'v>>,
2265 in_block_tail: bool,
2268 impl<'v> Visitor<'v> for ReturnsVisitor<'v> {
2269 type Map = hir::intravisit::ErasedMap<'v>;
2271 fn nested_visit_map(&mut self) -> hir::intravisit::NestedVisitorMap<Self::Map> {
2272 hir::intravisit::NestedVisitorMap::None
2275 fn visit_expr(&mut self, ex: &'v hir::Expr<'v>) {
2276 // Visit every expression to detect `return` paths, either through the function's tail
2277 // expression or `return` statements. We walk all nodes to find `return` statements, but
2278 // we only care about tail expressions when `in_block_tail` is `true`, which means that
2279 // they're in the return path of the function body.
2281 hir::ExprKind::Ret(Some(ex)) => {
2282 self.returns.push(ex);
2284 hir::ExprKind::Block(block, _) if self.in_block_tail => {
2285 self.in_block_tail = false;
2286 for stmt in block.stmts {
2287 hir::intravisit::walk_stmt(self, stmt);
2289 self.in_block_tail = true;
2290 if let Some(expr) = block.expr {
2291 self.visit_expr(expr);
2294 hir::ExprKind::If(_, then, else_opt) if self.in_block_tail => {
2295 self.visit_expr(then);
2296 if let Some(el) = else_opt {
2297 self.visit_expr(el);
2300 hir::ExprKind::Match(_, arms, _) if self.in_block_tail => {
2302 self.visit_expr(arm.body);
2305 // We need to walk to find `return`s in the entire body.
2306 _ if !self.in_block_tail => hir::intravisit::walk_expr(self, ex),
2307 _ => self.returns.push(ex),
2311 fn visit_body(&mut self, body: &'v hir::Body<'v>) {
2312 assert!(!self.in_block_tail);
2313 if body.generator_kind().is_none() {
2314 if let hir::ExprKind::Block(block, None) = body.value.kind {
2315 if block.expr.is_some() {
2316 self.in_block_tail = true;
2320 hir::intravisit::walk_body(self, body);
2324 /// Collect all the awaited expressions within the input expression.
2326 struct AwaitsVisitor {
2327 awaits: Vec<hir::HirId>,
2330 impl<'v> Visitor<'v> for AwaitsVisitor {
2331 type Map = hir::intravisit::ErasedMap<'v>;
2333 fn nested_visit_map(&mut self) -> hir::intravisit::NestedVisitorMap<Self::Map> {
2334 hir::intravisit::NestedVisitorMap::None
2337 fn visit_expr(&mut self, ex: &'v hir::Expr<'v>) {
2338 if let hir::ExprKind::Yield(_, hir::YieldSource::Await { expr: Some(id) }) = ex.kind {
2339 self.awaits.push(id)
2341 hir::intravisit::walk_expr(self, ex)
2345 pub trait NextTypeParamName {
2346 fn next_type_param_name(&self, name: Option<&str>) -> String;
2349 impl NextTypeParamName for &[hir::GenericParam<'_>] {
2350 fn next_type_param_name(&self, name: Option<&str>) -> String {
2351 // This is the list of possible parameter names that we might suggest.
2352 let name = name.and_then(|n| n.chars().next()).map(|c| c.to_string().to_uppercase());
2353 let name = name.as_deref();
2354 let possible_names = [name.unwrap_or("T"), "T", "U", "V", "X", "Y", "Z", "A", "B", "C"];
2355 let used_names = self
2357 .filter_map(|p| match p.name {
2358 hir::ParamName::Plain(ident) => Some(ident.name),
2361 .collect::<Vec<_>>();
2365 .find(|n| !used_names.contains(&Symbol::intern(n)))
2366 .unwrap_or(&"ParamName")
2371 fn suggest_trait_object_return_type_alternatives(
2372 err: &mut DiagnosticBuilder<'_>,
2375 is_object_safe: bool,
2377 err.span_suggestion(
2379 "use some type `T` that is `T: Sized` as the return type if all return paths have the \
2382 Applicability::MaybeIncorrect,
2384 err.span_suggestion(
2387 "use `impl {}` as the return type if all return paths have the same type but you \
2388 want to expose only the trait in the signature",
2391 format!("impl {}", trait_obj),
2392 Applicability::MaybeIncorrect,
2395 err.span_suggestion(
2398 "use a boxed trait object if all return paths implement trait `{}`",
2401 format!("Box<dyn {}>", trait_obj),
2402 Applicability::MaybeIncorrect,