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`.
38 use crate::astconv::AstConv;
39 use crate::check::FnCtxt;
41 struct_span_err, Applicability, Diagnostic, DiagnosticBuilder, ErrorGuaranteed, MultiSpan,
44 use rustc_hir::def_id::DefId;
45 use rustc_hir::intravisit::{self, Visitor};
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, ToPredicate, 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::InferCtxtExt as _;
65 use rustc_trait_selection::traits::{self, ObligationCause, ObligationCauseCode};
67 use smallvec::{smallvec, SmallVec};
70 struct Coerce<'a, 'tcx> {
71 fcx: &'a FnCtxt<'a, 'tcx>,
72 cause: ObligationCause<'tcx>,
74 /// Determines whether or not allow_two_phase_borrow is set on any
75 /// autoref adjustments we create while coercing. We don't want to
76 /// allow deref coercions to create two-phase borrows, at least initially,
77 /// but we do need two-phase borrows for function argument reborrows.
78 /// See #47489 and #48598
79 /// See docs on the "AllowTwoPhase" type for a more detailed discussion
80 allow_two_phase: AllowTwoPhase,
83 impl<'a, 'tcx> Deref for Coerce<'a, 'tcx> {
84 type Target = FnCtxt<'a, 'tcx>;
85 fn deref(&self) -> &Self::Target {
90 type CoerceResult<'tcx> = InferResult<'tcx, (Vec<Adjustment<'tcx>>, Ty<'tcx>)>;
92 struct CollectRetsVisitor<'tcx> {
93 ret_exprs: Vec<&'tcx hir::Expr<'tcx>>,
96 impl<'tcx> Visitor<'tcx> for CollectRetsVisitor<'tcx> {
97 fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) {
98 if let hir::ExprKind::Ret(_) = expr.kind {
99 self.ret_exprs.push(expr);
101 intravisit::walk_expr(self, expr);
105 /// Coercing a mutable reference to an immutable works, while
106 /// coercing `&T` to `&mut T` should be forbidden.
107 fn coerce_mutbls<'tcx>(
108 from_mutbl: hir::Mutability,
109 to_mutbl: hir::Mutability,
110 ) -> RelateResult<'tcx, ()> {
111 match (from_mutbl, to_mutbl) {
112 (hir::Mutability::Mut, hir::Mutability::Mut | hir::Mutability::Not)
113 | (hir::Mutability::Not, hir::Mutability::Not) => Ok(()),
114 (hir::Mutability::Not, hir::Mutability::Mut) => Err(TypeError::Mutability),
118 /// Do not require any adjustments, i.e. coerce `x -> x`.
119 fn identity(_: Ty<'_>) -> Vec<Adjustment<'_>> {
123 fn simple<'tcx>(kind: Adjust<'tcx>) -> impl FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>> {
124 move |target| vec![Adjustment { kind, target }]
127 /// This always returns `Ok(...)`.
129 adj: Vec<Adjustment<'tcx>>,
131 obligations: traits::PredicateObligations<'tcx>,
132 ) -> CoerceResult<'tcx> {
133 Ok(InferOk { value: (adj, target), obligations })
136 impl<'f, 'tcx> Coerce<'f, 'tcx> {
138 fcx: &'f FnCtxt<'f, 'tcx>,
139 cause: ObligationCause<'tcx>,
140 allow_two_phase: AllowTwoPhase,
142 Coerce { fcx, cause, allow_two_phase, use_lub: false }
145 fn unify(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> InferResult<'tcx, Ty<'tcx>> {
146 debug!("unify(a: {:?}, b: {:?}, use_lub: {})", a, b, self.use_lub);
147 self.commit_if_ok(|_| {
149 self.at(&self.cause, self.fcx.param_env).lub(b, a)
151 self.at(&self.cause, self.fcx.param_env)
153 .map(|InferOk { value: (), obligations }| InferOk { value: a, obligations })
158 /// Unify two types (using sub or lub) and produce a specific coercion.
159 fn unify_and<F>(&self, a: Ty<'tcx>, b: Ty<'tcx>, f: F) -> CoerceResult<'tcx>
161 F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
164 .and_then(|InferOk { value: ty, obligations }| success(f(ty), ty, obligations))
167 #[instrument(skip(self))]
168 fn coerce(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
169 // First, remove any resolved type variables (at the top level, at least):
170 let a = self.shallow_resolve(a);
171 let b = self.shallow_resolve(b);
172 debug!("Coerce.tys({:?} => {:?})", a, b);
174 // Just ignore error types.
175 if a.references_error() || b.references_error() {
176 return success(vec![], self.fcx.tcx.ty_error(), vec![]);
179 // Coercing from `!` to any type is allowed:
181 return success(simple(Adjust::NeverToAny)(b), b, vec![]);
184 // Coercing *from* an unresolved inference variable means that
185 // we have no information about the source type. This will always
186 // ultimately fall back to some form of subtyping.
188 return self.coerce_from_inference_variable(a, b, identity);
191 // Consider coercing the subtype to a DST
193 // NOTE: this is wrapped in a `commit_if_ok` because it creates
194 // a "spurious" type variable, and we don't want to have that
195 // type variable in memory if the coercion fails.
196 let unsize = self.commit_if_ok(|_| self.coerce_unsized(a, b));
199 debug!("coerce: unsize successful");
202 Err(TypeError::ObjectUnsafeCoercion(did)) => {
203 debug!("coerce: unsize not object safe");
204 return Err(TypeError::ObjectUnsafeCoercion(did));
207 debug!(?error, "coerce: unsize failed");
211 // Examine the supertype and consider auto-borrowing.
213 ty::RawPtr(mt_b) => {
214 return self.coerce_unsafe_ptr(a, b, mt_b.mutbl);
216 ty::Ref(r_b, _, mutbl_b) => {
217 return self.coerce_borrowed_pointer(a, b, r_b, mutbl_b);
224 // Function items are coercible to any closure
225 // type; function pointers are not (that would
226 // require double indirection).
227 // Additionally, we permit coercion of function
228 // items to drop the unsafe qualifier.
229 self.coerce_from_fn_item(a, b)
232 // We permit coercion of fn pointers to drop the
234 self.coerce_from_fn_pointer(a, a_f, b)
236 ty::Closure(closure_def_id_a, substs_a) => {
237 // Non-capturing closures are coercible to
238 // function pointers or unsafe function pointers.
239 // It cannot convert closures that require unsafe.
240 self.coerce_closure_to_fn(a, closure_def_id_a, substs_a, b)
243 // Otherwise, just use unification rules.
244 self.unify_and(a, b, identity)
249 /// Coercing *from* an inference variable. In this case, we have no information
250 /// about the source type, so we can't really do a true coercion and we always
251 /// fall back to subtyping (`unify_and`).
252 fn coerce_from_inference_variable(
256 make_adjustments: impl FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
257 ) -> CoerceResult<'tcx> {
258 debug!("coerce_from_inference_variable(a={:?}, b={:?})", a, b);
259 assert!(a.is_ty_var() && self.shallow_resolve(a) == a);
260 assert!(self.shallow_resolve(b) == b);
263 // Two unresolved type variables: create a `Coerce` predicate.
264 let target_ty = if self.use_lub {
265 self.next_ty_var(TypeVariableOrigin {
266 kind: TypeVariableOriginKind::LatticeVariable,
267 span: self.cause.span,
273 let mut obligations = Vec::with_capacity(2);
274 for &source_ty in &[a, b] {
275 if source_ty != target_ty {
276 obligations.push(Obligation::new(
279 ty::Binder::dummy(ty::PredicateKind::Coerce(ty::CoercePredicate {
283 .to_predicate(self.tcx()),
289 "coerce_from_inference_variable: two inference variables, target_ty={:?}, obligations={:?}",
290 target_ty, obligations
292 let adjustments = make_adjustments(target_ty);
293 InferResult::Ok(InferOk { value: (adjustments, target_ty), obligations })
295 // One unresolved type variable: just apply subtyping, we may be able
296 // to do something useful.
297 self.unify_and(a, b, make_adjustments)
301 /// Reborrows `&mut A` to `&mut B` and `&(mut) A` to `&B`.
302 /// To match `A` with `B`, autoderef will be performed,
303 /// calling `deref`/`deref_mut` where necessary.
304 fn coerce_borrowed_pointer(
308 r_b: ty::Region<'tcx>,
309 mutbl_b: hir::Mutability,
310 ) -> CoerceResult<'tcx> {
311 debug!("coerce_borrowed_pointer(a={:?}, b={:?})", a, b);
313 // If we have a parameter of type `&M T_a` and the value
314 // provided is `expr`, we will be adding an implicit borrow,
315 // meaning that we convert `f(expr)` to `f(&M *expr)`. Therefore,
316 // to type check, we will construct the type that `&M*expr` would
319 let (r_a, mt_a) = match *a.kind() {
320 ty::Ref(r_a, ty, mutbl) => {
321 let mt_a = ty::TypeAndMut { ty, mutbl };
322 coerce_mutbls(mt_a.mutbl, mutbl_b)?;
325 _ => return self.unify_and(a, b, identity),
328 let span = self.cause.span;
330 let mut first_error = None;
331 let mut r_borrow_var = None;
332 let mut autoderef = self.autoderef(span, a);
333 let mut found = None;
335 for (referent_ty, autoderefs) in autoderef.by_ref() {
337 // Don't let this pass, otherwise it would cause
338 // &T to autoref to &&T.
342 // At this point, we have deref'd `a` to `referent_ty`. So
343 // imagine we are coercing from `&'a mut Vec<T>` to `&'b mut [T]`.
344 // In the autoderef loop for `&'a mut Vec<T>`, we would get
347 // - `&'a mut Vec<T>` -- 0 derefs, just ignore it
348 // - `Vec<T>` -- 1 deref
349 // - `[T]` -- 2 deref
351 // At each point after the first callback, we want to
352 // check to see whether this would match out target type
353 // (`&'b mut [T]`) if we autoref'd it. We can't just
354 // compare the referent types, though, because we still
355 // have to consider the mutability. E.g., in the case
356 // we've been considering, we have an `&mut` reference, so
357 // the `T` in `[T]` needs to be unified with equality.
359 // Therefore, we construct reference types reflecting what
360 // the types will be after we do the final auto-ref and
361 // compare those. Note that this means we use the target
362 // mutability [1], since it may be that we are coercing
363 // from `&mut T` to `&U`.
365 // One fine point concerns the region that we use. We
366 // choose the region such that the region of the final
367 // type that results from `unify` will be the region we
368 // want for the autoref:
370 // - if in sub mode, that means we want to use `'b` (the
371 // region from the target reference) for both
372 // pointers [2]. This is because sub mode (somewhat
373 // arbitrarily) returns the subtype region. In the case
374 // where we are coercing to a target type, we know we
375 // want to use that target type region (`'b`) because --
376 // for the program to type-check -- it must be the
377 // smaller of the two.
378 // - One fine point. It may be surprising that we can
379 // use `'b` without relating `'a` and `'b`. The reason
380 // that this is ok is that what we produce is
381 // effectively a `&'b *x` expression (if you could
382 // annotate the region of a borrow), and regionck has
383 // code that adds edges from the region of a borrow
384 // (`'b`, here) into the regions in the borrowed
385 // expression (`*x`, here). (Search for "link".)
386 // - if in lub mode, things can get fairly complicated. The
387 // easiest thing is just to make a fresh
388 // region variable [4], which effectively means we defer
389 // the decision to region inference (and regionck, which will add
390 // some more edges to this variable). However, this can wind up
391 // creating a crippling number of variables in some cases --
392 // e.g., #32278 -- so we optimize one particular case [3].
393 // Let me try to explain with some examples:
394 // - The "running example" above represents the simple case,
395 // where we have one `&` reference at the outer level and
396 // ownership all the rest of the way down. In this case,
397 // we want `LUB('a, 'b)` as the resulting region.
398 // - However, if there are nested borrows, that region is
399 // too strong. Consider a coercion from `&'a &'x Rc<T>` to
400 // `&'b T`. In this case, `'a` is actually irrelevant.
401 // The pointer we want is `LUB('x, 'b`). If we choose `LUB('a,'b)`
402 // we get spurious errors (`ui/regions-lub-ref-ref-rc.rs`).
403 // (The errors actually show up in borrowck, typically, because
404 // this extra edge causes the region `'a` to be inferred to something
405 // too big, which then results in borrowck errors.)
406 // - We could track the innermost shared reference, but there is already
407 // code in regionck that has the job of creating links between
408 // the region of a borrow and the regions in the thing being
409 // borrowed (here, `'a` and `'x`), and it knows how to handle
410 // all the various cases. So instead we just make a region variable
411 // and let regionck figure it out.
412 let r = if !self.use_lub {
414 } else if autoderefs == 1 {
417 if r_borrow_var.is_none() {
418 // create var lazily, at most once
419 let coercion = Coercion(span);
420 let r = self.next_region_var(coercion);
421 r_borrow_var = Some(r); // [4] above
423 r_borrow_var.unwrap()
425 let derefd_ty_a = self.tcx.mk_ref(
429 mutbl: mutbl_b, // [1] above
432 match self.unify(derefd_ty_a, b) {
438 if first_error.is_none() {
439 first_error = Some(err);
445 // Extract type or return an error. We return the first error
446 // we got, which should be from relating the "base" type
447 // (e.g., in example above, the failure from relating `Vec<T>`
448 // to the target type), since that should be the least
450 let Some(InferOk { value: ty, mut obligations }) = found else {
451 let err = first_error.expect("coerce_borrowed_pointer had no error");
452 debug!("coerce_borrowed_pointer: failed with err = {:?}", err);
456 if ty == a && mt_a.mutbl == hir::Mutability::Not && autoderef.step_count() == 1 {
457 // As a special case, if we would produce `&'a *x`, that's
458 // a total no-op. We end up with the type `&'a T` just as
459 // we started with. In that case, just skip it
460 // altogether. This is just an optimization.
462 // Note that for `&mut`, we DO want to reborrow --
463 // otherwise, this would be a move, which might be an
464 // error. For example `foo(self.x)` where `self` and
465 // `self.x` both have `&mut `type would be a move of
466 // `self.x`, but we auto-coerce it to `foo(&mut *self.x)`,
467 // which is a borrow.
468 assert_eq!(mutbl_b, hir::Mutability::Not); // can only coerce &T -> &U
469 return success(vec![], ty, obligations);
472 let InferOk { value: mut adjustments, obligations: o } =
473 self.adjust_steps_as_infer_ok(&autoderef);
474 obligations.extend(o);
475 obligations.extend(autoderef.into_obligations());
477 // Now apply the autoref. We have to extract the region out of
478 // the final ref type we got.
479 let ty::Ref(r_borrow, _, _) = ty.kind() else {
480 span_bug!(span, "expected a ref type, got {:?}", ty);
482 let mutbl = match mutbl_b {
483 hir::Mutability::Not => AutoBorrowMutability::Not,
484 hir::Mutability::Mut => {
485 AutoBorrowMutability::Mut { allow_two_phase_borrow: self.allow_two_phase }
488 adjustments.push(Adjustment {
489 kind: Adjust::Borrow(AutoBorrow::Ref(*r_borrow, mutbl)),
493 debug!("coerce_borrowed_pointer: succeeded ty={:?} adjustments={:?}", ty, adjustments);
495 success(adjustments, ty, obligations)
498 // &[T; n] or &mut [T; n] -> &[T]
499 // or &mut [T; n] -> &mut [T]
500 // or &Concrete -> &Trait, etc.
501 #[instrument(skip(self), level = "debug")]
502 fn coerce_unsized(&self, mut source: Ty<'tcx>, mut target: Ty<'tcx>) -> CoerceResult<'tcx> {
503 source = self.shallow_resolve(source);
504 target = self.shallow_resolve(target);
505 debug!(?source, ?target);
507 // These 'if' statements require some explanation.
508 // The `CoerceUnsized` trait is special - it is only
509 // possible to write `impl CoerceUnsized<B> for A` where
510 // A and B have 'matching' fields. This rules out the following
511 // two types of blanket impls:
513 // `impl<T> CoerceUnsized<T> for SomeType`
514 // `impl<T> CoerceUnsized<SomeType> for T`
516 // Both of these trigger a special `CoerceUnsized`-related error (E0376)
518 // We can take advantage of this fact to avoid performing unnecessary work.
519 // If either `source` or `target` is a type variable, then any applicable impl
520 // would need to be generic over the self-type (`impl<T> CoerceUnsized<SomeType> for T`)
521 // or generic over the `CoerceUnsized` type parameter (`impl<T> CoerceUnsized<T> for
524 // However, these are exactly the kinds of impls which are forbidden by
525 // the compiler! Therefore, we can be sure that coercion will always fail
526 // when either the source or target type is a type variable. This allows us
527 // to skip performing any trait selection, and immediately bail out.
528 if source.is_ty_var() {
529 debug!("coerce_unsized: source is a TyVar, bailing out");
530 return Err(TypeError::Mismatch);
532 if target.is_ty_var() {
533 debug!("coerce_unsized: target is a TyVar, bailing out");
534 return Err(TypeError::Mismatch);
538 (self.tcx.lang_items().unsize_trait(), self.tcx.lang_items().coerce_unsized_trait());
539 let (Some(unsize_did), Some(coerce_unsized_did)) = traits else {
540 debug!("missing Unsize or CoerceUnsized traits");
541 return Err(TypeError::Mismatch);
544 // Note, we want to avoid unnecessary unsizing. We don't want to coerce to
545 // a DST unless we have to. This currently comes out in the wash since
546 // we can't unify [T] with U. But to properly support DST, we need to allow
547 // that, at which point we will need extra checks on the target here.
549 // Handle reborrows before selecting `Source: CoerceUnsized<Target>`.
550 let reborrow = match (source.kind(), target.kind()) {
551 (&ty::Ref(_, ty_a, mutbl_a), &ty::Ref(_, _, mutbl_b)) => {
552 coerce_mutbls(mutbl_a, mutbl_b)?;
554 let coercion = Coercion(self.cause.span);
555 let r_borrow = self.next_region_var(coercion);
556 let mutbl = match mutbl_b {
557 hir::Mutability::Not => AutoBorrowMutability::Not,
558 hir::Mutability::Mut => AutoBorrowMutability::Mut {
559 // We don't allow two-phase borrows here, at least for initial
560 // implementation. If it happens that this coercion is a function argument,
561 // the reborrow in coerce_borrowed_ptr will pick it up.
562 allow_two_phase_borrow: AllowTwoPhase::No,
566 Adjustment { kind: Adjust::Deref(None), target: ty_a },
568 kind: Adjust::Borrow(AutoBorrow::Ref(r_borrow, mutbl)),
571 .mk_ref(r_borrow, ty::TypeAndMut { mutbl: mutbl_b, ty: ty_a }),
575 (&ty::Ref(_, ty_a, mt_a), &ty::RawPtr(ty::TypeAndMut { mutbl: mt_b, .. })) => {
576 coerce_mutbls(mt_a, mt_b)?;
579 Adjustment { kind: Adjust::Deref(None), target: ty_a },
581 kind: Adjust::Borrow(AutoBorrow::RawPtr(mt_b)),
582 target: self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mt_b, ty: ty_a }),
588 let coerce_source = reborrow.as_ref().map_or(source, |&(_, ref r)| r.target);
590 // Setup either a subtyping or a LUB relationship between
591 // the `CoerceUnsized` target type and the expected type.
592 // We only have the latter, so we use an inference variable
593 // for the former and let type inference do the rest.
594 let origin = TypeVariableOrigin {
595 kind: TypeVariableOriginKind::MiscVariable,
596 span: self.cause.span,
598 let coerce_target = self.next_ty_var(origin);
599 let mut coercion = self.unify_and(coerce_target, target, |target| {
600 let unsize = Adjustment { kind: Adjust::Pointer(PointerCast::Unsize), target };
602 None => vec![unsize],
603 Some((ref deref, ref autoref)) => vec![deref.clone(), autoref.clone(), unsize],
607 let mut selcx = traits::SelectionContext::new(self);
609 // Create an obligation for `Source: CoerceUnsized<Target>`.
610 let cause = ObligationCause::new(
613 ObligationCauseCode::Coercion { source, target },
616 // Use a FIFO queue for this custom fulfillment procedure.
618 // A Vec (or SmallVec) is not a natural choice for a queue. However,
619 // this code path is hot, and this queue usually has a max length of 1
620 // and almost never more than 3. By using a SmallVec we avoid an
621 // allocation, at the (very small) cost of (occasionally) having to
622 // shift subsequent elements down when removing the front element.
623 let mut queue: SmallVec<[_; 4]> = smallvec![traits::predicate_for_trait_def(
630 &[coerce_target.into()]
633 let mut has_unsized_tuple_coercion = false;
634 let mut has_trait_upcasting_coercion = None;
636 // Keep resolving `CoerceUnsized` and `Unsize` predicates to avoid
637 // emitting a coercion in cases like `Foo<$1>` -> `Foo<$2>`, where
638 // inference might unify those two inner type variables later.
639 let traits = [coerce_unsized_did, unsize_did];
640 while !queue.is_empty() {
641 let obligation = queue.remove(0);
642 debug!("coerce_unsized resolve step: {:?}", obligation);
643 let bound_predicate = obligation.predicate.kind();
644 let trait_pred = match bound_predicate.skip_binder() {
645 ty::PredicateKind::Trait(trait_pred) if traits.contains(&trait_pred.def_id()) => {
646 if unsize_did == trait_pred.def_id() {
647 let self_ty = trait_pred.self_ty();
648 let unsize_ty = trait_pred.trait_ref.substs[1].expect_ty();
649 if let (ty::Dynamic(ref data_a, ..), ty::Dynamic(ref data_b, ..)) =
650 (self_ty.kind(), unsize_ty.kind())
651 && data_a.principal_def_id() != data_b.principal_def_id()
653 debug!("coerce_unsized: found trait upcasting coercion");
654 has_trait_upcasting_coercion = Some((self_ty, unsize_ty));
656 if let ty::Tuple(..) = unsize_ty.kind() {
657 debug!("coerce_unsized: found unsized tuple coercion");
658 has_unsized_tuple_coercion = true;
661 bound_predicate.rebind(trait_pred)
664 coercion.obligations.push(obligation);
668 match selcx.select(&obligation.with(trait_pred)) {
669 // Uncertain or unimplemented.
671 if trait_pred.def_id() == unsize_did {
672 let trait_pred = self.resolve_vars_if_possible(trait_pred);
673 let self_ty = trait_pred.skip_binder().self_ty();
674 let unsize_ty = trait_pred.skip_binder().trait_ref.substs[1].expect_ty();
675 debug!("coerce_unsized: ambiguous unsize case for {:?}", trait_pred);
676 match (&self_ty.kind(), &unsize_ty.kind()) {
677 (ty::Infer(ty::TyVar(v)), ty::Dynamic(..))
678 if self.type_var_is_sized(*v) =>
680 debug!("coerce_unsized: have sized infer {:?}", v);
681 coercion.obligations.push(obligation);
682 // `$0: Unsize<dyn Trait>` where we know that `$0: Sized`, try going
686 // Some other case for `$0: Unsize<Something>`. Note that we
687 // hit this case even if `Something` is a sized type, so just
688 // don't do the coercion.
689 debug!("coerce_unsized: ambiguous unsize");
690 return Err(TypeError::Mismatch);
694 debug!("coerce_unsized: early return - ambiguous");
695 return Err(TypeError::Mismatch);
698 Err(traits::Unimplemented) => {
699 debug!("coerce_unsized: early return - can't prove obligation");
700 return Err(TypeError::Mismatch);
703 // Object safety violations or miscellaneous.
705 self.report_selection_error(obligation.clone(), &obligation, &err, false);
706 // Treat this like an obligation and follow through
707 // with the unsizing - the lack of a coercion should
708 // be silent, as it causes a type mismatch later.
711 Ok(Some(impl_source)) => queue.extend(impl_source.nested_obligations()),
715 if has_unsized_tuple_coercion && !self.tcx.features().unsized_tuple_coercion {
717 &self.tcx.sess.parse_sess,
718 sym::unsized_tuple_coercion,
720 "unsized tuple coercion is not stable enough for use and is subject to change",
725 if let Some((sub, sup)) = has_trait_upcasting_coercion
726 && !self.tcx().features().trait_upcasting
728 // Renders better when we erase regions, since they're not really the point here.
729 let (sub, sup) = self.tcx.erase_regions((sub, sup));
730 let mut err = feature_err(
731 &self.tcx.sess.parse_sess,
732 sym::trait_upcasting,
734 &format!("cannot cast `{sub}` to `{sup}`, trait upcasting coercion is experimental"),
736 err.note(&format!("required when coercing `{source}` into `{target}`"));
743 fn coerce_from_safe_fn<F, G>(
746 fn_ty_a: ty::PolyFnSig<'tcx>,
750 ) -> CoerceResult<'tcx>
752 F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
753 G: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
755 self.commit_if_ok(|snapshot| {
756 let result = if let ty::FnPtr(fn_ty_b) = b.kind()
757 && let (hir::Unsafety::Normal, hir::Unsafety::Unsafe) =
758 (fn_ty_a.unsafety(), fn_ty_b.unsafety())
760 let unsafe_a = self.tcx.safe_to_unsafe_fn_ty(fn_ty_a);
761 self.unify_and(unsafe_a, b, to_unsafe)
763 self.unify_and(a, b, normal)
766 // FIXME(#73154): This is a hack. Currently LUB can generate
767 // unsolvable constraints. Additionally, it returns `a`
768 // unconditionally, even when the "LUB" is `b`. In the future, we
769 // want the coerced type to be the actual supertype of these two,
770 // but for now, we want to just error to ensure we don't lock
771 // ourselves into a specific behavior with NLL.
772 self.leak_check(false, snapshot)?;
778 fn coerce_from_fn_pointer(
781 fn_ty_a: ty::PolyFnSig<'tcx>,
783 ) -> CoerceResult<'tcx> {
784 //! Attempts to coerce from the type of a Rust function item
785 //! into a closure or a `proc`.
788 let b = self.shallow_resolve(b);
789 debug!("coerce_from_fn_pointer(a={:?}, b={:?})", a, b);
791 self.coerce_from_safe_fn(
795 simple(Adjust::Pointer(PointerCast::UnsafeFnPointer)),
800 fn coerce_from_fn_item(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
801 //! Attempts to coerce from the type of a Rust function item
802 //! into a closure or a `proc`.
804 let b = self.shallow_resolve(b);
805 let InferOk { value: b, mut obligations } =
806 self.normalize_associated_types_in_as_infer_ok(self.cause.span, b);
807 debug!("coerce_from_fn_item(a={:?}, b={:?})", a, b);
810 ty::FnPtr(b_sig) => {
811 let a_sig = a.fn_sig(self.tcx);
812 if let ty::FnDef(def_id, _) = *a.kind() {
813 // Intrinsics are not coercible to function pointers
814 if self.tcx.is_intrinsic(def_id) {
815 return Err(TypeError::IntrinsicCast);
818 // Safe `#[target_feature]` functions are not assignable to safe fn pointers (RFC 2396).
820 if b_sig.unsafety() == hir::Unsafety::Normal
821 && !self.tcx.codegen_fn_attrs(def_id).target_features.is_empty()
823 return Err(TypeError::TargetFeatureCast(def_id));
827 let InferOk { value: a_sig, obligations: o1 } =
828 self.normalize_associated_types_in_as_infer_ok(self.cause.span, a_sig);
829 obligations.extend(o1);
831 let a_fn_pointer = self.tcx.mk_fn_ptr(a_sig);
832 let InferOk { value, obligations: o2 } = self.coerce_from_safe_fn(
839 kind: Adjust::Pointer(PointerCast::ReifyFnPointer),
840 target: a_fn_pointer,
843 kind: Adjust::Pointer(PointerCast::UnsafeFnPointer),
848 simple(Adjust::Pointer(PointerCast::ReifyFnPointer)),
851 obligations.extend(o2);
852 Ok(InferOk { value, obligations })
854 _ => self.unify_and(a, b, identity),
858 fn coerce_closure_to_fn(
861 closure_def_id_a: DefId,
862 substs_a: SubstsRef<'tcx>,
864 ) -> CoerceResult<'tcx> {
865 //! Attempts to coerce from the type of a non-capturing closure
866 //! into a function pointer.
869 let b = self.shallow_resolve(b);
872 // At this point we haven't done capture analysis, which means
873 // that the ClosureSubsts just contains an inference variable instead
874 // of tuple of captured types.
876 // All we care here is if any variable is being captured and not the exact paths,
877 // so we check `upvars_mentioned` for root variables being captured.
881 .upvars_mentioned(closure_def_id_a.expect_local())
882 .map_or(true, |u| u.is_empty()) =>
884 // We coerce the closure, which has fn type
885 // `extern "rust-call" fn((arg0,arg1,...)) -> _`
887 // `fn(arg0,arg1,...) -> _`
889 // `unsafe fn(arg0,arg1,...) -> _`
890 let closure_sig = substs_a.as_closure().sig();
891 let unsafety = fn_ty.unsafety();
893 self.tcx.mk_fn_ptr(self.tcx.signature_unclosure(closure_sig, unsafety));
894 debug!("coerce_closure_to_fn(a={:?}, b={:?}, pty={:?})", a, b, pointer_ty);
898 simple(Adjust::Pointer(PointerCast::ClosureFnPointer(unsafety))),
901 _ => self.unify_and(a, b, identity),
905 fn coerce_unsafe_ptr(
909 mutbl_b: hir::Mutability,
910 ) -> CoerceResult<'tcx> {
911 debug!("coerce_unsafe_ptr(a={:?}, b={:?})", a, b);
913 let (is_ref, mt_a) = match *a.kind() {
914 ty::Ref(_, ty, mutbl) => (true, ty::TypeAndMut { ty, mutbl }),
915 ty::RawPtr(mt) => (false, mt),
916 _ => return self.unify_and(a, b, identity),
918 coerce_mutbls(mt_a.mutbl, mutbl_b)?;
920 // Check that the types which they point at are compatible.
921 let a_unsafe = self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mutbl_b, ty: mt_a.ty });
922 // Although references and unsafe ptrs have the same
923 // representation, we still register an Adjust::DerefRef so that
924 // regionck knows that the region for `a` must be valid here.
926 self.unify_and(a_unsafe, b, |target| {
928 Adjustment { kind: Adjust::Deref(None), target: mt_a.ty },
929 Adjustment { kind: Adjust::Borrow(AutoBorrow::RawPtr(mutbl_b)), target },
932 } else if mt_a.mutbl != mutbl_b {
933 self.unify_and(a_unsafe, b, simple(Adjust::Pointer(PointerCast::MutToConstPointer)))
935 self.unify_and(a_unsafe, b, identity)
940 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
941 /// Attempt to coerce an expression to a type, and return the
942 /// adjusted type of the expression, if successful.
943 /// Adjustments are only recorded if the coercion succeeded.
944 /// The expressions *must not* have any pre-existing adjustments.
947 expr: &hir::Expr<'_>,
950 allow_two_phase: AllowTwoPhase,
951 cause: Option<ObligationCause<'tcx>>,
952 ) -> RelateResult<'tcx, Ty<'tcx>> {
953 let source = self.resolve_vars_with_obligations(expr_ty);
954 debug!("coercion::try({:?}: {:?} -> {:?})", expr, source, target);
957 cause.unwrap_or_else(|| self.cause(expr.span, ObligationCauseCode::ExprAssignable));
958 let coerce = Coerce::new(self, cause, allow_two_phase);
959 let ok = self.commit_if_ok(|_| coerce.coerce(source, target))?;
961 let (adjustments, _) = self.register_infer_ok_obligations(ok);
962 self.apply_adjustments(expr, adjustments);
963 Ok(if expr_ty.references_error() { self.tcx.ty_error() } else { target })
966 /// Same as `try_coerce()`, but without side-effects.
968 /// Returns false if the coercion creates any obligations that result in
970 pub fn can_coerce(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> bool {
971 let source = self.resolve_vars_with_obligations(expr_ty);
972 debug!("coercion::can_with_predicates({:?} -> {:?})", source, target);
974 let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
975 // We don't ever need two-phase here since we throw out the result of the coercion
976 let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
978 let Ok(ok) = coerce.coerce(source, target) else {
981 let mut fcx = traits::FulfillmentContext::new_in_snapshot();
982 fcx.register_predicate_obligations(self, ok.obligations);
983 fcx.select_where_possible(&self).is_empty()
987 /// Given a type and a target type, this function will calculate and return
988 /// how many dereference steps needed to achieve `expr_ty <: target`. If
989 /// it's not possible, return `None`.
990 pub fn deref_steps(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> Option<usize> {
991 let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
992 // We don't ever need two-phase here since we throw out the result of the coercion
993 let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
995 .autoderef(rustc_span::DUMMY_SP, expr_ty)
996 .find_map(|(ty, steps)| self.probe(|_| coerce.unify(ty, target)).ok().map(|_| steps))
999 /// Given a type, this function will calculate and return the type given
1000 /// for `<Ty as Deref>::Target` only if `Ty` also implements `DerefMut`.
1002 /// This function is for diagnostics only, since it does not register
1003 /// trait or region sub-obligations. (presumably we could, but it's not
1004 /// particularly important for diagnostics...)
1005 pub fn deref_once_mutably_for_diagnostic(&self, expr_ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
1006 self.autoderef(rustc_span::DUMMY_SP, expr_ty).nth(1).and_then(|(deref_ty, _)| {
1008 .type_implements_trait(
1009 self.tcx.lang_items().deref_mut_trait()?,
1019 /// Given some expressions, their known unified type and another expression,
1020 /// tries to unify the types, potentially inserting coercions on any of the
1021 /// provided expressions and returns their LUB (aka "common supertype").
1023 /// This is really an internal helper. From outside the coercion
1024 /// module, you should instantiate a `CoerceMany` instance.
1025 fn try_find_coercion_lub<E>(
1027 cause: &ObligationCause<'tcx>,
1030 new: &hir::Expr<'_>,
1032 ) -> RelateResult<'tcx, Ty<'tcx>>
1036 let prev_ty = self.resolve_vars_with_obligations(prev_ty);
1037 let new_ty = self.resolve_vars_with_obligations(new_ty);
1039 "coercion::try_find_coercion_lub({:?}, {:?}, exprs={:?} exprs)",
1045 // The following check fixes #88097, where the compiler erroneously
1046 // attempted to coerce a closure type to itself via a function pointer.
1047 if prev_ty == new_ty {
1051 // Special-case that coercion alone cannot handle:
1052 // Function items or non-capturing closures of differing IDs or InternalSubsts.
1053 let (a_sig, b_sig) = {
1054 #[allow(rustc::usage_of_ty_tykind)]
1055 let is_capturing_closure = |ty: &ty::TyKind<'tcx>| {
1056 if let &ty::Closure(closure_def_id, _substs) = ty {
1057 self.tcx.upvars_mentioned(closure_def_id.expect_local()).is_some()
1062 if is_capturing_closure(prev_ty.kind()) || is_capturing_closure(new_ty.kind()) {
1065 match (prev_ty.kind(), new_ty.kind()) {
1066 (ty::FnDef(..), ty::FnDef(..)) => {
1067 // Don't reify if the function types have a LUB, i.e., they
1068 // are the same function and their parameters have a LUB.
1070 .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1072 // We have a LUB of prev_ty and new_ty, just return it.
1073 Ok(ok) => return Ok(self.register_infer_ok_obligations(ok)),
1075 (Some(prev_ty.fn_sig(self.tcx)), Some(new_ty.fn_sig(self.tcx)))
1079 (ty::Closure(_, substs), ty::FnDef(..)) => {
1080 let b_sig = new_ty.fn_sig(self.tcx);
1083 .signature_unclosure(substs.as_closure().sig(), b_sig.unsafety());
1084 (Some(a_sig), Some(b_sig))
1086 (ty::FnDef(..), ty::Closure(_, substs)) => {
1087 let a_sig = prev_ty.fn_sig(self.tcx);
1090 .signature_unclosure(substs.as_closure().sig(), a_sig.unsafety());
1091 (Some(a_sig), Some(b_sig))
1093 (ty::Closure(_, substs_a), ty::Closure(_, substs_b)) => (
1094 Some(self.tcx.signature_unclosure(
1095 substs_a.as_closure().sig(),
1096 hir::Unsafety::Normal,
1098 Some(self.tcx.signature_unclosure(
1099 substs_b.as_closure().sig(),
1100 hir::Unsafety::Normal,
1107 if let (Some(a_sig), Some(b_sig)) = (a_sig, b_sig) {
1108 // Intrinsics are not coercible to function pointers.
1109 if a_sig.abi() == Abi::RustIntrinsic
1110 || a_sig.abi() == Abi::PlatformIntrinsic
1111 || b_sig.abi() == Abi::RustIntrinsic
1112 || b_sig.abi() == Abi::PlatformIntrinsic
1114 return Err(TypeError::IntrinsicCast);
1116 // The signature must match.
1117 let a_sig = self.normalize_associated_types_in(new.span, a_sig);
1118 let b_sig = self.normalize_associated_types_in(new.span, b_sig);
1120 .at(cause, self.param_env)
1121 .trace(prev_ty, new_ty)
1123 .map(|ok| self.register_infer_ok_obligations(ok))?;
1125 // Reify both sides and return the reified fn pointer type.
1126 let fn_ptr = self.tcx.mk_fn_ptr(sig);
1127 let prev_adjustment = match prev_ty.kind() {
1128 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(a_sig.unsafety())),
1129 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1130 _ => unreachable!(),
1132 let next_adjustment = match new_ty.kind() {
1133 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(b_sig.unsafety())),
1134 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1135 _ => unreachable!(),
1137 for expr in exprs.iter().map(|e| e.as_coercion_site()) {
1138 self.apply_adjustments(
1140 vec![Adjustment { kind: prev_adjustment.clone(), target: fn_ptr }],
1143 self.apply_adjustments(new, vec![Adjustment { kind: next_adjustment, target: fn_ptr }]);
1147 // Configure a Coerce instance to compute the LUB.
1148 // We don't allow two-phase borrows on any autorefs this creates since we
1149 // probably aren't processing function arguments here and even if we were,
1150 // they're going to get autorefed again anyway and we can apply 2-phase borrows
1152 let mut coerce = Coerce::new(self, cause.clone(), AllowTwoPhase::No);
1153 coerce.use_lub = true;
1155 // First try to coerce the new expression to the type of the previous ones,
1156 // but only if the new expression has no coercion already applied to it.
1157 let mut first_error = None;
1158 if !self.typeck_results.borrow().adjustments().contains_key(new.hir_id) {
1159 let result = self.commit_if_ok(|_| coerce.coerce(new_ty, prev_ty));
1162 let (adjustments, target) = self.register_infer_ok_obligations(ok);
1163 self.apply_adjustments(new, adjustments);
1165 "coercion::try_find_coercion_lub: was able to coerce from new type {:?} to previous type {:?} ({:?})",
1166 new_ty, prev_ty, target
1170 Err(e) => first_error = Some(e),
1174 // Then try to coerce the previous expressions to the type of the new one.
1175 // This requires ensuring there are no coercions applied to *any* of the
1176 // previous expressions, other than noop reborrows (ignoring lifetimes).
1178 let expr = expr.as_coercion_site();
1179 let noop = match self.typeck_results.borrow().expr_adjustments(expr) {
1181 Adjustment { kind: Adjust::Deref(_), .. },
1182 Adjustment { kind: Adjust::Borrow(AutoBorrow::Ref(_, mutbl_adj)), .. },
1184 match *self.node_ty(expr.hir_id).kind() {
1185 ty::Ref(_, _, mt_orig) => {
1186 let mutbl_adj: hir::Mutability = mutbl_adj.into();
1187 // Reborrow that we can safely ignore, because
1188 // the next adjustment can only be a Deref
1189 // which will be merged into it.
1190 mutbl_adj == mt_orig
1195 &[Adjustment { kind: Adjust::NeverToAny, .. }] | &[] => true,
1201 "coercion::try_find_coercion_lub: older expression {:?} had adjustments, requiring LUB",
1206 .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1207 .map(|ok| self.register_infer_ok_obligations(ok));
1211 match self.commit_if_ok(|_| coerce.coerce(prev_ty, new_ty)) {
1213 // Avoid giving strange errors on failed attempts.
1214 if let Some(e) = first_error {
1217 self.commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1218 .map(|ok| self.register_infer_ok_obligations(ok))
1222 let (adjustments, target) = self.register_infer_ok_obligations(ok);
1224 let expr = expr.as_coercion_site();
1225 self.apply_adjustments(expr, adjustments.clone());
1228 "coercion::try_find_coercion_lub: was able to coerce previous type {:?} to new type {:?} ({:?})",
1229 prev_ty, new_ty, target
1237 /// CoerceMany encapsulates the pattern you should use when you have
1238 /// many expressions that are all getting coerced to a common
1239 /// type. This arises, for example, when you have a match (the result
1240 /// of each arm is coerced to a common type). It also arises in less
1241 /// obvious places, such as when you have many `break foo` expressions
1242 /// that target the same loop, or the various `return` expressions in
1245 /// The basic protocol is as follows:
1247 /// - Instantiate the `CoerceMany` with an initial `expected_ty`.
1248 /// This will also serve as the "starting LUB". The expectation is
1249 /// that this type is something which all of the expressions *must*
1250 /// be coercible to. Use a fresh type variable if needed.
1251 /// - For each expression whose result is to be coerced, invoke `coerce()` with.
1252 /// - In some cases we wish to coerce "non-expressions" whose types are implicitly
1253 /// unit. This happens for example if you have a `break` with no expression,
1254 /// or an `if` with no `else`. In that case, invoke `coerce_forced_unit()`.
1255 /// - `coerce()` and `coerce_forced_unit()` may report errors. They hide this
1256 /// from you so that you don't have to worry your pretty head about it.
1257 /// But if an error is reported, the final type will be `err`.
1258 /// - Invoking `coerce()` may cause us to go and adjust the "adjustments" on
1259 /// previously coerced expressions.
1260 /// - When all done, invoke `complete()`. This will return the LUB of
1261 /// all your expressions.
1262 /// - WARNING: I don't believe this final type is guaranteed to be
1263 /// related to your initial `expected_ty` in any particular way,
1264 /// although it will typically be a subtype, so you should check it.
1265 /// - Invoking `complete()` may cause us to go and adjust the "adjustments" on
1266 /// previously coerced expressions.
1270 /// ```ignore (illustrative)
1271 /// let mut coerce = CoerceMany::new(expected_ty);
1272 /// for expr in exprs {
1273 /// let expr_ty = fcx.check_expr_with_expectation(expr, expected);
1274 /// coerce.coerce(fcx, &cause, expr, expr_ty);
1276 /// let final_ty = coerce.complete(fcx);
1278 pub struct CoerceMany<'tcx, 'exprs, E: AsCoercionSite> {
1279 expected_ty: Ty<'tcx>,
1280 final_ty: Option<Ty<'tcx>>,
1281 expressions: Expressions<'tcx, 'exprs, E>,
1285 /// The type of a `CoerceMany` that is storing up the expressions into
1286 /// a buffer. We use this in `check/mod.rs` for things like `break`.
1287 pub type DynamicCoerceMany<'tcx> = CoerceMany<'tcx, 'tcx, &'tcx hir::Expr<'tcx>>;
1289 enum Expressions<'tcx, 'exprs, E: AsCoercionSite> {
1290 Dynamic(Vec<&'tcx hir::Expr<'tcx>>),
1291 UpFront(&'exprs [E]),
1294 impl<'tcx, 'exprs, E: AsCoercionSite> CoerceMany<'tcx, 'exprs, E> {
1295 /// The usual case; collect the set of expressions dynamically.
1296 /// If the full set of coercion sites is known before hand,
1297 /// consider `with_coercion_sites()` instead to avoid allocation.
1298 pub fn new(expected_ty: Ty<'tcx>) -> Self {
1299 Self::make(expected_ty, Expressions::Dynamic(vec![]))
1302 /// As an optimization, you can create a `CoerceMany` with a
1303 /// pre-existing slice of expressions. In this case, you are
1304 /// expected to pass each element in the slice to `coerce(...)` in
1305 /// order. This is used with arrays in particular to avoid
1306 /// needlessly cloning the slice.
1307 pub fn with_coercion_sites(expected_ty: Ty<'tcx>, coercion_sites: &'exprs [E]) -> Self {
1308 Self::make(expected_ty, Expressions::UpFront(coercion_sites))
1311 fn make(expected_ty: Ty<'tcx>, expressions: Expressions<'tcx, 'exprs, E>) -> Self {
1312 CoerceMany { expected_ty, final_ty: None, expressions, pushed: 0 }
1315 /// Returns the "expected type" with which this coercion was
1316 /// constructed. This represents the "downward propagated" type
1317 /// that was given to us at the start of typing whatever construct
1318 /// we are typing (e.g., the match expression).
1320 /// Typically, this is used as the expected type when
1321 /// type-checking each of the alternative expressions whose types
1322 /// we are trying to merge.
1323 pub fn expected_ty(&self) -> Ty<'tcx> {
1327 /// Returns the current "merged type", representing our best-guess
1328 /// at the LUB of the expressions we've seen so far (if any). This
1329 /// isn't *final* until you call `self.complete()`, which will return
1330 /// the merged type.
1331 pub fn merged_ty(&self) -> Ty<'tcx> {
1332 self.final_ty.unwrap_or(self.expected_ty)
1335 /// Indicates that the value generated by `expression`, which is
1336 /// of type `expression_ty`, is one of the possibilities that we
1337 /// could coerce from. This will record `expression`, and later
1338 /// calls to `coerce` may come back and add adjustments and things
1342 fcx: &FnCtxt<'a, 'tcx>,
1343 cause: &ObligationCause<'tcx>,
1344 expression: &'tcx hir::Expr<'tcx>,
1345 expression_ty: Ty<'tcx>,
1347 self.coerce_inner(fcx, cause, Some(expression), expression_ty, None, false)
1350 /// Indicates that one of the inputs is a "forced unit". This
1351 /// occurs in a case like `if foo { ... };`, where the missing else
1352 /// generates a "forced unit". Another example is a `loop { break;
1353 /// }`, where the `break` has no argument expression. We treat
1354 /// these cases slightly differently for error-reporting
1355 /// purposes. Note that these tend to correspond to cases where
1356 /// the `()` expression is implicit in the source, and hence we do
1357 /// not take an expression argument.
1359 /// The `augment_error` gives you a chance to extend the error
1360 /// message, in case any results (e.g., we use this to suggest
1361 /// removing a `;`).
1362 pub fn coerce_forced_unit<'a>(
1364 fcx: &FnCtxt<'a, 'tcx>,
1365 cause: &ObligationCause<'tcx>,
1366 augment_error: &mut dyn FnMut(&mut Diagnostic),
1367 label_unit_as_expected: bool,
1374 Some(augment_error),
1375 label_unit_as_expected,
1379 /// The inner coercion "engine". If `expression` is `None`, this
1380 /// is a forced-unit case, and hence `expression_ty` must be
1382 #[instrument(skip(self, fcx, augment_error, label_expression_as_expected), level = "debug")]
1383 pub(crate) fn coerce_inner<'a>(
1385 fcx: &FnCtxt<'a, 'tcx>,
1386 cause: &ObligationCause<'tcx>,
1387 expression: Option<&'tcx hir::Expr<'tcx>>,
1388 mut expression_ty: Ty<'tcx>,
1389 augment_error: Option<&mut dyn FnMut(&mut Diagnostic)>,
1390 label_expression_as_expected: bool,
1392 // Incorporate whatever type inference information we have
1393 // until now; in principle we might also want to process
1394 // pending obligations, but doing so should only improve
1395 // compatibility (hopefully that is true) by helping us
1396 // uncover never types better.
1397 if expression_ty.is_ty_var() {
1398 expression_ty = fcx.infcx.shallow_resolve(expression_ty);
1401 // If we see any error types, just propagate that error
1403 if expression_ty.references_error() || self.merged_ty().references_error() {
1404 self.final_ty = Some(fcx.tcx.ty_error());
1408 // Handle the actual type unification etc.
1409 let result = if let Some(expression) = expression {
1410 if self.pushed == 0 {
1411 // Special-case the first expression we are coercing.
1412 // To be honest, I'm not entirely sure why we do this.
1413 // We don't allow two-phase borrows, see comment in try_find_coercion_lub for why
1419 Some(cause.clone()),
1422 match self.expressions {
1423 Expressions::Dynamic(ref exprs) => fcx.try_find_coercion_lub(
1430 Expressions::UpFront(ref coercion_sites) => fcx.try_find_coercion_lub(
1432 &coercion_sites[0..self.pushed],
1440 // this is a hack for cases where we default to `()` because
1441 // the expression etc has been omitted from the source. An
1442 // example is an `if let` without an else:
1444 // if let Some(x) = ... { }
1446 // we wind up with a second match arm that is like `_ =>
1447 // ()`. That is the case we are considering here. We take
1448 // a different path to get the right "expected, found"
1449 // message and so forth (and because we know that
1450 // `expression_ty` will be unit).
1452 // Another example is `break` with no argument expression.
1453 assert!(expression_ty.is_unit(), "if let hack without unit type");
1454 fcx.at(cause, fcx.param_env)
1455 .eq_exp(label_expression_as_expected, expression_ty, self.merged_ty())
1457 fcx.register_infer_ok_obligations(infer_ok);
1465 self.final_ty = Some(v);
1466 if let Some(e) = expression {
1467 match self.expressions {
1468 Expressions::Dynamic(ref mut buffer) => buffer.push(e),
1469 Expressions::UpFront(coercion_sites) => {
1470 // if the user gave us an array to validate, check that we got
1471 // the next expression in the list, as expected
1473 coercion_sites[self.pushed].as_coercion_site().hir_id,
1481 Err(coercion_error) => {
1482 let (expected, found) = if label_expression_as_expected {
1483 // In the case where this is a "forced unit", like
1484 // `break`, we want to call the `()` "expected"
1485 // since it is implied by the syntax.
1486 // (Note: not all force-units work this way.)"
1487 (expression_ty, self.final_ty.unwrap_or(self.expected_ty))
1489 // Otherwise, the "expected" type for error
1490 // reporting is the current unification type,
1491 // which is basically the LUB of the expressions
1492 // we've seen so far (combined with the expected
1494 (self.final_ty.unwrap_or(self.expected_ty), expression_ty)
1496 let (expected, found) = fcx.resolve_vars_if_possible((expected, found));
1499 let mut unsized_return = false;
1500 let mut visitor = CollectRetsVisitor { ret_exprs: vec![] };
1501 match *cause.code() {
1502 ObligationCauseCode::ReturnNoExpression => {
1503 err = struct_span_err!(
1507 "`return;` in a function whose return type is not `()`"
1509 err.span_label(cause.span, "return type is not `()`");
1511 ObligationCauseCode::BlockTailExpression(blk_id) => {
1512 let parent_id = fcx.tcx.hir().get_parent_node(blk_id);
1513 err = self.report_return_mismatched_types(
1517 coercion_error.clone(),
1523 if !fcx.tcx.features().unsized_locals {
1524 unsized_return = self.is_return_ty_unsized(fcx, blk_id);
1526 if let Some(expression) = expression
1527 && let hir::ExprKind::Loop(loop_blk, ..) = expression.kind {
1528 intravisit::walk_block(& mut visitor, loop_blk);
1531 ObligationCauseCode::ReturnValue(id) => {
1532 err = self.report_return_mismatched_types(
1536 coercion_error.clone(),
1542 if !fcx.tcx.features().unsized_locals {
1543 let id = fcx.tcx.hir().get_parent_node(id);
1544 unsized_return = self.is_return_ty_unsized(fcx, id);
1548 err = fcx.report_mismatched_types(
1552 coercion_error.clone(),
1557 if let Some(augment_error) = augment_error {
1558 augment_error(&mut err);
1561 let is_insufficiently_polymorphic =
1562 matches!(coercion_error, TypeError::RegionsInsufficientlyPolymorphic(..));
1564 if !is_insufficiently_polymorphic && let Some(expr) = expression {
1565 fcx.emit_coerce_suggestions(
1571 Some(coercion_error),
1575 if visitor.ret_exprs.len() > 0 && let Some(expr) = expression {
1576 self.note_unreachable_loop_return(&mut err, &expr, &visitor.ret_exprs);
1578 err.emit_unless(unsized_return);
1580 self.final_ty = Some(fcx.tcx.ty_error());
1584 fn note_unreachable_loop_return<'a>(
1586 err: &mut DiagnosticBuilder<'a, ErrorGuaranteed>,
1587 expr: &hir::Expr<'tcx>,
1588 ret_exprs: &Vec<&'tcx hir::Expr<'tcx>>,
1590 let hir::ExprKind::Loop(_, _, _, loop_span) = expr.kind else { return;};
1591 let mut span: MultiSpan = vec![loop_span].into();
1592 span.push_span_label(loop_span, "this might have zero elements to iterate on");
1593 const MAXITER: usize = 3;
1594 let iter = ret_exprs.iter().take(MAXITER);
1595 for ret_expr in iter {
1596 span.push_span_label(
1598 "if the loop doesn't execute, this value would never get returned",
1603 "the function expects a value to always be returned, but loops might run zero times",
1605 if MAXITER < ret_exprs.len() {
1607 "if the loop doesn't execute, {} other values would never get returned",
1608 ret_exprs.len() - MAXITER
1612 "return a value for the case when the loop has zero elements to iterate on, or \
1613 consider changing the return type to account for that possibility",
1617 fn report_return_mismatched_types<'a>(
1619 cause: &ObligationCause<'tcx>,
1622 ty_err: TypeError<'tcx>,
1623 fcx: &FnCtxt<'a, 'tcx>,
1625 expression: Option<&'tcx hir::Expr<'tcx>>,
1626 blk_id: Option<hir::HirId>,
1627 ) -> DiagnosticBuilder<'a, ErrorGuaranteed> {
1628 let mut err = fcx.report_mismatched_types(cause, expected, found, ty_err);
1630 let mut pointing_at_return_type = false;
1631 let mut fn_output = None;
1633 let parent_id = fcx.tcx.hir().get_parent_node(id);
1634 let parent = fcx.tcx.hir().get(parent_id);
1635 if let Some(expr) = expression
1636 && let hir::Node::Expr(hir::Expr { kind: hir::ExprKind::Closure(&hir::Closure { body, .. }), .. }) = parent
1637 && !matches!(fcx.tcx.hir().body(body).value.kind, hir::ExprKind::Block(..))
1639 fcx.suggest_missing_semicolon(&mut err, expr, expected, true);
1641 // Verify that this is a tail expression of a function, otherwise the
1642 // label pointing out the cause for the type coercion will be wrong
1643 // as prior return coercions would not be relevant (#57664).
1644 let fn_decl = if let (Some(expr), Some(blk_id)) = (expression, blk_id) {
1645 pointing_at_return_type =
1646 fcx.suggest_mismatched_types_on_tail(&mut err, expr, expected, found, blk_id);
1647 if let (Some(cond_expr), true, false) = (
1648 fcx.tcx.hir().get_if_cause(expr.hir_id),
1650 pointing_at_return_type,
1652 // If the block is from an external macro or try (`?`) desugaring, then
1653 // do not suggest adding a semicolon, because there's nowhere to put it.
1654 // See issues #81943 and #87051.
1656 cond_expr.span.desugaring_kind(),
1657 None | Some(DesugaringKind::WhileLoop)
1658 ) && !in_external_macro(fcx.tcx.sess, cond_expr.span)
1661 hir::ExprKind::Match(.., hir::MatchSource::TryDesugar)
1664 err.span_label(cond_expr.span, "expected this to be `()`");
1665 if expr.can_have_side_effects() {
1666 fcx.suggest_semicolon_at_end(cond_expr.span, &mut err);
1669 fcx.get_node_fn_decl(parent).map(|(fn_decl, _, is_main)| (fn_decl, is_main))
1671 fcx.get_fn_decl(parent_id)
1674 if let Some((fn_decl, can_suggest)) = fn_decl {
1675 if blk_id.is_none() {
1676 pointing_at_return_type |= fcx.suggest_missing_return_type(
1682 fcx.tcx.hir().local_def_id_to_hir_id(fcx.tcx.hir().get_parent_item(id)),
1685 if !pointing_at_return_type {
1686 fn_output = Some(&fn_decl.output); // `impl Trait` return type
1690 let parent_id = fcx.tcx.hir().get_parent_item(id);
1691 let parent_item = fcx.tcx.hir().get_by_def_id(parent_id);
1693 if let (Some(expr), Some(_), Some((fn_decl, _, _))) =
1694 (expression, blk_id, fcx.get_node_fn_decl(parent_item))
1696 fcx.suggest_missing_break_or_return_expr(
1703 fcx.tcx.hir().local_def_id_to_hir_id(parent_id),
1707 let ret_coercion_span = fcx.ret_coercion_span.get();
1709 if let Some(sp) = ret_coercion_span
1710 // If the closure has an explicit return type annotation, or if
1711 // the closure's return type has been inferred from outside
1712 // requirements (such as an Fn* trait bound), then a type error
1713 // may occur at the first return expression we see in the closure
1714 // (if it conflicts with the declared return type). Skip adding a
1715 // note in this case, since it would be incorrect.
1716 && !fcx.return_type_pre_known
1721 "return type inferred to be `{}` here",
1727 if let (Some(sp), Some(fn_output)) = (ret_coercion_span, fn_output) {
1728 self.add_impl_trait_explanation(&mut err, cause, fcx, expected, sp, fn_output);
1734 fn add_impl_trait_explanation<'a>(
1736 err: &mut Diagnostic,
1737 cause: &ObligationCause<'tcx>,
1738 fcx: &FnCtxt<'a, 'tcx>,
1741 fn_output: &hir::FnRetTy<'_>,
1743 let return_sp = fn_output.span();
1744 err.span_label(return_sp, "expected because this return type...");
1747 format!("...is found to be `{}` here", fcx.resolve_vars_with_obligations(expected)),
1749 let impl_trait_msg = "for information on `impl Trait`, see \
1750 <https://doc.rust-lang.org/book/ch10-02-traits.html\
1751 #returning-types-that-implement-traits>";
1752 let trait_obj_msg = "for information on trait objects, see \
1753 <https://doc.rust-lang.org/book/ch17-02-trait-objects.html\
1754 #using-trait-objects-that-allow-for-values-of-different-types>";
1755 err.note("to return `impl Trait`, all returned values must be of the same type");
1756 err.note(impl_trait_msg);
1761 .span_to_snippet(return_sp)
1762 .unwrap_or_else(|_| "dyn Trait".to_string());
1763 let mut snippet_iter = snippet.split_whitespace();
1764 let has_impl = snippet_iter.next().map_or(false, |s| s == "impl");
1765 // Only suggest `Box<dyn Trait>` if `Trait` in `impl Trait` is object safe.
1766 let mut is_object_safe = false;
1767 if let hir::FnRetTy::Return(ty) = fn_output
1768 // Get the return type.
1769 && let hir::TyKind::OpaqueDef(..) = ty.kind
1771 let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty);
1772 // Get the `impl Trait`'s `DefId`.
1773 if let ty::Opaque(def_id, _) = ty.kind()
1774 // Get the `impl Trait`'s `Item` so that we can get its trait bounds and
1775 // get the `Trait`'s `DefId`.
1776 && let hir::ItemKind::OpaqueTy(hir::OpaqueTy { bounds, .. }) =
1777 fcx.tcx.hir().expect_item(def_id.expect_local()).kind
1779 // Are of this `impl Trait`'s traits object safe?
1780 is_object_safe = bounds.iter().all(|bound| {
1783 .and_then(|t| t.trait_def_id())
1784 .map_or(false, |def_id| {
1785 fcx.tcx.object_safety_violations(def_id).is_empty()
1792 err.multipart_suggestion(
1793 "you could change the return type to be a boxed trait object",
1795 (return_sp.with_hi(return_sp.lo() + BytePos(4)), "Box<dyn".to_string()),
1796 (return_sp.shrink_to_hi(), ">".to_string()),
1798 Applicability::MachineApplicable,
1800 let sugg = [sp, cause.span]
1804 (sp.shrink_to_lo(), "Box::new(".to_string()),
1805 (sp.shrink_to_hi(), ")".to_string()),
1809 .collect::<Vec<_>>();
1810 err.multipart_suggestion(
1811 "if you change the return type to expect trait objects, box the returned \
1814 Applicability::MaybeIncorrect,
1818 "if the trait `{}` were object safe, you could return a boxed trait object",
1822 err.note(trait_obj_msg);
1824 err.help("you could instead create a new `enum` with a variant for each returned type");
1827 fn is_return_ty_unsized<'a>(&self, fcx: &FnCtxt<'a, 'tcx>, blk_id: hir::HirId) -> bool {
1828 if let Some((fn_decl, _)) = fcx.get_fn_decl(blk_id)
1829 && let hir::FnRetTy::Return(ty) = fn_decl.output
1830 && let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty)
1831 && let ty::Dynamic(..) = ty.kind()
1838 pub fn complete<'a>(self, fcx: &FnCtxt<'a, 'tcx>) -> Ty<'tcx> {
1839 if let Some(final_ty) = self.final_ty {
1842 // If we only had inputs that were of type `!` (or no
1843 // inputs at all), then the final type is `!`.
1844 assert_eq!(self.pushed, 0);
1850 /// Something that can be converted into an expression to which we can
1851 /// apply a coercion.
1852 pub trait AsCoercionSite {
1853 fn as_coercion_site(&self) -> &hir::Expr<'_>;
1856 impl AsCoercionSite for hir::Expr<'_> {
1857 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1862 impl<'a, T> AsCoercionSite for &'a T
1866 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1867 (**self).as_coercion_site()
1871 impl AsCoercionSite for ! {
1872 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1877 impl AsCoercionSite for hir::Arm<'_> {
1878 fn as_coercion_site(&self) -> &hir::Expr<'_> {