3 //! Under certain circumstances we will coerce from one type to another,
4 //! for example by auto-borrowing. This occurs in situations where the
5 //! compiler has a firm 'expected type' that was supplied from the user,
6 //! and where the actual type is similar to that expected type in purpose
7 //! but not in representation (so actual subtyping is inappropriate).
11 //! Note that if we are expecting a reference, we will *reborrow*
12 //! even if the argument provided was already a reference. This is
13 //! useful for freezing mut things (that is, when the expected type is &T
14 //! but you have &mut T) and also for avoiding the linearity
15 //! of mut things (when the expected is &mut T and you have &mut T). See
16 //! the various `src/test/ui/coerce/*.rs` tests for
17 //! examples of where this is useful.
21 //! When inferring the generic arguments of functions, the argument
22 //! order is relevant, which can lead to the following edge case:
24 //! ```ignore (illustrative)
25 //! fn foo<T>(a: T, b: T) {
29 //! foo(&7i32, &mut 7i32);
30 //! // This compiles, as we first infer `T` to be `&i32`,
31 //! // and then coerce `&mut 7i32` to `&7i32`.
33 //! foo(&mut 7i32, &7i32);
34 //! // This does not compile, as we first infer `T` to be `&mut i32`
35 //! // and are then unable to coerce `&7i32` to `&mut i32`.
40 struct_span_err, Applicability, Diagnostic, DiagnosticBuilder, ErrorGuaranteed, MultiSpan,
43 use rustc_hir::def_id::DefId;
44 use rustc_hir::intravisit::{self, Visitor};
46 use rustc_hir_analysis::astconv::AstConv;
47 use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
48 use rustc_infer::infer::{Coercion, InferOk, InferResult};
49 use rustc_infer::traits::{Obligation, TraitEngine, TraitEngineExt};
50 use rustc_middle::lint::in_external_macro;
51 use rustc_middle::ty::adjustment::{
52 Adjust, Adjustment, AllowTwoPhase, AutoBorrow, AutoBorrowMutability, PointerCast,
54 use rustc_middle::ty::error::TypeError;
55 use rustc_middle::ty::relate::RelateResult;
56 use rustc_middle::ty::subst::SubstsRef;
57 use rustc_middle::ty::visit::TypeVisitable;
58 use rustc_middle::ty::{self, Ty, TypeAndMut};
59 use rustc_session::parse::feature_err;
60 use rustc_span::symbol::sym;
61 use rustc_span::{self, BytePos, DesugaringKind, Span};
62 use rustc_target::spec::abi::Abi;
63 use rustc_trait_selection::infer::InferCtxtExt as _;
64 use rustc_trait_selection::traits::error_reporting::TypeErrCtxtExt as _;
65 use rustc_trait_selection::traits::TraitEngineExt as _;
66 use rustc_trait_selection::traits::{self, ObligationCause, ObligationCauseCode};
68 use smallvec::{smallvec, SmallVec};
71 struct Coerce<'a, 'tcx> {
72 fcx: &'a FnCtxt<'a, 'tcx>,
73 cause: ObligationCause<'tcx>,
75 /// Determines whether or not allow_two_phase_borrow is set on any
76 /// autoref adjustments we create while coercing. We don't want to
77 /// allow deref coercions to create two-phase borrows, at least initially,
78 /// but we do need two-phase borrows for function argument reborrows.
79 /// See #47489 and #48598
80 /// See docs on the "AllowTwoPhase" type for a more detailed discussion
81 allow_two_phase: AllowTwoPhase,
84 impl<'a, 'tcx> Deref for Coerce<'a, 'tcx> {
85 type Target = FnCtxt<'a, 'tcx>;
86 fn deref(&self) -> &Self::Target {
91 type CoerceResult<'tcx> = InferResult<'tcx, (Vec<Adjustment<'tcx>>, Ty<'tcx>)>;
93 struct CollectRetsVisitor<'tcx> {
94 ret_exprs: Vec<&'tcx hir::Expr<'tcx>>,
97 impl<'tcx> Visitor<'tcx> for CollectRetsVisitor<'tcx> {
98 fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) {
99 if let hir::ExprKind::Ret(_) = expr.kind {
100 self.ret_exprs.push(expr);
102 intravisit::walk_expr(self, expr);
106 /// Coercing a mutable reference to an immutable works, while
107 /// coercing `&T` to `&mut T` should be forbidden.
108 fn coerce_mutbls<'tcx>(
109 from_mutbl: hir::Mutability,
110 to_mutbl: hir::Mutability,
111 ) -> RelateResult<'tcx, ()> {
112 match (from_mutbl, to_mutbl) {
113 (hir::Mutability::Mut, hir::Mutability::Mut | hir::Mutability::Not)
114 | (hir::Mutability::Not, hir::Mutability::Not) => Ok(()),
115 (hir::Mutability::Not, hir::Mutability::Mut) => Err(TypeError::Mutability),
119 /// Do not require any adjustments, i.e. coerce `x -> x`.
120 fn identity(_: Ty<'_>) -> Vec<Adjustment<'_>> {
124 fn simple<'tcx>(kind: Adjust<'tcx>) -> impl FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>> {
125 move |target| vec![Adjustment { kind, target }]
128 /// This always returns `Ok(...)`.
130 adj: Vec<Adjustment<'tcx>>,
132 obligations: traits::PredicateObligations<'tcx>,
133 ) -> CoerceResult<'tcx> {
134 Ok(InferOk { value: (adj, target), obligations })
137 impl<'f, 'tcx> Coerce<'f, 'tcx> {
139 fcx: &'f FnCtxt<'f, 'tcx>,
140 cause: ObligationCause<'tcx>,
141 allow_two_phase: AllowTwoPhase,
143 Coerce { fcx, cause, allow_two_phase, use_lub: false }
146 fn unify(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> InferResult<'tcx, Ty<'tcx>> {
147 debug!("unify(a: {:?}, b: {:?}, use_lub: {})", a, b, self.use_lub);
148 self.commit_if_ok(|_| {
150 self.at(&self.cause, self.fcx.param_env).lub(b, a)
152 self.at(&self.cause, self.fcx.param_env)
154 .map(|InferOk { value: (), obligations }| InferOk { value: a, obligations })
159 /// Unify two types (using sub or lub) and produce a specific coercion.
160 fn unify_and<F>(&self, a: Ty<'tcx>, b: Ty<'tcx>, f: F) -> CoerceResult<'tcx>
162 F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
165 .and_then(|InferOk { value: ty, obligations }| success(f(ty), ty, obligations))
168 #[instrument(skip(self))]
169 fn coerce(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
170 // First, remove any resolved type variables (at the top level, at least):
171 let a = self.shallow_resolve(a);
172 let b = self.shallow_resolve(b);
173 debug!("Coerce.tys({:?} => {:?})", a, b);
175 // Just ignore error types.
176 if a.references_error() || b.references_error() {
177 return success(vec![], self.fcx.tcx.ty_error(), vec![]);
180 // Coercing from `!` to any type is allowed:
182 return success(simple(Adjust::NeverToAny)(b), b, vec![]);
185 // Coercing *from* an unresolved inference variable means that
186 // we have no information about the source type. This will always
187 // ultimately fall back to some form of subtyping.
189 return self.coerce_from_inference_variable(a, b, identity);
192 // Consider coercing the subtype to a DST
194 // NOTE: this is wrapped in a `commit_if_ok` because it creates
195 // a "spurious" type variable, and we don't want to have that
196 // type variable in memory if the coercion fails.
197 let unsize = self.commit_if_ok(|_| self.coerce_unsized(a, b));
200 debug!("coerce: unsize successful");
203 Err(TypeError::ObjectUnsafeCoercion(did)) => {
204 debug!("coerce: unsize not object safe");
205 return Err(TypeError::ObjectUnsafeCoercion(did));
208 debug!(?error, "coerce: unsize failed");
212 // Examine the supertype and consider auto-borrowing.
214 ty::RawPtr(mt_b) => {
215 return self.coerce_unsafe_ptr(a, b, mt_b.mutbl);
217 ty::Ref(r_b, _, mutbl_b) => {
218 return self.coerce_borrowed_pointer(a, b, r_b, mutbl_b);
220 ty::Dynamic(predicates, region, ty::DynStar) if self.tcx.features().dyn_star => {
221 return self.coerce_dyn_star(a, b, predicates, region);
228 // Function items are coercible to any closure
229 // type; function pointers are not (that would
230 // require double indirection).
231 // Additionally, we permit coercion of function
232 // items to drop the unsafe qualifier.
233 self.coerce_from_fn_item(a, b)
236 // We permit coercion of fn pointers to drop the
238 self.coerce_from_fn_pointer(a, a_f, b)
240 ty::Closure(closure_def_id_a, substs_a) => {
241 // Non-capturing closures are coercible to
242 // function pointers or unsafe function pointers.
243 // It cannot convert closures that require unsafe.
244 self.coerce_closure_to_fn(a, closure_def_id_a, substs_a, b)
247 // Otherwise, just use unification rules.
248 self.unify_and(a, b, identity)
253 /// Coercing *from* an inference variable. In this case, we have no information
254 /// about the source type, so we can't really do a true coercion and we always
255 /// fall back to subtyping (`unify_and`).
256 fn coerce_from_inference_variable(
260 make_adjustments: impl FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
261 ) -> CoerceResult<'tcx> {
262 debug!("coerce_from_inference_variable(a={:?}, b={:?})", a, b);
263 assert!(a.is_ty_var() && self.shallow_resolve(a) == a);
264 assert!(self.shallow_resolve(b) == b);
267 // Two unresolved type variables: create a `Coerce` predicate.
268 let target_ty = if self.use_lub {
269 self.next_ty_var(TypeVariableOrigin {
270 kind: TypeVariableOriginKind::LatticeVariable,
271 span: self.cause.span,
277 let mut obligations = Vec::with_capacity(2);
278 for &source_ty in &[a, b] {
279 if source_ty != target_ty {
280 obligations.push(Obligation::new(
284 ty::Binder::dummy(ty::PredicateKind::Coerce(ty::CoercePredicate {
293 "coerce_from_inference_variable: two inference variables, target_ty={:?}, obligations={:?}",
294 target_ty, obligations
296 let adjustments = make_adjustments(target_ty);
297 InferResult::Ok(InferOk { value: (adjustments, target_ty), obligations })
299 // One unresolved type variable: just apply subtyping, we may be able
300 // to do something useful.
301 self.unify_and(a, b, make_adjustments)
305 /// Reborrows `&mut A` to `&mut B` and `&(mut) A` to `&B`.
306 /// To match `A` with `B`, autoderef will be performed,
307 /// calling `deref`/`deref_mut` where necessary.
308 fn coerce_borrowed_pointer(
312 r_b: ty::Region<'tcx>,
313 mutbl_b: hir::Mutability,
314 ) -> CoerceResult<'tcx> {
315 debug!("coerce_borrowed_pointer(a={:?}, b={:?})", a, b);
317 // If we have a parameter of type `&M T_a` and the value
318 // provided is `expr`, we will be adding an implicit borrow,
319 // meaning that we convert `f(expr)` to `f(&M *expr)`. Therefore,
320 // to type check, we will construct the type that `&M*expr` would
323 let (r_a, mt_a) = match *a.kind() {
324 ty::Ref(r_a, ty, mutbl) => {
325 let mt_a = ty::TypeAndMut { ty, mutbl };
326 coerce_mutbls(mt_a.mutbl, mutbl_b)?;
329 _ => return self.unify_and(a, b, identity),
332 let span = self.cause.span;
334 let mut first_error = None;
335 let mut r_borrow_var = None;
336 let mut autoderef = self.autoderef(span, a);
337 let mut found = None;
339 for (referent_ty, autoderefs) in autoderef.by_ref() {
341 // Don't let this pass, otherwise it would cause
342 // &T to autoref to &&T.
346 // At this point, we have deref'd `a` to `referent_ty`. So
347 // imagine we are coercing from `&'a mut Vec<T>` to `&'b mut [T]`.
348 // In the autoderef loop for `&'a mut Vec<T>`, we would get
351 // - `&'a mut Vec<T>` -- 0 derefs, just ignore it
352 // - `Vec<T>` -- 1 deref
353 // - `[T]` -- 2 deref
355 // At each point after the first callback, we want to
356 // check to see whether this would match out target type
357 // (`&'b mut [T]`) if we autoref'd it. We can't just
358 // compare the referent types, though, because we still
359 // have to consider the mutability. E.g., in the case
360 // we've been considering, we have an `&mut` reference, so
361 // the `T` in `[T]` needs to be unified with equality.
363 // Therefore, we construct reference types reflecting what
364 // the types will be after we do the final auto-ref and
365 // compare those. Note that this means we use the target
366 // mutability [1], since it may be that we are coercing
367 // from `&mut T` to `&U`.
369 // One fine point concerns the region that we use. We
370 // choose the region such that the region of the final
371 // type that results from `unify` will be the region we
372 // want for the autoref:
374 // - if in sub mode, that means we want to use `'b` (the
375 // region from the target reference) for both
376 // pointers [2]. This is because sub mode (somewhat
377 // arbitrarily) returns the subtype region. In the case
378 // where we are coercing to a target type, we know we
379 // want to use that target type region (`'b`) because --
380 // for the program to type-check -- it must be the
381 // smaller of the two.
382 // - One fine point. It may be surprising that we can
383 // use `'b` without relating `'a` and `'b`. The reason
384 // that this is ok is that what we produce is
385 // effectively a `&'b *x` expression (if you could
386 // annotate the region of a borrow), and regionck has
387 // code that adds edges from the region of a borrow
388 // (`'b`, here) into the regions in the borrowed
389 // expression (`*x`, here). (Search for "link".)
390 // - if in lub mode, things can get fairly complicated. The
391 // easiest thing is just to make a fresh
392 // region variable [4], which effectively means we defer
393 // the decision to region inference (and regionck, which will add
394 // some more edges to this variable). However, this can wind up
395 // creating a crippling number of variables in some cases --
396 // e.g., #32278 -- so we optimize one particular case [3].
397 // Let me try to explain with some examples:
398 // - The "running example" above represents the simple case,
399 // where we have one `&` reference at the outer level and
400 // ownership all the rest of the way down. In this case,
401 // we want `LUB('a, 'b)` as the resulting region.
402 // - However, if there are nested borrows, that region is
403 // too strong. Consider a coercion from `&'a &'x Rc<T>` to
404 // `&'b T`. In this case, `'a` is actually irrelevant.
405 // The pointer we want is `LUB('x, 'b`). If we choose `LUB('a,'b)`
406 // we get spurious errors (`ui/regions-lub-ref-ref-rc.rs`).
407 // (The errors actually show up in borrowck, typically, because
408 // this extra edge causes the region `'a` to be inferred to something
409 // too big, which then results in borrowck errors.)
410 // - We could track the innermost shared reference, but there is already
411 // code in regionck that has the job of creating links between
412 // the region of a borrow and the regions in the thing being
413 // borrowed (here, `'a` and `'x`), and it knows how to handle
414 // all the various cases. So instead we just make a region variable
415 // and let regionck figure it out.
416 let r = if !self.use_lub {
418 } else if autoderefs == 1 {
421 if r_borrow_var.is_none() {
422 // create var lazily, at most once
423 let coercion = Coercion(span);
424 let r = self.next_region_var(coercion);
425 r_borrow_var = Some(r); // [4] above
427 r_borrow_var.unwrap()
429 let derefd_ty_a = self.tcx.mk_ref(
433 mutbl: mutbl_b, // [1] above
436 match self.unify(derefd_ty_a, b) {
442 if first_error.is_none() {
443 first_error = Some(err);
449 // Extract type or return an error. We return the first error
450 // we got, which should be from relating the "base" type
451 // (e.g., in example above, the failure from relating `Vec<T>`
452 // to the target type), since that should be the least
454 let Some(InferOk { value: ty, mut obligations }) = found else {
455 let err = first_error.expect("coerce_borrowed_pointer had no error");
456 debug!("coerce_borrowed_pointer: failed with err = {:?}", err);
460 if ty == a && mt_a.mutbl == hir::Mutability::Not && autoderef.step_count() == 1 {
461 // As a special case, if we would produce `&'a *x`, that's
462 // a total no-op. We end up with the type `&'a T` just as
463 // we started with. In that case, just skip it
464 // altogether. This is just an optimization.
466 // Note that for `&mut`, we DO want to reborrow --
467 // otherwise, this would be a move, which might be an
468 // error. For example `foo(self.x)` where `self` and
469 // `self.x` both have `&mut `type would be a move of
470 // `self.x`, but we auto-coerce it to `foo(&mut *self.x)`,
471 // which is a borrow.
472 assert_eq!(mutbl_b, hir::Mutability::Not); // can only coerce &T -> &U
473 return success(vec![], ty, obligations);
476 let InferOk { value: mut adjustments, obligations: o } =
477 self.adjust_steps_as_infer_ok(&autoderef);
478 obligations.extend(o);
479 obligations.extend(autoderef.into_obligations());
481 // Now apply the autoref. We have to extract the region out of
482 // the final ref type we got.
483 let ty::Ref(r_borrow, _, _) = ty.kind() else {
484 span_bug!(span, "expected a ref type, got {:?}", ty);
486 let mutbl = match mutbl_b {
487 hir::Mutability::Not => AutoBorrowMutability::Not,
488 hir::Mutability::Mut => {
489 AutoBorrowMutability::Mut { allow_two_phase_borrow: self.allow_two_phase }
492 adjustments.push(Adjustment {
493 kind: Adjust::Borrow(AutoBorrow::Ref(*r_borrow, mutbl)),
497 debug!("coerce_borrowed_pointer: succeeded ty={:?} adjustments={:?}", ty, adjustments);
499 success(adjustments, ty, obligations)
502 // &[T; n] or &mut [T; n] -> &[T]
503 // or &mut [T; n] -> &mut [T]
504 // or &Concrete -> &Trait, etc.
505 #[instrument(skip(self), level = "debug")]
506 fn coerce_unsized(&self, mut source: Ty<'tcx>, mut target: Ty<'tcx>) -> CoerceResult<'tcx> {
507 source = self.shallow_resolve(source);
508 target = self.shallow_resolve(target);
509 debug!(?source, ?target);
511 // These 'if' statements require some explanation.
512 // The `CoerceUnsized` trait is special - it is only
513 // possible to write `impl CoerceUnsized<B> for A` where
514 // A and B have 'matching' fields. This rules out the following
515 // two types of blanket impls:
517 // `impl<T> CoerceUnsized<T> for SomeType`
518 // `impl<T> CoerceUnsized<SomeType> for T`
520 // Both of these trigger a special `CoerceUnsized`-related error (E0376)
522 // We can take advantage of this fact to avoid performing unnecessary work.
523 // If either `source` or `target` is a type variable, then any applicable impl
524 // would need to be generic over the self-type (`impl<T> CoerceUnsized<SomeType> for T`)
525 // or generic over the `CoerceUnsized` type parameter (`impl<T> CoerceUnsized<T> for
528 // However, these are exactly the kinds of impls which are forbidden by
529 // the compiler! Therefore, we can be sure that coercion will always fail
530 // when either the source or target type is a type variable. This allows us
531 // to skip performing any trait selection, and immediately bail out.
532 if source.is_ty_var() {
533 debug!("coerce_unsized: source is a TyVar, bailing out");
534 return Err(TypeError::Mismatch);
536 if target.is_ty_var() {
537 debug!("coerce_unsized: target is a TyVar, bailing out");
538 return Err(TypeError::Mismatch);
542 (self.tcx.lang_items().unsize_trait(), self.tcx.lang_items().coerce_unsized_trait());
543 let (Some(unsize_did), Some(coerce_unsized_did)) = traits else {
544 debug!("missing Unsize or CoerceUnsized traits");
545 return Err(TypeError::Mismatch);
548 // Note, we want to avoid unnecessary unsizing. We don't want to coerce to
549 // a DST unless we have to. This currently comes out in the wash since
550 // we can't unify [T] with U. But to properly support DST, we need to allow
551 // that, at which point we will need extra checks on the target here.
553 // Handle reborrows before selecting `Source: CoerceUnsized<Target>`.
554 let reborrow = match (source.kind(), target.kind()) {
555 (&ty::Ref(_, ty_a, mutbl_a), &ty::Ref(_, _, mutbl_b)) => {
556 coerce_mutbls(mutbl_a, mutbl_b)?;
558 let coercion = Coercion(self.cause.span);
559 let r_borrow = self.next_region_var(coercion);
560 let mutbl = match mutbl_b {
561 hir::Mutability::Not => AutoBorrowMutability::Not,
562 hir::Mutability::Mut => AutoBorrowMutability::Mut {
563 // We don't allow two-phase borrows here, at least for initial
564 // implementation. If it happens that this coercion is a function argument,
565 // the reborrow in coerce_borrowed_ptr will pick it up.
566 allow_two_phase_borrow: AllowTwoPhase::No,
570 Adjustment { kind: Adjust::Deref(None), target: ty_a },
572 kind: Adjust::Borrow(AutoBorrow::Ref(r_borrow, mutbl)),
575 .mk_ref(r_borrow, ty::TypeAndMut { mutbl: mutbl_b, ty: ty_a }),
579 (&ty::Ref(_, ty_a, mt_a), &ty::RawPtr(ty::TypeAndMut { mutbl: mt_b, .. })) => {
580 coerce_mutbls(mt_a, mt_b)?;
583 Adjustment { kind: Adjust::Deref(None), target: ty_a },
585 kind: Adjust::Borrow(AutoBorrow::RawPtr(mt_b)),
586 target: self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mt_b, ty: ty_a }),
592 let coerce_source = reborrow.as_ref().map_or(source, |&(_, ref r)| r.target);
594 // Setup either a subtyping or a LUB relationship between
595 // the `CoerceUnsized` target type and the expected type.
596 // We only have the latter, so we use an inference variable
597 // for the former and let type inference do the rest.
598 let origin = TypeVariableOrigin {
599 kind: TypeVariableOriginKind::MiscVariable,
600 span: self.cause.span,
602 let coerce_target = self.next_ty_var(origin);
603 let mut coercion = self.unify_and(coerce_target, target, |target| {
604 let unsize = Adjustment { kind: Adjust::Pointer(PointerCast::Unsize), target };
606 None => vec![unsize],
607 Some((ref deref, ref autoref)) => vec![deref.clone(), autoref.clone(), unsize],
611 let mut selcx = traits::SelectionContext::new(self);
613 // Create an obligation for `Source: CoerceUnsized<Target>`.
614 let cause = ObligationCause::new(
617 ObligationCauseCode::Coercion { source, target },
620 // Use a FIFO queue for this custom fulfillment procedure.
622 // A Vec (or SmallVec) is not a natural choice for a queue. However,
623 // this code path is hot, and this queue usually has a max length of 1
624 // and almost never more than 3. By using a SmallVec we avoid an
625 // allocation, at the (very small) cost of (occasionally) having to
626 // shift subsequent elements down when removing the front element.
627 let mut queue: SmallVec<[_; 4]> = smallvec![traits::predicate_for_trait_def(
633 [coerce_source, coerce_target]
636 let mut has_unsized_tuple_coercion = false;
637 let mut has_trait_upcasting_coercion = None;
639 // Keep resolving `CoerceUnsized` and `Unsize` predicates to avoid
640 // emitting a coercion in cases like `Foo<$1>` -> `Foo<$2>`, where
641 // inference might unify those two inner type variables later.
642 let traits = [coerce_unsized_did, unsize_did];
643 while !queue.is_empty() {
644 let obligation = queue.remove(0);
645 debug!("coerce_unsized resolve step: {:?}", obligation);
646 let bound_predicate = obligation.predicate.kind();
647 let trait_pred = match bound_predicate.skip_binder() {
648 ty::PredicateKind::Trait(trait_pred) if traits.contains(&trait_pred.def_id()) => {
649 if unsize_did == trait_pred.def_id() {
650 let self_ty = trait_pred.self_ty();
651 let unsize_ty = trait_pred.trait_ref.substs[1].expect_ty();
652 if let (ty::Dynamic(ref data_a, ..), ty::Dynamic(ref data_b, ..)) =
653 (self_ty.kind(), unsize_ty.kind())
654 && data_a.principal_def_id() != data_b.principal_def_id()
656 debug!("coerce_unsized: found trait upcasting coercion");
657 has_trait_upcasting_coercion = Some((self_ty, unsize_ty));
659 if let ty::Tuple(..) = unsize_ty.kind() {
660 debug!("coerce_unsized: found unsized tuple coercion");
661 has_unsized_tuple_coercion = true;
664 bound_predicate.rebind(trait_pred)
667 coercion.obligations.push(obligation);
671 match selcx.select(&obligation.with(selcx.tcx(), trait_pred)) {
672 // Uncertain or unimplemented.
674 if trait_pred.def_id() == unsize_did {
675 let trait_pred = self.resolve_vars_if_possible(trait_pred);
676 let self_ty = trait_pred.skip_binder().self_ty();
677 let unsize_ty = trait_pred.skip_binder().trait_ref.substs[1].expect_ty();
678 debug!("coerce_unsized: ambiguous unsize case for {:?}", trait_pred);
679 match (&self_ty.kind(), &unsize_ty.kind()) {
680 (ty::Infer(ty::TyVar(v)), ty::Dynamic(..))
681 if self.type_var_is_sized(*v) =>
683 debug!("coerce_unsized: have sized infer {:?}", v);
684 coercion.obligations.push(obligation);
685 // `$0: Unsize<dyn Trait>` where we know that `$0: Sized`, try going
689 // Some other case for `$0: Unsize<Something>`. Note that we
690 // hit this case even if `Something` is a sized type, so just
691 // don't do the coercion.
692 debug!("coerce_unsized: ambiguous unsize");
693 return Err(TypeError::Mismatch);
697 debug!("coerce_unsized: early return - ambiguous");
698 return Err(TypeError::Mismatch);
701 Err(traits::Unimplemented) => {
702 debug!("coerce_unsized: early return - can't prove obligation");
703 return Err(TypeError::Mismatch);
706 // Object safety violations or miscellaneous.
708 self.err_ctxt().report_selection_error(obligation.clone(), &obligation, &err);
709 // Treat this like an obligation and follow through
710 // with the unsizing - the lack of a coercion should
711 // be silent, as it causes a type mismatch later.
714 Ok(Some(impl_source)) => queue.extend(impl_source.nested_obligations()),
718 if has_unsized_tuple_coercion && !self.tcx.features().unsized_tuple_coercion {
720 &self.tcx.sess.parse_sess,
721 sym::unsized_tuple_coercion,
723 "unsized tuple coercion is not stable enough for use and is subject to change",
728 if let Some((sub, sup)) = has_trait_upcasting_coercion
729 && !self.tcx().features().trait_upcasting
731 // Renders better when we erase regions, since they're not really the point here.
732 let (sub, sup) = self.tcx.erase_regions((sub, sup));
733 let mut err = feature_err(
734 &self.tcx.sess.parse_sess,
735 sym::trait_upcasting,
737 &format!("cannot cast `{sub}` to `{sup}`, trait upcasting coercion is experimental"),
739 err.note(&format!("required when coercing `{source}` into `{target}`"));
750 predicates: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
751 b_region: ty::Region<'tcx>,
752 ) -> CoerceResult<'tcx> {
753 if !self.tcx.features().dyn_star {
754 return Err(TypeError::Mismatch);
757 if let ty::Dynamic(a_data, _, _) = a.kind()
758 && let ty::Dynamic(b_data, _, _) = b.kind()
760 if a_data.principal_def_id() == b_data.principal_def_id() {
761 return self.unify_and(a, b, |_| vec![]);
762 } else if !self.tcx().features().trait_upcasting {
763 let mut err = feature_err(
764 &self.tcx.sess.parse_sess,
765 sym::trait_upcasting,
768 "cannot cast `{a}` to `{b}`, trait upcasting coercion is experimental"
775 // Check the obligations of the cast -- for example, when casting
776 // `usize` to `dyn* Clone + 'static`:
777 let mut obligations: Vec<_> = predicates
780 // For each existential predicate (e.g., `?Self: Clone`) substitute
781 // the type of the expression (e.g., `usize` in our example above)
782 // and then require that the resulting predicate (e.g., `usize: Clone`)
784 let predicate = predicate.with_self_ty(self.tcx, a);
785 Obligation::new(self.tcx, self.cause.clone(), self.param_env, predicate)
788 // Enforce the region bound (e.g., `usize: 'static`, in our example).
793 ty::Binder::dummy(ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(
800 // Enforce that the type is `usize`/pointer-sized. For now, only those
801 // can be coerced to `dyn*`, except for `dyn* -> dyn*` upcasts.
802 if !a.is_dyn_star() {
803 obligations.push(Obligation::new(
808 self.tcx.at(self.cause.span).mk_trait_ref(hir::LangItem::PointerSized, [a]),
810 .to_poly_trait_predicate(),
815 value: (vec![Adjustment { kind: Adjust::DynStar, target: b }], b),
820 fn coerce_from_safe_fn<F, G>(
823 fn_ty_a: ty::PolyFnSig<'tcx>,
827 ) -> CoerceResult<'tcx>
829 F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
830 G: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
832 self.commit_if_ok(|snapshot| {
833 let result = if let ty::FnPtr(fn_ty_b) = b.kind()
834 && let (hir::Unsafety::Normal, hir::Unsafety::Unsafe) =
835 (fn_ty_a.unsafety(), fn_ty_b.unsafety())
837 let unsafe_a = self.tcx.safe_to_unsafe_fn_ty(fn_ty_a);
838 self.unify_and(unsafe_a, b, to_unsafe)
840 self.unify_and(a, b, normal)
843 // FIXME(#73154): This is a hack. Currently LUB can generate
844 // unsolvable constraints. Additionally, it returns `a`
845 // unconditionally, even when the "LUB" is `b`. In the future, we
846 // want the coerced type to be the actual supertype of these two,
847 // but for now, we want to just error to ensure we don't lock
848 // ourselves into a specific behavior with NLL.
849 self.leak_check(false, snapshot)?;
855 fn coerce_from_fn_pointer(
858 fn_ty_a: ty::PolyFnSig<'tcx>,
860 ) -> CoerceResult<'tcx> {
861 //! Attempts to coerce from the type of a Rust function item
862 //! into a closure or a `proc`.
865 let b = self.shallow_resolve(b);
866 debug!("coerce_from_fn_pointer(a={:?}, b={:?})", a, b);
868 self.coerce_from_safe_fn(
872 simple(Adjust::Pointer(PointerCast::UnsafeFnPointer)),
877 fn coerce_from_fn_item(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
878 //! Attempts to coerce from the type of a Rust function item
879 //! into a closure or a `proc`.
881 let b = self.shallow_resolve(b);
882 let InferOk { value: b, mut obligations } =
883 self.normalize_associated_types_in_as_infer_ok(self.cause.span, b);
884 debug!("coerce_from_fn_item(a={:?}, b={:?})", a, b);
887 ty::FnPtr(b_sig) => {
888 let a_sig = a.fn_sig(self.tcx);
889 if let ty::FnDef(def_id, _) = *a.kind() {
890 // Intrinsics are not coercible to function pointers
891 if self.tcx.is_intrinsic(def_id) {
892 return Err(TypeError::IntrinsicCast);
895 // Safe `#[target_feature]` functions are not assignable to safe fn pointers (RFC 2396).
897 if b_sig.unsafety() == hir::Unsafety::Normal
898 && !self.tcx.codegen_fn_attrs(def_id).target_features.is_empty()
900 return Err(TypeError::TargetFeatureCast(def_id));
904 let InferOk { value: a_sig, obligations: o1 } =
905 self.normalize_associated_types_in_as_infer_ok(self.cause.span, a_sig);
906 obligations.extend(o1);
908 let a_fn_pointer = self.tcx.mk_fn_ptr(a_sig);
909 let InferOk { value, obligations: o2 } = self.coerce_from_safe_fn(
916 kind: Adjust::Pointer(PointerCast::ReifyFnPointer),
917 target: a_fn_pointer,
920 kind: Adjust::Pointer(PointerCast::UnsafeFnPointer),
925 simple(Adjust::Pointer(PointerCast::ReifyFnPointer)),
928 obligations.extend(o2);
929 Ok(InferOk { value, obligations })
931 _ => self.unify_and(a, b, identity),
935 fn coerce_closure_to_fn(
938 closure_def_id_a: DefId,
939 substs_a: SubstsRef<'tcx>,
941 ) -> CoerceResult<'tcx> {
942 //! Attempts to coerce from the type of a non-capturing closure
943 //! into a function pointer.
946 let b = self.shallow_resolve(b);
949 // At this point we haven't done capture analysis, which means
950 // that the ClosureSubsts just contains an inference variable instead
951 // of tuple of captured types.
953 // All we care here is if any variable is being captured and not the exact paths,
954 // so we check `upvars_mentioned` for root variables being captured.
958 .upvars_mentioned(closure_def_id_a.expect_local())
959 .map_or(true, |u| u.is_empty()) =>
961 // We coerce the closure, which has fn type
962 // `extern "rust-call" fn((arg0,arg1,...)) -> _`
964 // `fn(arg0,arg1,...) -> _`
966 // `unsafe fn(arg0,arg1,...) -> _`
967 let closure_sig = substs_a.as_closure().sig();
968 let unsafety = fn_ty.unsafety();
970 self.tcx.mk_fn_ptr(self.tcx.signature_unclosure(closure_sig, unsafety));
971 debug!("coerce_closure_to_fn(a={:?}, b={:?}, pty={:?})", a, b, pointer_ty);
975 simple(Adjust::Pointer(PointerCast::ClosureFnPointer(unsafety))),
978 _ => self.unify_and(a, b, identity),
982 fn coerce_unsafe_ptr(
986 mutbl_b: hir::Mutability,
987 ) -> CoerceResult<'tcx> {
988 debug!("coerce_unsafe_ptr(a={:?}, b={:?})", a, b);
990 let (is_ref, mt_a) = match *a.kind() {
991 ty::Ref(_, ty, mutbl) => (true, ty::TypeAndMut { ty, mutbl }),
992 ty::RawPtr(mt) => (false, mt),
993 _ => return self.unify_and(a, b, identity),
995 coerce_mutbls(mt_a.mutbl, mutbl_b)?;
997 // Check that the types which they point at are compatible.
998 let a_unsafe = self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mutbl_b, ty: mt_a.ty });
999 // Although references and unsafe ptrs have the same
1000 // representation, we still register an Adjust::DerefRef so that
1001 // regionck knows that the region for `a` must be valid here.
1003 self.unify_and(a_unsafe, b, |target| {
1005 Adjustment { kind: Adjust::Deref(None), target: mt_a.ty },
1006 Adjustment { kind: Adjust::Borrow(AutoBorrow::RawPtr(mutbl_b)), target },
1009 } else if mt_a.mutbl != mutbl_b {
1010 self.unify_and(a_unsafe, b, simple(Adjust::Pointer(PointerCast::MutToConstPointer)))
1012 self.unify_and(a_unsafe, b, identity)
1017 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
1018 /// Attempt to coerce an expression to a type, and return the
1019 /// adjusted type of the expression, if successful.
1020 /// Adjustments are only recorded if the coercion succeeded.
1021 /// The expressions *must not* have any pre-existing adjustments.
1024 expr: &hir::Expr<'_>,
1027 allow_two_phase: AllowTwoPhase,
1028 cause: Option<ObligationCause<'tcx>>,
1029 ) -> RelateResult<'tcx, Ty<'tcx>> {
1030 let source = self.resolve_vars_with_obligations(expr_ty);
1031 debug!("coercion::try({:?}: {:?} -> {:?})", expr, source, target);
1034 cause.unwrap_or_else(|| self.cause(expr.span, ObligationCauseCode::ExprAssignable));
1035 let coerce = Coerce::new(self, cause, allow_two_phase);
1036 let ok = self.commit_if_ok(|_| coerce.coerce(source, target))?;
1038 let (adjustments, _) = self.register_infer_ok_obligations(ok);
1039 self.apply_adjustments(expr, adjustments);
1040 Ok(if expr_ty.references_error() { self.tcx.ty_error() } else { target })
1043 /// Same as `try_coerce()`, but without side-effects.
1045 /// Returns false if the coercion creates any obligations that result in
1047 pub fn can_coerce(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> bool {
1048 let source = self.resolve_vars_with_obligations(expr_ty);
1049 debug!("coercion::can_with_predicates({:?} -> {:?})", source, target);
1051 let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
1052 // We don't ever need two-phase here since we throw out the result of the coercion
1053 let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
1055 let Ok(ok) = coerce.coerce(source, target) else {
1058 let mut fcx = <dyn TraitEngine<'tcx>>::new_in_snapshot(self.tcx);
1059 fcx.register_predicate_obligations(self, ok.obligations);
1060 fcx.select_where_possible(&self).is_empty()
1064 /// Given a type and a target type, this function will calculate and return
1065 /// how many dereference steps needed to achieve `expr_ty <: target`. If
1066 /// it's not possible, return `None`.
1067 pub fn deref_steps(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> Option<usize> {
1068 let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
1069 // We don't ever need two-phase here since we throw out the result of the coercion
1070 let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
1072 .autoderef(rustc_span::DUMMY_SP, expr_ty)
1073 .find_map(|(ty, steps)| self.probe(|_| coerce.unify(ty, target)).ok().map(|_| steps))
1076 /// Given a type, this function will calculate and return the type given
1077 /// for `<Ty as Deref>::Target` only if `Ty` also implements `DerefMut`.
1079 /// This function is for diagnostics only, since it does not register
1080 /// trait or region sub-obligations. (presumably we could, but it's not
1081 /// particularly important for diagnostics...)
1082 pub fn deref_once_mutably_for_diagnostic(&self, expr_ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
1083 self.autoderef(rustc_span::DUMMY_SP, expr_ty).nth(1).and_then(|(deref_ty, _)| {
1085 .type_implements_trait(
1086 self.tcx.lang_items().deref_mut_trait()?,
1095 /// Given some expressions, their known unified type and another expression,
1096 /// tries to unify the types, potentially inserting coercions on any of the
1097 /// provided expressions and returns their LUB (aka "common supertype").
1099 /// This is really an internal helper. From outside the coercion
1100 /// module, you should instantiate a `CoerceMany` instance.
1101 fn try_find_coercion_lub<E>(
1103 cause: &ObligationCause<'tcx>,
1106 new: &hir::Expr<'_>,
1108 ) -> RelateResult<'tcx, Ty<'tcx>>
1112 let prev_ty = self.resolve_vars_with_obligations(prev_ty);
1113 let new_ty = self.resolve_vars_with_obligations(new_ty);
1115 "coercion::try_find_coercion_lub({:?}, {:?}, exprs={:?} exprs)",
1121 // The following check fixes #88097, where the compiler erroneously
1122 // attempted to coerce a closure type to itself via a function pointer.
1123 if prev_ty == new_ty {
1127 // Special-case that coercion alone cannot handle:
1128 // Function items or non-capturing closures of differing IDs or InternalSubsts.
1129 let (a_sig, b_sig) = {
1130 #[allow(rustc::usage_of_ty_tykind)]
1131 let is_capturing_closure = |ty: &ty::TyKind<'tcx>| {
1132 if let &ty::Closure(closure_def_id, _substs) = ty {
1133 self.tcx.upvars_mentioned(closure_def_id.expect_local()).is_some()
1138 if is_capturing_closure(prev_ty.kind()) || is_capturing_closure(new_ty.kind()) {
1141 match (prev_ty.kind(), new_ty.kind()) {
1142 (ty::FnDef(..), ty::FnDef(..)) => {
1143 // Don't reify if the function types have a LUB, i.e., they
1144 // are the same function and their parameters have a LUB.
1146 .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1148 // We have a LUB of prev_ty and new_ty, just return it.
1149 Ok(ok) => return Ok(self.register_infer_ok_obligations(ok)),
1151 (Some(prev_ty.fn_sig(self.tcx)), Some(new_ty.fn_sig(self.tcx)))
1155 (ty::Closure(_, substs), ty::FnDef(..)) => {
1156 let b_sig = new_ty.fn_sig(self.tcx);
1159 .signature_unclosure(substs.as_closure().sig(), b_sig.unsafety());
1160 (Some(a_sig), Some(b_sig))
1162 (ty::FnDef(..), ty::Closure(_, substs)) => {
1163 let a_sig = prev_ty.fn_sig(self.tcx);
1166 .signature_unclosure(substs.as_closure().sig(), a_sig.unsafety());
1167 (Some(a_sig), Some(b_sig))
1169 (ty::Closure(_, substs_a), ty::Closure(_, substs_b)) => (
1170 Some(self.tcx.signature_unclosure(
1171 substs_a.as_closure().sig(),
1172 hir::Unsafety::Normal,
1174 Some(self.tcx.signature_unclosure(
1175 substs_b.as_closure().sig(),
1176 hir::Unsafety::Normal,
1183 if let (Some(a_sig), Some(b_sig)) = (a_sig, b_sig) {
1184 // Intrinsics are not coercible to function pointers.
1185 if a_sig.abi() == Abi::RustIntrinsic
1186 || a_sig.abi() == Abi::PlatformIntrinsic
1187 || b_sig.abi() == Abi::RustIntrinsic
1188 || b_sig.abi() == Abi::PlatformIntrinsic
1190 return Err(TypeError::IntrinsicCast);
1192 // The signature must match.
1193 let a_sig = self.normalize_associated_types_in(new.span, a_sig);
1194 let b_sig = self.normalize_associated_types_in(new.span, b_sig);
1196 .at(cause, self.param_env)
1197 .trace(prev_ty, new_ty)
1199 .map(|ok| self.register_infer_ok_obligations(ok))?;
1201 // Reify both sides and return the reified fn pointer type.
1202 let fn_ptr = self.tcx.mk_fn_ptr(sig);
1203 let prev_adjustment = match prev_ty.kind() {
1204 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(a_sig.unsafety())),
1205 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1206 _ => unreachable!(),
1208 let next_adjustment = match new_ty.kind() {
1209 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(b_sig.unsafety())),
1210 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1211 _ => unreachable!(),
1213 for expr in exprs.iter().map(|e| e.as_coercion_site()) {
1214 self.apply_adjustments(
1216 vec![Adjustment { kind: prev_adjustment.clone(), target: fn_ptr }],
1219 self.apply_adjustments(new, vec![Adjustment { kind: next_adjustment, target: fn_ptr }]);
1223 // Configure a Coerce instance to compute the LUB.
1224 // We don't allow two-phase borrows on any autorefs this creates since we
1225 // probably aren't processing function arguments here and even if we were,
1226 // they're going to get autorefed again anyway and we can apply 2-phase borrows
1228 let mut coerce = Coerce::new(self, cause.clone(), AllowTwoPhase::No);
1229 coerce.use_lub = true;
1231 // First try to coerce the new expression to the type of the previous ones,
1232 // but only if the new expression has no coercion already applied to it.
1233 let mut first_error = None;
1234 if !self.typeck_results.borrow().adjustments().contains_key(new.hir_id) {
1235 let result = self.commit_if_ok(|_| coerce.coerce(new_ty, prev_ty));
1238 let (adjustments, target) = self.register_infer_ok_obligations(ok);
1239 self.apply_adjustments(new, adjustments);
1241 "coercion::try_find_coercion_lub: was able to coerce from new type {:?} to previous type {:?} ({:?})",
1242 new_ty, prev_ty, target
1246 Err(e) => first_error = Some(e),
1250 // Then try to coerce the previous expressions to the type of the new one.
1251 // This requires ensuring there are no coercions applied to *any* of the
1252 // previous expressions, other than noop reborrows (ignoring lifetimes).
1254 let expr = expr.as_coercion_site();
1255 let noop = match self.typeck_results.borrow().expr_adjustments(expr) {
1257 Adjustment { kind: Adjust::Deref(_), .. },
1258 Adjustment { kind: Adjust::Borrow(AutoBorrow::Ref(_, mutbl_adj)), .. },
1260 match *self.node_ty(expr.hir_id).kind() {
1261 ty::Ref(_, _, mt_orig) => {
1262 let mutbl_adj: hir::Mutability = mutbl_adj.into();
1263 // Reborrow that we can safely ignore, because
1264 // the next adjustment can only be a Deref
1265 // which will be merged into it.
1266 mutbl_adj == mt_orig
1271 &[Adjustment { kind: Adjust::NeverToAny, .. }] | &[] => true,
1277 "coercion::try_find_coercion_lub: older expression {:?} had adjustments, requiring LUB",
1282 .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1283 .map(|ok| self.register_infer_ok_obligations(ok));
1287 match self.commit_if_ok(|_| coerce.coerce(prev_ty, new_ty)) {
1289 // Avoid giving strange errors on failed attempts.
1290 if let Some(e) = first_error {
1293 self.commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1294 .map(|ok| self.register_infer_ok_obligations(ok))
1298 let (adjustments, target) = self.register_infer_ok_obligations(ok);
1300 let expr = expr.as_coercion_site();
1301 self.apply_adjustments(expr, adjustments.clone());
1304 "coercion::try_find_coercion_lub: was able to coerce previous type {:?} to new type {:?} ({:?})",
1305 prev_ty, new_ty, target
1313 /// CoerceMany encapsulates the pattern you should use when you have
1314 /// many expressions that are all getting coerced to a common
1315 /// type. This arises, for example, when you have a match (the result
1316 /// of each arm is coerced to a common type). It also arises in less
1317 /// obvious places, such as when you have many `break foo` expressions
1318 /// that target the same loop, or the various `return` expressions in
1321 /// The basic protocol is as follows:
1323 /// - Instantiate the `CoerceMany` with an initial `expected_ty`.
1324 /// This will also serve as the "starting LUB". The expectation is
1325 /// that this type is something which all of the expressions *must*
1326 /// be coercible to. Use a fresh type variable if needed.
1327 /// - For each expression whose result is to be coerced, invoke `coerce()` with.
1328 /// - In some cases we wish to coerce "non-expressions" whose types are implicitly
1329 /// unit. This happens for example if you have a `break` with no expression,
1330 /// or an `if` with no `else`. In that case, invoke `coerce_forced_unit()`.
1331 /// - `coerce()` and `coerce_forced_unit()` may report errors. They hide this
1332 /// from you so that you don't have to worry your pretty head about it.
1333 /// But if an error is reported, the final type will be `err`.
1334 /// - Invoking `coerce()` may cause us to go and adjust the "adjustments" on
1335 /// previously coerced expressions.
1336 /// - When all done, invoke `complete()`. This will return the LUB of
1337 /// all your expressions.
1338 /// - WARNING: I don't believe this final type is guaranteed to be
1339 /// related to your initial `expected_ty` in any particular way,
1340 /// although it will typically be a subtype, so you should check it.
1341 /// - Invoking `complete()` may cause us to go and adjust the "adjustments" on
1342 /// previously coerced expressions.
1346 /// ```ignore (illustrative)
1347 /// let mut coerce = CoerceMany::new(expected_ty);
1348 /// for expr in exprs {
1349 /// let expr_ty = fcx.check_expr_with_expectation(expr, expected);
1350 /// coerce.coerce(fcx, &cause, expr, expr_ty);
1352 /// let final_ty = coerce.complete(fcx);
1354 pub struct CoerceMany<'tcx, 'exprs, E: AsCoercionSite> {
1355 expected_ty: Ty<'tcx>,
1356 final_ty: Option<Ty<'tcx>>,
1357 expressions: Expressions<'tcx, 'exprs, E>,
1361 /// The type of a `CoerceMany` that is storing up the expressions into
1362 /// a buffer. We use this in `check/mod.rs` for things like `break`.
1363 pub type DynamicCoerceMany<'tcx> = CoerceMany<'tcx, 'tcx, &'tcx hir::Expr<'tcx>>;
1365 enum Expressions<'tcx, 'exprs, E: AsCoercionSite> {
1366 Dynamic(Vec<&'tcx hir::Expr<'tcx>>),
1367 UpFront(&'exprs [E]),
1370 impl<'tcx, 'exprs, E: AsCoercionSite> CoerceMany<'tcx, 'exprs, E> {
1371 /// The usual case; collect the set of expressions dynamically.
1372 /// If the full set of coercion sites is known before hand,
1373 /// consider `with_coercion_sites()` instead to avoid allocation.
1374 pub fn new(expected_ty: Ty<'tcx>) -> Self {
1375 Self::make(expected_ty, Expressions::Dynamic(vec![]))
1378 /// As an optimization, you can create a `CoerceMany` with a
1379 /// pre-existing slice of expressions. In this case, you are
1380 /// expected to pass each element in the slice to `coerce(...)` in
1381 /// order. This is used with arrays in particular to avoid
1382 /// needlessly cloning the slice.
1383 pub fn with_coercion_sites(expected_ty: Ty<'tcx>, coercion_sites: &'exprs [E]) -> Self {
1384 Self::make(expected_ty, Expressions::UpFront(coercion_sites))
1387 fn make(expected_ty: Ty<'tcx>, expressions: Expressions<'tcx, 'exprs, E>) -> Self {
1388 CoerceMany { expected_ty, final_ty: None, expressions, pushed: 0 }
1391 /// Returns the "expected type" with which this coercion was
1392 /// constructed. This represents the "downward propagated" type
1393 /// that was given to us at the start of typing whatever construct
1394 /// we are typing (e.g., the match expression).
1396 /// Typically, this is used as the expected type when
1397 /// type-checking each of the alternative expressions whose types
1398 /// we are trying to merge.
1399 pub fn expected_ty(&self) -> Ty<'tcx> {
1403 /// Returns the current "merged type", representing our best-guess
1404 /// at the LUB of the expressions we've seen so far (if any). This
1405 /// isn't *final* until you call `self.complete()`, which will return
1406 /// the merged type.
1407 pub fn merged_ty(&self) -> Ty<'tcx> {
1408 self.final_ty.unwrap_or(self.expected_ty)
1411 /// Indicates that the value generated by `expression`, which is
1412 /// of type `expression_ty`, is one of the possibilities that we
1413 /// could coerce from. This will record `expression`, and later
1414 /// calls to `coerce` may come back and add adjustments and things
1418 fcx: &FnCtxt<'a, 'tcx>,
1419 cause: &ObligationCause<'tcx>,
1420 expression: &'tcx hir::Expr<'tcx>,
1421 expression_ty: Ty<'tcx>,
1423 self.coerce_inner(fcx, cause, Some(expression), expression_ty, None, false)
1426 /// Indicates that one of the inputs is a "forced unit". This
1427 /// occurs in a case like `if foo { ... };`, where the missing else
1428 /// generates a "forced unit". Another example is a `loop { break;
1429 /// }`, where the `break` has no argument expression. We treat
1430 /// these cases slightly differently for error-reporting
1431 /// purposes. Note that these tend to correspond to cases where
1432 /// the `()` expression is implicit in the source, and hence we do
1433 /// not take an expression argument.
1435 /// The `augment_error` gives you a chance to extend the error
1436 /// message, in case any results (e.g., we use this to suggest
1437 /// removing a `;`).
1438 pub fn coerce_forced_unit<'a>(
1440 fcx: &FnCtxt<'a, 'tcx>,
1441 cause: &ObligationCause<'tcx>,
1442 augment_error: &mut dyn FnMut(&mut Diagnostic),
1443 label_unit_as_expected: bool,
1450 Some(augment_error),
1451 label_unit_as_expected,
1455 /// The inner coercion "engine". If `expression` is `None`, this
1456 /// is a forced-unit case, and hence `expression_ty` must be
1458 #[instrument(skip(self, fcx, augment_error, label_expression_as_expected), level = "debug")]
1459 pub(crate) fn coerce_inner<'a>(
1461 fcx: &FnCtxt<'a, 'tcx>,
1462 cause: &ObligationCause<'tcx>,
1463 expression: Option<&'tcx hir::Expr<'tcx>>,
1464 mut expression_ty: Ty<'tcx>,
1465 augment_error: Option<&mut dyn FnMut(&mut Diagnostic)>,
1466 label_expression_as_expected: bool,
1468 // Incorporate whatever type inference information we have
1469 // until now; in principle we might also want to process
1470 // pending obligations, but doing so should only improve
1471 // compatibility (hopefully that is true) by helping us
1472 // uncover never types better.
1473 if expression_ty.is_ty_var() {
1474 expression_ty = fcx.infcx.shallow_resolve(expression_ty);
1477 // If we see any error types, just propagate that error
1479 if expression_ty.references_error() || self.merged_ty().references_error() {
1480 self.final_ty = Some(fcx.tcx.ty_error());
1484 // Handle the actual type unification etc.
1485 let result = if let Some(expression) = expression {
1486 if self.pushed == 0 {
1487 // Special-case the first expression we are coercing.
1488 // To be honest, I'm not entirely sure why we do this.
1489 // We don't allow two-phase borrows, see comment in try_find_coercion_lub for why
1495 Some(cause.clone()),
1498 match self.expressions {
1499 Expressions::Dynamic(ref exprs) => fcx.try_find_coercion_lub(
1506 Expressions::UpFront(ref coercion_sites) => fcx.try_find_coercion_lub(
1508 &coercion_sites[0..self.pushed],
1516 // this is a hack for cases where we default to `()` because
1517 // the expression etc has been omitted from the source. An
1518 // example is an `if let` without an else:
1520 // if let Some(x) = ... { }
1522 // we wind up with a second match arm that is like `_ =>
1523 // ()`. That is the case we are considering here. We take
1524 // a different path to get the right "expected, found"
1525 // message and so forth (and because we know that
1526 // `expression_ty` will be unit).
1528 // Another example is `break` with no argument expression.
1529 assert!(expression_ty.is_unit(), "if let hack without unit type");
1530 fcx.at(cause, fcx.param_env)
1531 .eq_exp(label_expression_as_expected, expression_ty, self.merged_ty())
1533 fcx.register_infer_ok_obligations(infer_ok);
1541 self.final_ty = Some(v);
1542 if let Some(e) = expression {
1543 match self.expressions {
1544 Expressions::Dynamic(ref mut buffer) => buffer.push(e),
1545 Expressions::UpFront(coercion_sites) => {
1546 // if the user gave us an array to validate, check that we got
1547 // the next expression in the list, as expected
1549 coercion_sites[self.pushed].as_coercion_site().hir_id,
1557 Err(coercion_error) => {
1558 // Mark that we've failed to coerce the types here to suppress
1559 // any superfluous errors we might encounter while trying to
1560 // emit or provide suggestions on how to fix the initial error.
1561 fcx.set_tainted_by_errors(
1562 fcx.tcx.sess.delay_span_bug(cause.span, "coercion error but no error emitted"),
1564 let (expected, found) = if label_expression_as_expected {
1565 // In the case where this is a "forced unit", like
1566 // `break`, we want to call the `()` "expected"
1567 // since it is implied by the syntax.
1568 // (Note: not all force-units work this way.)"
1569 (expression_ty, self.merged_ty())
1571 // Otherwise, the "expected" type for error
1572 // reporting is the current unification type,
1573 // which is basically the LUB of the expressions
1574 // we've seen so far (combined with the expected
1576 (self.merged_ty(), expression_ty)
1578 let (expected, found) = fcx.resolve_vars_if_possible((expected, found));
1581 let mut unsized_return = false;
1582 let mut visitor = CollectRetsVisitor { ret_exprs: vec![] };
1583 match *cause.code() {
1584 ObligationCauseCode::ReturnNoExpression => {
1585 err = struct_span_err!(
1589 "`return;` in a function whose return type is not `()`"
1591 err.span_label(cause.span, "return type is not `()`");
1593 ObligationCauseCode::BlockTailExpression(blk_id) => {
1594 let parent_id = fcx.tcx.hir().get_parent_node(blk_id);
1595 err = self.report_return_mismatched_types(
1599 coercion_error.clone(),
1605 if !fcx.tcx.features().unsized_locals {
1606 unsized_return = self.is_return_ty_unsized(fcx, blk_id);
1608 if let Some(expression) = expression
1609 && let hir::ExprKind::Loop(loop_blk, ..) = expression.kind {
1610 intravisit::walk_block(& mut visitor, loop_blk);
1613 ObligationCauseCode::ReturnValue(id) => {
1614 err = self.report_return_mismatched_types(
1618 coercion_error.clone(),
1624 if !fcx.tcx.features().unsized_locals {
1625 let id = fcx.tcx.hir().get_parent_node(id);
1626 unsized_return = self.is_return_ty_unsized(fcx, id);
1630 err = fcx.err_ctxt().report_mismatched_types(
1634 coercion_error.clone(),
1639 if let Some(augment_error) = augment_error {
1640 augment_error(&mut err);
1643 let is_insufficiently_polymorphic =
1644 matches!(coercion_error, TypeError::RegionsInsufficientlyPolymorphic(..));
1646 if !is_insufficiently_polymorphic && let Some(expr) = expression {
1647 fcx.emit_coerce_suggestions(
1653 Some(coercion_error),
1657 if visitor.ret_exprs.len() > 0 && let Some(expr) = expression {
1658 self.note_unreachable_loop_return(&mut err, &expr, &visitor.ret_exprs);
1660 let reported = err.emit_unless(unsized_return);
1662 self.final_ty = Some(fcx.tcx.ty_error_with_guaranteed(reported));
1666 fn note_unreachable_loop_return(
1668 err: &mut Diagnostic,
1669 expr: &hir::Expr<'tcx>,
1670 ret_exprs: &Vec<&'tcx hir::Expr<'tcx>>,
1672 let hir::ExprKind::Loop(_, _, _, loop_span) = expr.kind else { return;};
1673 let mut span: MultiSpan = vec![loop_span].into();
1674 span.push_span_label(loop_span, "this might have zero elements to iterate on");
1675 const MAXITER: usize = 3;
1676 let iter = ret_exprs.iter().take(MAXITER);
1677 for ret_expr in iter {
1678 span.push_span_label(
1680 "if the loop doesn't execute, this value would never get returned",
1685 "the function expects a value to always be returned, but loops might run zero times",
1687 if MAXITER < ret_exprs.len() {
1689 "if the loop doesn't execute, {} other values would never get returned",
1690 ret_exprs.len() - MAXITER
1694 "return a value for the case when the loop has zero elements to iterate on, or \
1695 consider changing the return type to account for that possibility",
1699 fn report_return_mismatched_types<'a>(
1701 cause: &ObligationCause<'tcx>,
1704 ty_err: TypeError<'tcx>,
1705 fcx: &FnCtxt<'a, 'tcx>,
1707 expression: Option<&'tcx hir::Expr<'tcx>>,
1708 blk_id: Option<hir::HirId>,
1709 ) -> DiagnosticBuilder<'a, ErrorGuaranteed> {
1710 let mut err = fcx.err_ctxt().report_mismatched_types(cause, expected, found, ty_err);
1712 let mut pointing_at_return_type = false;
1713 let mut fn_output = None;
1715 let parent_id = fcx.tcx.hir().get_parent_node(id);
1716 let parent = fcx.tcx.hir().get(parent_id);
1717 if let Some(expr) = expression
1718 && let hir::Node::Expr(hir::Expr { kind: hir::ExprKind::Closure(&hir::Closure { body, .. }), .. }) = parent
1719 && !matches!(fcx.tcx.hir().body(body).value.kind, hir::ExprKind::Block(..))
1721 fcx.suggest_missing_semicolon(&mut err, expr, expected, true);
1723 // Verify that this is a tail expression of a function, otherwise the
1724 // label pointing out the cause for the type coercion will be wrong
1725 // as prior return coercions would not be relevant (#57664).
1726 let fn_decl = if let (Some(expr), Some(blk_id)) = (expression, blk_id) {
1727 pointing_at_return_type =
1728 fcx.suggest_mismatched_types_on_tail(&mut err, expr, expected, found, blk_id);
1729 if let (Some(cond_expr), true, false) = (
1730 fcx.tcx.hir().get_if_cause(expr.hir_id),
1732 pointing_at_return_type,
1734 // If the block is from an external macro or try (`?`) desugaring, then
1735 // do not suggest adding a semicolon, because there's nowhere to put it.
1736 // See issues #81943 and #87051.
1738 cond_expr.span.desugaring_kind(),
1739 None | Some(DesugaringKind::WhileLoop)
1740 ) && !in_external_macro(fcx.tcx.sess, cond_expr.span)
1743 hir::ExprKind::Match(.., hir::MatchSource::TryDesugar)
1746 err.span_label(cond_expr.span, "expected this to be `()`");
1747 if expr.can_have_side_effects() {
1748 fcx.suggest_semicolon_at_end(cond_expr.span, &mut err);
1751 fcx.get_node_fn_decl(parent).map(|(fn_decl, _, is_main)| (fn_decl, is_main))
1753 fcx.get_fn_decl(parent_id)
1756 if let Some((fn_decl, can_suggest)) = fn_decl {
1757 if blk_id.is_none() {
1758 pointing_at_return_type |= fcx.suggest_missing_return_type(
1764 fcx.tcx.hir().get_parent_item(id).into(),
1767 if !pointing_at_return_type {
1768 fn_output = Some(&fn_decl.output); // `impl Trait` return type
1772 let parent_id = fcx.tcx.hir().get_parent_item(id);
1773 let parent_item = fcx.tcx.hir().get_by_def_id(parent_id.def_id);
1775 if let (Some(expr), Some(_), Some((fn_decl, _, _))) =
1776 (expression, blk_id, fcx.get_node_fn_decl(parent_item))
1778 fcx.suggest_missing_break_or_return_expr(
1789 let ret_coercion_span = fcx.ret_coercion_span.get();
1791 if let Some(sp) = ret_coercion_span
1792 // If the closure has an explicit return type annotation, or if
1793 // the closure's return type has been inferred from outside
1794 // requirements (such as an Fn* trait bound), then a type error
1795 // may occur at the first return expression we see in the closure
1796 // (if it conflicts with the declared return type). Skip adding a
1797 // note in this case, since it would be incorrect.
1798 && let Some(fn_sig) = fcx.body_fn_sig()
1799 && fn_sig.output().is_ty_var()
1804 "return type inferred to be `{}` here",
1810 if let (Some(sp), Some(fn_output)) = (ret_coercion_span, fn_output) {
1811 self.add_impl_trait_explanation(&mut err, cause, fcx, expected, sp, fn_output);
1817 fn add_impl_trait_explanation<'a>(
1819 err: &mut Diagnostic,
1820 cause: &ObligationCause<'tcx>,
1821 fcx: &FnCtxt<'a, 'tcx>,
1824 fn_output: &hir::FnRetTy<'_>,
1826 let return_sp = fn_output.span();
1827 err.span_label(return_sp, "expected because this return type...");
1830 format!("...is found to be `{}` here", fcx.resolve_vars_with_obligations(expected)),
1832 let impl_trait_msg = "for information on `impl Trait`, see \
1833 <https://doc.rust-lang.org/book/ch10-02-traits.html\
1834 #returning-types-that-implement-traits>";
1835 let trait_obj_msg = "for information on trait objects, see \
1836 <https://doc.rust-lang.org/book/ch17-02-trait-objects.html\
1837 #using-trait-objects-that-allow-for-values-of-different-types>";
1838 err.note("to return `impl Trait`, all returned values must be of the same type");
1839 err.note(impl_trait_msg);
1844 .span_to_snippet(return_sp)
1845 .unwrap_or_else(|_| "dyn Trait".to_string());
1846 let mut snippet_iter = snippet.split_whitespace();
1847 let has_impl = snippet_iter.next().map_or(false, |s| s == "impl");
1848 // Only suggest `Box<dyn Trait>` if `Trait` in `impl Trait` is object safe.
1849 let mut is_object_safe = false;
1850 if let hir::FnRetTy::Return(ty) = fn_output
1851 // Get the return type.
1852 && let hir::TyKind::OpaqueDef(..) = ty.kind
1854 let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty);
1855 // Get the `impl Trait`'s `DefId`.
1856 if let ty::Opaque(def_id, _) = ty.kind()
1857 // Get the `impl Trait`'s `Item` so that we can get its trait bounds and
1858 // get the `Trait`'s `DefId`.
1859 && let hir::ItemKind::OpaqueTy(hir::OpaqueTy { bounds, .. }) =
1860 fcx.tcx.hir().expect_item(def_id.expect_local()).kind
1862 // Are of this `impl Trait`'s traits object safe?
1863 is_object_safe = bounds.iter().all(|bound| {
1866 .and_then(|t| t.trait_def_id())
1867 .map_or(false, |def_id| {
1868 fcx.tcx.object_safety_violations(def_id).is_empty()
1875 err.multipart_suggestion(
1876 "you could change the return type to be a boxed trait object",
1878 (return_sp.with_hi(return_sp.lo() + BytePos(4)), "Box<dyn".to_string()),
1879 (return_sp.shrink_to_hi(), ">".to_string()),
1881 Applicability::MachineApplicable,
1883 let sugg = [sp, cause.span]
1887 (sp.shrink_to_lo(), "Box::new(".to_string()),
1888 (sp.shrink_to_hi(), ")".to_string()),
1892 .collect::<Vec<_>>();
1893 err.multipart_suggestion(
1894 "if you change the return type to expect trait objects, box the returned \
1897 Applicability::MaybeIncorrect,
1901 "if the trait `{}` were object safe, you could return a boxed trait object",
1905 err.note(trait_obj_msg);
1907 err.help("you could instead create a new `enum` with a variant for each returned type");
1910 fn is_return_ty_unsized<'a>(&self, fcx: &FnCtxt<'a, 'tcx>, blk_id: hir::HirId) -> bool {
1911 if let Some((fn_decl, _)) = fcx.get_fn_decl(blk_id)
1912 && let hir::FnRetTy::Return(ty) = fn_decl.output
1913 && let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty)
1914 && let ty::Dynamic(..) = ty.kind()
1921 pub fn complete<'a>(self, fcx: &FnCtxt<'a, 'tcx>) -> Ty<'tcx> {
1922 if let Some(final_ty) = self.final_ty {
1925 // If we only had inputs that were of type `!` (or no
1926 // inputs at all), then the final type is `!`.
1927 assert_eq!(self.pushed, 0);
1933 /// Something that can be converted into an expression to which we can
1934 /// apply a coercion.
1935 pub trait AsCoercionSite {
1936 fn as_coercion_site(&self) -> &hir::Expr<'_>;
1939 impl AsCoercionSite for hir::Expr<'_> {
1940 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1945 impl<'a, T> AsCoercionSite for &'a T
1949 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1950 (**self).as_coercion_site()
1954 impl AsCoercionSite for ! {
1955 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1960 impl AsCoercionSite for hir::Arm<'_> {
1961 fn as_coercion_site(&self) -> &hir::Expr<'_> {