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;
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::{self, ObligationCause, ObligationCauseCode, ObligationCtxt};
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 if from_mutbl >= to_mutbl { Ok(()) } else { Err(TypeError::Mutability) }
114 /// Do not require any adjustments, i.e. coerce `x -> x`.
115 fn identity(_: Ty<'_>) -> Vec<Adjustment<'_>> {
119 fn simple<'tcx>(kind: Adjust<'tcx>) -> impl FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>> {
120 move |target| vec![Adjustment { kind, target }]
123 /// This always returns `Ok(...)`.
125 adj: Vec<Adjustment<'tcx>>,
127 obligations: traits::PredicateObligations<'tcx>,
128 ) -> CoerceResult<'tcx> {
129 Ok(InferOk { value: (adj, target), obligations })
132 impl<'f, 'tcx> Coerce<'f, 'tcx> {
134 fcx: &'f FnCtxt<'f, 'tcx>,
135 cause: ObligationCause<'tcx>,
136 allow_two_phase: AllowTwoPhase,
138 Coerce { fcx, cause, allow_two_phase, use_lub: false }
141 fn unify(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> InferResult<'tcx, Ty<'tcx>> {
142 debug!("unify(a: {:?}, b: {:?}, use_lub: {})", a, b, self.use_lub);
143 self.commit_if_ok(|_| {
145 self.at(&self.cause, self.fcx.param_env).lub(b, a)
147 self.at(&self.cause, self.fcx.param_env)
149 .map(|InferOk { value: (), obligations }| InferOk { value: a, obligations })
154 /// Unify two types (using sub or lub) and produce a specific coercion.
155 fn unify_and<F>(&self, a: Ty<'tcx>, b: Ty<'tcx>, f: F) -> CoerceResult<'tcx>
157 F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
160 .and_then(|InferOk { value: ty, obligations }| success(f(ty), ty, obligations))
163 #[instrument(skip(self))]
164 fn coerce(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
165 // First, remove any resolved type variables (at the top level, at least):
166 let a = self.shallow_resolve(a);
167 let b = self.shallow_resolve(b);
168 debug!("Coerce.tys({:?} => {:?})", a, b);
170 // Just ignore error types.
171 if a.references_error() || b.references_error() {
172 return success(vec![], self.fcx.tcx.ty_error(), vec![]);
175 // Coercing from `!` to any type is allowed:
177 return success(simple(Adjust::NeverToAny)(b), b, vec![]);
180 // Coercing *from* an unresolved inference variable means that
181 // we have no information about the source type. This will always
182 // ultimately fall back to some form of subtyping.
184 return self.coerce_from_inference_variable(a, b, identity);
187 // Consider coercing the subtype to a DST
189 // NOTE: this is wrapped in a `commit_if_ok` because it creates
190 // a "spurious" type variable, and we don't want to have that
191 // type variable in memory if the coercion fails.
192 let unsize = self.commit_if_ok(|_| self.coerce_unsized(a, b));
195 debug!("coerce: unsize successful");
199 debug!(?error, "coerce: unsize failed");
203 // Examine the supertype and consider auto-borrowing.
205 ty::RawPtr(mt_b) => {
206 return self.coerce_unsafe_ptr(a, b, mt_b.mutbl);
208 ty::Ref(r_b, _, mutbl_b) => {
209 return self.coerce_borrowed_pointer(a, b, r_b, mutbl_b);
211 ty::Dynamic(predicates, region, ty::DynStar) if self.tcx.features().dyn_star => {
212 return self.coerce_dyn_star(a, b, predicates, region);
219 // Function items are coercible to any closure
220 // type; function pointers are not (that would
221 // require double indirection).
222 // Additionally, we permit coercion of function
223 // items to drop the unsafe qualifier.
224 self.coerce_from_fn_item(a, b)
227 // We permit coercion of fn pointers to drop the
229 self.coerce_from_fn_pointer(a, a_f, b)
231 ty::Closure(closure_def_id_a, substs_a) => {
232 // Non-capturing closures are coercible to
233 // function pointers or unsafe function pointers.
234 // It cannot convert closures that require unsafe.
235 self.coerce_closure_to_fn(a, closure_def_id_a, substs_a, b)
238 // Otherwise, just use unification rules.
239 self.unify_and(a, b, identity)
244 /// Coercing *from* an inference variable. In this case, we have no information
245 /// about the source type, so we can't really do a true coercion and we always
246 /// fall back to subtyping (`unify_and`).
247 fn coerce_from_inference_variable(
251 make_adjustments: impl FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
252 ) -> CoerceResult<'tcx> {
253 debug!("coerce_from_inference_variable(a={:?}, b={:?})", a, b);
254 assert!(a.is_ty_var() && self.shallow_resolve(a) == a);
255 assert!(self.shallow_resolve(b) == b);
258 // Two unresolved type variables: create a `Coerce` predicate.
259 let target_ty = if self.use_lub {
260 self.next_ty_var(TypeVariableOrigin {
261 kind: TypeVariableOriginKind::LatticeVariable,
262 span: self.cause.span,
268 let mut obligations = Vec::with_capacity(2);
269 for &source_ty in &[a, b] {
270 if source_ty != target_ty {
271 obligations.push(Obligation::new(
275 ty::Binder::dummy(ty::PredicateKind::Coerce(ty::CoercePredicate {
284 "coerce_from_inference_variable: two inference variables, target_ty={:?}, obligations={:?}",
285 target_ty, obligations
287 let adjustments = make_adjustments(target_ty);
288 InferResult::Ok(InferOk { value: (adjustments, target_ty), obligations })
290 // One unresolved type variable: just apply subtyping, we may be able
291 // to do something useful.
292 self.unify_and(a, b, make_adjustments)
296 /// Reborrows `&mut A` to `&mut B` and `&(mut) A` to `&B`.
297 /// To match `A` with `B`, autoderef will be performed,
298 /// calling `deref`/`deref_mut` where necessary.
299 fn coerce_borrowed_pointer(
303 r_b: ty::Region<'tcx>,
304 mutbl_b: hir::Mutability,
305 ) -> CoerceResult<'tcx> {
306 debug!("coerce_borrowed_pointer(a={:?}, b={:?})", a, b);
308 // If we have a parameter of type `&M T_a` and the value
309 // provided is `expr`, we will be adding an implicit borrow,
310 // meaning that we convert `f(expr)` to `f(&M *expr)`. Therefore,
311 // to type check, we will construct the type that `&M*expr` would
314 let (r_a, mt_a) = match *a.kind() {
315 ty::Ref(r_a, ty, mutbl) => {
316 let mt_a = ty::TypeAndMut { ty, mutbl };
317 coerce_mutbls(mt_a.mutbl, mutbl_b)?;
320 _ => return self.unify_and(a, b, identity),
323 let span = self.cause.span;
325 let mut first_error = None;
326 let mut r_borrow_var = None;
327 let mut autoderef = self.autoderef(span, a);
328 let mut found = None;
330 for (referent_ty, autoderefs) in autoderef.by_ref() {
332 // Don't let this pass, otherwise it would cause
333 // &T to autoref to &&T.
337 // At this point, we have deref'd `a` to `referent_ty`. So
338 // imagine we are coercing from `&'a mut Vec<T>` to `&'b mut [T]`.
339 // In the autoderef loop for `&'a mut Vec<T>`, we would get
342 // - `&'a mut Vec<T>` -- 0 derefs, just ignore it
343 // - `Vec<T>` -- 1 deref
344 // - `[T]` -- 2 deref
346 // At each point after the first callback, we want to
347 // check to see whether this would match out target type
348 // (`&'b mut [T]`) if we autoref'd it. We can't just
349 // compare the referent types, though, because we still
350 // have to consider the mutability. E.g., in the case
351 // we've been considering, we have an `&mut` reference, so
352 // the `T` in `[T]` needs to be unified with equality.
354 // Therefore, we construct reference types reflecting what
355 // the types will be after we do the final auto-ref and
356 // compare those. Note that this means we use the target
357 // mutability [1], since it may be that we are coercing
358 // from `&mut T` to `&U`.
360 // One fine point concerns the region that we use. We
361 // choose the region such that the region of the final
362 // type that results from `unify` will be the region we
363 // want for the autoref:
365 // - if in sub mode, that means we want to use `'b` (the
366 // region from the target reference) for both
367 // pointers [2]. This is because sub mode (somewhat
368 // arbitrarily) returns the subtype region. In the case
369 // where we are coercing to a target type, we know we
370 // want to use that target type region (`'b`) because --
371 // for the program to type-check -- it must be the
372 // smaller of the two.
373 // - One fine point. It may be surprising that we can
374 // use `'b` without relating `'a` and `'b`. The reason
375 // that this is ok is that what we produce is
376 // effectively a `&'b *x` expression (if you could
377 // annotate the region of a borrow), and regionck has
378 // code that adds edges from the region of a borrow
379 // (`'b`, here) into the regions in the borrowed
380 // expression (`*x`, here). (Search for "link".)
381 // - if in lub mode, things can get fairly complicated. The
382 // easiest thing is just to make a fresh
383 // region variable [4], which effectively means we defer
384 // the decision to region inference (and regionck, which will add
385 // some more edges to this variable). However, this can wind up
386 // creating a crippling number of variables in some cases --
387 // e.g., #32278 -- so we optimize one particular case [3].
388 // Let me try to explain with some examples:
389 // - The "running example" above represents the simple case,
390 // where we have one `&` reference at the outer level and
391 // ownership all the rest of the way down. In this case,
392 // we want `LUB('a, 'b)` as the resulting region.
393 // - However, if there are nested borrows, that region is
394 // too strong. Consider a coercion from `&'a &'x Rc<T>` to
395 // `&'b T`. In this case, `'a` is actually irrelevant.
396 // The pointer we want is `LUB('x, 'b`). If we choose `LUB('a,'b)`
397 // we get spurious errors (`ui/regions-lub-ref-ref-rc.rs`).
398 // (The errors actually show up in borrowck, typically, because
399 // this extra edge causes the region `'a` to be inferred to something
400 // too big, which then results in borrowck errors.)
401 // - We could track the innermost shared reference, but there is already
402 // code in regionck that has the job of creating links between
403 // the region of a borrow and the regions in the thing being
404 // borrowed (here, `'a` and `'x`), and it knows how to handle
405 // all the various cases. So instead we just make a region variable
406 // and let regionck figure it out.
407 let r = if !self.use_lub {
409 } else if autoderefs == 1 {
412 if r_borrow_var.is_none() {
413 // create var lazily, at most once
414 let coercion = Coercion(span);
415 let r = self.next_region_var(coercion);
416 r_borrow_var = Some(r); // [4] above
418 r_borrow_var.unwrap()
420 let derefd_ty_a = self.tcx.mk_ref(
424 mutbl: mutbl_b, // [1] above
427 match self.unify(derefd_ty_a, b) {
433 if first_error.is_none() {
434 first_error = Some(err);
440 // Extract type or return an error. We return the first error
441 // we got, which should be from relating the "base" type
442 // (e.g., in example above, the failure from relating `Vec<T>`
443 // to the target type), since that should be the least
445 let Some(InferOk { value: ty, mut obligations }) = found else {
446 let err = first_error.expect("coerce_borrowed_pointer had no error");
447 debug!("coerce_borrowed_pointer: failed with err = {:?}", err);
451 if ty == a && mt_a.mutbl.is_not() && autoderef.step_count() == 1 {
452 // As a special case, if we would produce `&'a *x`, that's
453 // a total no-op. We end up with the type `&'a T` just as
454 // we started with. In that case, just skip it
455 // altogether. This is just an optimization.
457 // Note that for `&mut`, we DO want to reborrow --
458 // otherwise, this would be a move, which might be an
459 // error. For example `foo(self.x)` where `self` and
460 // `self.x` both have `&mut `type would be a move of
461 // `self.x`, but we auto-coerce it to `foo(&mut *self.x)`,
462 // which is a borrow.
463 assert!(mutbl_b.is_not()); // can only coerce &T -> &U
464 return success(vec![], ty, obligations);
467 let InferOk { value: mut adjustments, obligations: o } =
468 self.adjust_steps_as_infer_ok(&autoderef);
469 obligations.extend(o);
470 obligations.extend(autoderef.into_obligations());
472 // Now apply the autoref. We have to extract the region out of
473 // the final ref type we got.
474 let ty::Ref(r_borrow, _, _) = ty.kind() else {
475 span_bug!(span, "expected a ref type, got {:?}", ty);
477 let mutbl = AutoBorrowMutability::new(mutbl_b, self.allow_two_phase);
478 adjustments.push(Adjustment {
479 kind: Adjust::Borrow(AutoBorrow::Ref(*r_borrow, mutbl)),
483 debug!("coerce_borrowed_pointer: succeeded ty={:?} adjustments={:?}", ty, adjustments);
485 success(adjustments, ty, obligations)
488 // &[T; n] or &mut [T; n] -> &[T]
489 // or &mut [T; n] -> &mut [T]
490 // or &Concrete -> &Trait, etc.
491 #[instrument(skip(self), level = "debug")]
492 fn coerce_unsized(&self, mut source: Ty<'tcx>, mut target: Ty<'tcx>) -> CoerceResult<'tcx> {
493 source = self.shallow_resolve(source);
494 target = self.shallow_resolve(target);
495 debug!(?source, ?target);
497 // We don't apply any coercions incase either the source or target
498 // aren't sufficiently well known but tend to instead just equate
500 if source.is_ty_var() {
501 debug!("coerce_unsized: source is a TyVar, bailing out");
502 return Err(TypeError::Mismatch);
504 if target.is_ty_var() {
505 debug!("coerce_unsized: target is a TyVar, bailing out");
506 return Err(TypeError::Mismatch);
510 (self.tcx.lang_items().unsize_trait(), self.tcx.lang_items().coerce_unsized_trait());
511 let (Some(unsize_did), Some(coerce_unsized_did)) = traits else {
512 debug!("missing Unsize or CoerceUnsized traits");
513 return Err(TypeError::Mismatch);
516 // Note, we want to avoid unnecessary unsizing. We don't want to coerce to
517 // a DST unless we have to. This currently comes out in the wash since
518 // we can't unify [T] with U. But to properly support DST, we need to allow
519 // that, at which point we will need extra checks on the target here.
521 // Handle reborrows before selecting `Source: CoerceUnsized<Target>`.
522 let reborrow = match (source.kind(), target.kind()) {
523 (&ty::Ref(_, ty_a, mutbl_a), &ty::Ref(_, _, mutbl_b)) => {
524 coerce_mutbls(mutbl_a, mutbl_b)?;
526 let coercion = Coercion(self.cause.span);
527 let r_borrow = self.next_region_var(coercion);
529 // We don't allow two-phase borrows here, at least for initial
530 // implementation. If it happens that this coercion is a function argument,
531 // the reborrow in coerce_borrowed_ptr will pick it up.
532 let mutbl = AutoBorrowMutability::new(mutbl_b, AllowTwoPhase::No);
535 Adjustment { kind: Adjust::Deref(None), target: ty_a },
537 kind: Adjust::Borrow(AutoBorrow::Ref(r_borrow, mutbl)),
540 .mk_ref(r_borrow, ty::TypeAndMut { mutbl: mutbl_b, ty: ty_a }),
544 (&ty::Ref(_, ty_a, mt_a), &ty::RawPtr(ty::TypeAndMut { mutbl: mt_b, .. })) => {
545 coerce_mutbls(mt_a, mt_b)?;
548 Adjustment { kind: Adjust::Deref(None), target: ty_a },
550 kind: Adjust::Borrow(AutoBorrow::RawPtr(mt_b)),
551 target: self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mt_b, ty: ty_a }),
557 let coerce_source = reborrow.as_ref().map_or(source, |(_, r)| r.target);
559 // Setup either a subtyping or a LUB relationship between
560 // the `CoerceUnsized` target type and the expected type.
561 // We only have the latter, so we use an inference variable
562 // for the former and let type inference do the rest.
563 let origin = TypeVariableOrigin {
564 kind: TypeVariableOriginKind::MiscVariable,
565 span: self.cause.span,
567 let coerce_target = self.next_ty_var(origin);
568 let mut coercion = self.unify_and(coerce_target, target, |target| {
569 let unsize = Adjustment { kind: Adjust::Pointer(PointerCast::Unsize), target };
571 None => vec![unsize],
572 Some((ref deref, ref autoref)) => vec![deref.clone(), autoref.clone(), unsize],
576 let mut selcx = traits::SelectionContext::new(self);
578 // Create an obligation for `Source: CoerceUnsized<Target>`.
579 let cause = ObligationCause::new(
582 ObligationCauseCode::Coercion { source, target },
585 // Use a FIFO queue for this custom fulfillment procedure.
587 // A Vec (or SmallVec) is not a natural choice for a queue. However,
588 // this code path is hot, and this queue usually has a max length of 1
589 // and almost never more than 3. By using a SmallVec we avoid an
590 // allocation, at the (very small) cost of (occasionally) having to
591 // shift subsequent elements down when removing the front element.
592 let mut queue: SmallVec<[_; 4]> = smallvec![traits::predicate_for_trait_def(
598 [coerce_source, coerce_target]
601 let mut has_unsized_tuple_coercion = false;
602 let mut has_trait_upcasting_coercion = None;
604 // Keep resolving `CoerceUnsized` and `Unsize` predicates to avoid
605 // emitting a coercion in cases like `Foo<$1>` -> `Foo<$2>`, where
606 // inference might unify those two inner type variables later.
607 let traits = [coerce_unsized_did, unsize_did];
608 while !queue.is_empty() {
609 let obligation = queue.remove(0);
610 debug!("coerce_unsized resolve step: {:?}", obligation);
611 let bound_predicate = obligation.predicate.kind();
612 let trait_pred = match bound_predicate.skip_binder() {
613 ty::PredicateKind::Clause(ty::Clause::Trait(trait_pred))
614 if traits.contains(&trait_pred.def_id()) =>
616 if unsize_did == trait_pred.def_id() {
617 let self_ty = trait_pred.self_ty();
618 let unsize_ty = trait_pred.trait_ref.substs[1].expect_ty();
619 if let (ty::Dynamic(ref data_a, ..), ty::Dynamic(ref data_b, ..)) =
620 (self_ty.kind(), unsize_ty.kind())
621 && data_a.principal_def_id() != data_b.principal_def_id()
623 debug!("coerce_unsized: found trait upcasting coercion");
624 has_trait_upcasting_coercion = Some((self_ty, unsize_ty));
626 if let ty::Tuple(..) = unsize_ty.kind() {
627 debug!("coerce_unsized: found unsized tuple coercion");
628 has_unsized_tuple_coercion = true;
631 bound_predicate.rebind(trait_pred)
634 coercion.obligations.push(obligation);
638 match selcx.select(&obligation.with(selcx.tcx(), trait_pred)) {
639 // Uncertain or unimplemented.
641 if trait_pred.def_id() == unsize_did {
642 let trait_pred = self.resolve_vars_if_possible(trait_pred);
643 let self_ty = trait_pred.skip_binder().self_ty();
644 let unsize_ty = trait_pred.skip_binder().trait_ref.substs[1].expect_ty();
645 debug!("coerce_unsized: ambiguous unsize case for {:?}", trait_pred);
646 match (&self_ty.kind(), &unsize_ty.kind()) {
647 (ty::Infer(ty::TyVar(v)), ty::Dynamic(..))
648 if self.type_var_is_sized(*v) =>
650 debug!("coerce_unsized: have sized infer {:?}", v);
651 coercion.obligations.push(obligation);
652 // `$0: Unsize<dyn Trait>` where we know that `$0: Sized`, try going
656 // Some other case for `$0: Unsize<Something>`. Note that we
657 // hit this case even if `Something` is a sized type, so just
658 // don't do the coercion.
659 debug!("coerce_unsized: ambiguous unsize");
660 return Err(TypeError::Mismatch);
664 debug!("coerce_unsized: early return - ambiguous");
665 return Err(TypeError::Mismatch);
668 Err(traits::Unimplemented) => {
669 debug!("coerce_unsized: early return - can't prove obligation");
670 return Err(TypeError::Mismatch);
673 // Object safety violations or miscellaneous.
675 self.err_ctxt().report_selection_error(obligation.clone(), &obligation, &err);
676 // Treat this like an obligation and follow through
677 // with the unsizing - the lack of a coercion should
678 // be silent, as it causes a type mismatch later.
681 Ok(Some(impl_source)) => queue.extend(impl_source.nested_obligations()),
685 if has_unsized_tuple_coercion && !self.tcx.features().unsized_tuple_coercion {
687 &self.tcx.sess.parse_sess,
688 sym::unsized_tuple_coercion,
690 "unsized tuple coercion is not stable enough for use and is subject to change",
695 if let Some((sub, sup)) = has_trait_upcasting_coercion
696 && !self.tcx().features().trait_upcasting
698 // Renders better when we erase regions, since they're not really the point here.
699 let (sub, sup) = self.tcx.erase_regions((sub, sup));
700 let mut err = feature_err(
701 &self.tcx.sess.parse_sess,
702 sym::trait_upcasting,
704 &format!("cannot cast `{sub}` to `{sup}`, trait upcasting coercion is experimental"),
706 err.note(&format!("required when coercing `{source}` into `{target}`"));
717 predicates: &'tcx ty::List<ty::PolyExistentialPredicate<'tcx>>,
718 b_region: ty::Region<'tcx>,
719 ) -> CoerceResult<'tcx> {
720 if !self.tcx.features().dyn_star {
721 return Err(TypeError::Mismatch);
724 if let ty::Dynamic(a_data, _, _) = a.kind()
725 && let ty::Dynamic(b_data, _, _) = b.kind()
726 && a_data.principal_def_id() == b_data.principal_def_id()
728 return self.unify_and(a, b, |_| vec![]);
731 // Check the obligations of the cast -- for example, when casting
732 // `usize` to `dyn* Clone + 'static`:
733 let mut obligations: Vec<_> = predicates
736 // For each existential predicate (e.g., `?Self: Clone`) substitute
737 // the type of the expression (e.g., `usize` in our example above)
738 // and then require that the resulting predicate (e.g., `usize: Clone`)
740 let predicate = predicate.with_self_ty(self.tcx, a);
741 Obligation::new(self.tcx, self.cause.clone(), self.param_env, predicate)
744 // Enforce the region bound (e.g., `usize: 'static`, in our example).
749 ty::Binder::dummy(ty::PredicateKind::Clause(ty::Clause::TypeOutlives(
750 ty::OutlivesPredicate(a, b_region),
756 // Enforce that the type is `usize`/pointer-sized.
757 obligations.push(Obligation::new(
762 self.tcx.at(self.cause.span).mk_trait_ref(hir::LangItem::PointerSized, [a]),
767 value: (vec![Adjustment { kind: Adjust::DynStar, target: b }], b),
772 fn coerce_from_safe_fn<F, G>(
775 fn_ty_a: ty::PolyFnSig<'tcx>,
779 ) -> CoerceResult<'tcx>
781 F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
782 G: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
784 self.commit_if_ok(|snapshot| {
785 let result = if let ty::FnPtr(fn_ty_b) = b.kind()
786 && let (hir::Unsafety::Normal, hir::Unsafety::Unsafe) =
787 (fn_ty_a.unsafety(), fn_ty_b.unsafety())
789 let unsafe_a = self.tcx.safe_to_unsafe_fn_ty(fn_ty_a);
790 self.unify_and(unsafe_a, b, to_unsafe)
792 self.unify_and(a, b, normal)
795 // FIXME(#73154): This is a hack. Currently LUB can generate
796 // unsolvable constraints. Additionally, it returns `a`
797 // unconditionally, even when the "LUB" is `b`. In the future, we
798 // want the coerced type to be the actual supertype of these two,
799 // but for now, we want to just error to ensure we don't lock
800 // ourselves into a specific behavior with NLL.
801 self.leak_check(false, snapshot)?;
807 fn coerce_from_fn_pointer(
810 fn_ty_a: ty::PolyFnSig<'tcx>,
812 ) -> CoerceResult<'tcx> {
813 //! Attempts to coerce from the type of a Rust function item
814 //! into a closure or a `proc`.
817 let b = self.shallow_resolve(b);
818 debug!("coerce_from_fn_pointer(a={:?}, b={:?})", a, b);
820 self.coerce_from_safe_fn(
824 simple(Adjust::Pointer(PointerCast::UnsafeFnPointer)),
829 fn coerce_from_fn_item(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
830 //! Attempts to coerce from the type of a Rust function item
831 //! into a closure or a `proc`.
833 let b = self.shallow_resolve(b);
834 let InferOk { value: b, mut obligations } =
835 self.normalize_associated_types_in_as_infer_ok(self.cause.span, b);
836 debug!("coerce_from_fn_item(a={:?}, b={:?})", a, b);
839 ty::FnPtr(b_sig) => {
840 let a_sig = a.fn_sig(self.tcx);
841 if let ty::FnDef(def_id, _) = *a.kind() {
842 // Intrinsics are not coercible to function pointers
843 if self.tcx.is_intrinsic(def_id) {
844 return Err(TypeError::IntrinsicCast);
847 // Safe `#[target_feature]` functions are not assignable to safe fn pointers (RFC 2396).
849 if b_sig.unsafety() == hir::Unsafety::Normal
850 && !self.tcx.codegen_fn_attrs(def_id).target_features.is_empty()
852 return Err(TypeError::TargetFeatureCast(def_id));
856 let InferOk { value: a_sig, obligations: o1 } =
857 self.normalize_associated_types_in_as_infer_ok(self.cause.span, a_sig);
858 obligations.extend(o1);
860 let a_fn_pointer = self.tcx.mk_fn_ptr(a_sig);
861 let InferOk { value, obligations: o2 } = self.coerce_from_safe_fn(
868 kind: Adjust::Pointer(PointerCast::ReifyFnPointer),
869 target: a_fn_pointer,
872 kind: Adjust::Pointer(PointerCast::UnsafeFnPointer),
877 simple(Adjust::Pointer(PointerCast::ReifyFnPointer)),
880 obligations.extend(o2);
881 Ok(InferOk { value, obligations })
883 _ => self.unify_and(a, b, identity),
887 fn coerce_closure_to_fn(
890 closure_def_id_a: DefId,
891 substs_a: SubstsRef<'tcx>,
893 ) -> CoerceResult<'tcx> {
894 //! Attempts to coerce from the type of a non-capturing closure
895 //! into a function pointer.
898 let b = self.shallow_resolve(b);
901 // At this point we haven't done capture analysis, which means
902 // that the ClosureSubsts just contains an inference variable instead
903 // of tuple of captured types.
905 // All we care here is if any variable is being captured and not the exact paths,
906 // so we check `upvars_mentioned` for root variables being captured.
910 .upvars_mentioned(closure_def_id_a.expect_local())
911 .map_or(true, |u| u.is_empty()) =>
913 // We coerce the closure, which has fn type
914 // `extern "rust-call" fn((arg0,arg1,...)) -> _`
916 // `fn(arg0,arg1,...) -> _`
918 // `unsafe fn(arg0,arg1,...) -> _`
919 let closure_sig = substs_a.as_closure().sig();
920 let unsafety = fn_ty.unsafety();
922 self.tcx.mk_fn_ptr(self.tcx.signature_unclosure(closure_sig, unsafety));
923 debug!("coerce_closure_to_fn(a={:?}, b={:?}, pty={:?})", a, b, pointer_ty);
927 simple(Adjust::Pointer(PointerCast::ClosureFnPointer(unsafety))),
930 _ => self.unify_and(a, b, identity),
934 fn coerce_unsafe_ptr(
938 mutbl_b: hir::Mutability,
939 ) -> CoerceResult<'tcx> {
940 debug!("coerce_unsafe_ptr(a={:?}, b={:?})", a, b);
942 let (is_ref, mt_a) = match *a.kind() {
943 ty::Ref(_, ty, mutbl) => (true, ty::TypeAndMut { ty, mutbl }),
944 ty::RawPtr(mt) => (false, mt),
945 _ => return self.unify_and(a, b, identity),
947 coerce_mutbls(mt_a.mutbl, mutbl_b)?;
949 // Check that the types which they point at are compatible.
950 let a_unsafe = self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mutbl_b, ty: mt_a.ty });
951 // Although references and unsafe ptrs have the same
952 // representation, we still register an Adjust::DerefRef so that
953 // regionck knows that the region for `a` must be valid here.
955 self.unify_and(a_unsafe, b, |target| {
957 Adjustment { kind: Adjust::Deref(None), target: mt_a.ty },
958 Adjustment { kind: Adjust::Borrow(AutoBorrow::RawPtr(mutbl_b)), target },
961 } else if mt_a.mutbl != mutbl_b {
962 self.unify_and(a_unsafe, b, simple(Adjust::Pointer(PointerCast::MutToConstPointer)))
964 self.unify_and(a_unsafe, b, identity)
969 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
970 /// Attempt to coerce an expression to a type, and return the
971 /// adjusted type of the expression, if successful.
972 /// Adjustments are only recorded if the coercion succeeded.
973 /// The expressions *must not* have any pre-existing adjustments.
976 expr: &hir::Expr<'_>,
979 allow_two_phase: AllowTwoPhase,
980 cause: Option<ObligationCause<'tcx>>,
981 ) -> RelateResult<'tcx, Ty<'tcx>> {
982 let source = self.resolve_vars_with_obligations(expr_ty);
983 debug!("coercion::try({:?}: {:?} -> {:?})", expr, source, target);
986 cause.unwrap_or_else(|| self.cause(expr.span, ObligationCauseCode::ExprAssignable));
987 let coerce = Coerce::new(self, cause, allow_two_phase);
988 let ok = self.commit_if_ok(|_| coerce.coerce(source, target))?;
990 let (adjustments, _) = self.register_infer_ok_obligations(ok);
991 self.apply_adjustments(expr, adjustments);
992 Ok(if expr_ty.references_error() { self.tcx.ty_error() } else { target })
995 /// Same as `try_coerce()`, but without side-effects.
997 /// Returns false if the coercion creates any obligations that result in
999 pub fn can_coerce(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> bool {
1000 let source = self.resolve_vars_with_obligations(expr_ty);
1001 debug!("coercion::can_with_predicates({:?} -> {:?})", source, target);
1003 let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
1004 // We don't ever need two-phase here since we throw out the result of the coercion
1005 let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
1007 let Ok(ok) = coerce.coerce(source, target) else {
1010 let ocx = ObligationCtxt::new_in_snapshot(self);
1011 ocx.register_obligations(ok.obligations);
1012 ocx.select_where_possible().is_empty()
1016 /// Given a type and a target type, this function will calculate and return
1017 /// how many dereference steps needed to achieve `expr_ty <: target`. If
1018 /// it's not possible, return `None`.
1019 pub fn deref_steps(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> Option<usize> {
1020 let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
1021 // We don't ever need two-phase here since we throw out the result of the coercion
1022 let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
1024 .autoderef(rustc_span::DUMMY_SP, expr_ty)
1025 .find_map(|(ty, steps)| self.probe(|_| coerce.unify(ty, target)).ok().map(|_| steps))
1028 /// Given a type, this function will calculate and return the type given
1029 /// for `<Ty as Deref>::Target` only if `Ty` also implements `DerefMut`.
1031 /// This function is for diagnostics only, since it does not register
1032 /// trait or region sub-obligations. (presumably we could, but it's not
1033 /// particularly important for diagnostics...)
1034 pub fn deref_once_mutably_for_diagnostic(&self, expr_ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
1035 self.autoderef(rustc_span::DUMMY_SP, expr_ty).nth(1).and_then(|(deref_ty, _)| {
1037 .type_implements_trait(
1038 self.tcx.lang_items().deref_mut_trait()?,
1047 /// Given some expressions, their known unified type and another expression,
1048 /// tries to unify the types, potentially inserting coercions on any of the
1049 /// provided expressions and returns their LUB (aka "common supertype").
1051 /// This is really an internal helper. From outside the coercion
1052 /// module, you should instantiate a `CoerceMany` instance.
1053 fn try_find_coercion_lub<E>(
1055 cause: &ObligationCause<'tcx>,
1058 new: &hir::Expr<'_>,
1060 ) -> RelateResult<'tcx, Ty<'tcx>>
1064 let prev_ty = self.resolve_vars_with_obligations(prev_ty);
1065 let new_ty = self.resolve_vars_with_obligations(new_ty);
1067 "coercion::try_find_coercion_lub({:?}, {:?}, exprs={:?} exprs)",
1073 // The following check fixes #88097, where the compiler erroneously
1074 // attempted to coerce a closure type to itself via a function pointer.
1075 if prev_ty == new_ty {
1079 // Special-case that coercion alone cannot handle:
1080 // Function items or non-capturing closures of differing IDs or InternalSubsts.
1081 let (a_sig, b_sig) = {
1082 let is_capturing_closure = |ty: Ty<'tcx>| {
1083 if let &ty::Closure(closure_def_id, _substs) = ty.kind() {
1084 self.tcx.upvars_mentioned(closure_def_id.expect_local()).is_some()
1089 if is_capturing_closure(prev_ty) || is_capturing_closure(new_ty) {
1092 match (prev_ty.kind(), new_ty.kind()) {
1093 (ty::FnDef(..), ty::FnDef(..)) => {
1094 // Don't reify if the function types have a LUB, i.e., they
1095 // are the same function and their parameters have a LUB.
1097 .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1099 // We have a LUB of prev_ty and new_ty, just return it.
1100 Ok(ok) => return Ok(self.register_infer_ok_obligations(ok)),
1102 (Some(prev_ty.fn_sig(self.tcx)), Some(new_ty.fn_sig(self.tcx)))
1106 (ty::Closure(_, substs), ty::FnDef(..)) => {
1107 let b_sig = new_ty.fn_sig(self.tcx);
1110 .signature_unclosure(substs.as_closure().sig(), b_sig.unsafety());
1111 (Some(a_sig), Some(b_sig))
1113 (ty::FnDef(..), ty::Closure(_, substs)) => {
1114 let a_sig = prev_ty.fn_sig(self.tcx);
1117 .signature_unclosure(substs.as_closure().sig(), a_sig.unsafety());
1118 (Some(a_sig), Some(b_sig))
1120 (ty::Closure(_, substs_a), ty::Closure(_, substs_b)) => (
1121 Some(self.tcx.signature_unclosure(
1122 substs_a.as_closure().sig(),
1123 hir::Unsafety::Normal,
1125 Some(self.tcx.signature_unclosure(
1126 substs_b.as_closure().sig(),
1127 hir::Unsafety::Normal,
1134 if let (Some(a_sig), Some(b_sig)) = (a_sig, b_sig) {
1135 // Intrinsics are not coercible to function pointers.
1136 if a_sig.abi() == Abi::RustIntrinsic
1137 || a_sig.abi() == Abi::PlatformIntrinsic
1138 || b_sig.abi() == Abi::RustIntrinsic
1139 || b_sig.abi() == Abi::PlatformIntrinsic
1141 return Err(TypeError::IntrinsicCast);
1143 // The signature must match.
1144 let a_sig = self.normalize_associated_types_in(new.span, a_sig);
1145 let b_sig = self.normalize_associated_types_in(new.span, b_sig);
1147 .at(cause, self.param_env)
1148 .trace(prev_ty, new_ty)
1150 .map(|ok| self.register_infer_ok_obligations(ok))?;
1152 // Reify both sides and return the reified fn pointer type.
1153 let fn_ptr = self.tcx.mk_fn_ptr(sig);
1154 let prev_adjustment = match prev_ty.kind() {
1155 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(a_sig.unsafety())),
1156 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1157 _ => unreachable!(),
1159 let next_adjustment = match new_ty.kind() {
1160 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(b_sig.unsafety())),
1161 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1162 _ => unreachable!(),
1164 for expr in exprs.iter().map(|e| e.as_coercion_site()) {
1165 self.apply_adjustments(
1167 vec![Adjustment { kind: prev_adjustment.clone(), target: fn_ptr }],
1170 self.apply_adjustments(new, vec![Adjustment { kind: next_adjustment, target: fn_ptr }]);
1174 // Configure a Coerce instance to compute the LUB.
1175 // We don't allow two-phase borrows on any autorefs this creates since we
1176 // probably aren't processing function arguments here and even if we were,
1177 // they're going to get autorefed again anyway and we can apply 2-phase borrows
1179 let mut coerce = Coerce::new(self, cause.clone(), AllowTwoPhase::No);
1180 coerce.use_lub = true;
1182 // First try to coerce the new expression to the type of the previous ones,
1183 // but only if the new expression has no coercion already applied to it.
1184 let mut first_error = None;
1185 if !self.typeck_results.borrow().adjustments().contains_key(new.hir_id) {
1186 let result = self.commit_if_ok(|_| coerce.coerce(new_ty, prev_ty));
1189 let (adjustments, target) = self.register_infer_ok_obligations(ok);
1190 self.apply_adjustments(new, adjustments);
1192 "coercion::try_find_coercion_lub: was able to coerce from new type {:?} to previous type {:?} ({:?})",
1193 new_ty, prev_ty, target
1197 Err(e) => first_error = Some(e),
1201 // Then try to coerce the previous expressions to the type of the new one.
1202 // This requires ensuring there are no coercions applied to *any* of the
1203 // previous expressions, other than noop reborrows (ignoring lifetimes).
1205 let expr = expr.as_coercion_site();
1206 let noop = match self.typeck_results.borrow().expr_adjustments(expr) {
1208 Adjustment { kind: Adjust::Deref(_), .. },
1209 Adjustment { kind: Adjust::Borrow(AutoBorrow::Ref(_, mutbl_adj)), .. },
1211 match *self.node_ty(expr.hir_id).kind() {
1212 ty::Ref(_, _, mt_orig) => {
1213 let mutbl_adj: hir::Mutability = mutbl_adj.into();
1214 // Reborrow that we can safely ignore, because
1215 // the next adjustment can only be a Deref
1216 // which will be merged into it.
1217 mutbl_adj == mt_orig
1222 &[Adjustment { kind: Adjust::NeverToAny, .. }] | &[] => true,
1228 "coercion::try_find_coercion_lub: older expression {:?} had adjustments, requiring LUB",
1233 .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1234 .map(|ok| self.register_infer_ok_obligations(ok));
1238 match self.commit_if_ok(|_| coerce.coerce(prev_ty, new_ty)) {
1240 // Avoid giving strange errors on failed attempts.
1241 if let Some(e) = first_error {
1244 self.commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1245 .map(|ok| self.register_infer_ok_obligations(ok))
1249 let (adjustments, target) = self.register_infer_ok_obligations(ok);
1251 let expr = expr.as_coercion_site();
1252 self.apply_adjustments(expr, adjustments.clone());
1255 "coercion::try_find_coercion_lub: was able to coerce previous type {:?} to new type {:?} ({:?})",
1256 prev_ty, new_ty, target
1264 /// CoerceMany encapsulates the pattern you should use when you have
1265 /// many expressions that are all getting coerced to a common
1266 /// type. This arises, for example, when you have a match (the result
1267 /// of each arm is coerced to a common type). It also arises in less
1268 /// obvious places, such as when you have many `break foo` expressions
1269 /// that target the same loop, or the various `return` expressions in
1272 /// The basic protocol is as follows:
1274 /// - Instantiate the `CoerceMany` with an initial `expected_ty`.
1275 /// This will also serve as the "starting LUB". The expectation is
1276 /// that this type is something which all of the expressions *must*
1277 /// be coercible to. Use a fresh type variable if needed.
1278 /// - For each expression whose result is to be coerced, invoke `coerce()` with.
1279 /// - In some cases we wish to coerce "non-expressions" whose types are implicitly
1280 /// unit. This happens for example if you have a `break` with no expression,
1281 /// or an `if` with no `else`. In that case, invoke `coerce_forced_unit()`.
1282 /// - `coerce()` and `coerce_forced_unit()` may report errors. They hide this
1283 /// from you so that you don't have to worry your pretty head about it.
1284 /// But if an error is reported, the final type will be `err`.
1285 /// - Invoking `coerce()` may cause us to go and adjust the "adjustments" on
1286 /// previously coerced expressions.
1287 /// - When all done, invoke `complete()`. This will return the LUB of
1288 /// all your expressions.
1289 /// - WARNING: I don't believe this final type is guaranteed to be
1290 /// related to your initial `expected_ty` in any particular way,
1291 /// although it will typically be a subtype, so you should check it.
1292 /// - Invoking `complete()` may cause us to go and adjust the "adjustments" on
1293 /// previously coerced expressions.
1297 /// ```ignore (illustrative)
1298 /// let mut coerce = CoerceMany::new(expected_ty);
1299 /// for expr in exprs {
1300 /// let expr_ty = fcx.check_expr_with_expectation(expr, expected);
1301 /// coerce.coerce(fcx, &cause, expr, expr_ty);
1303 /// let final_ty = coerce.complete(fcx);
1305 pub struct CoerceMany<'tcx, 'exprs, E: AsCoercionSite> {
1306 expected_ty: Ty<'tcx>,
1307 final_ty: Option<Ty<'tcx>>,
1308 expressions: Expressions<'tcx, 'exprs, E>,
1312 /// The type of a `CoerceMany` that is storing up the expressions into
1313 /// a buffer. We use this in `check/mod.rs` for things like `break`.
1314 pub type DynamicCoerceMany<'tcx> = CoerceMany<'tcx, 'tcx, &'tcx hir::Expr<'tcx>>;
1316 enum Expressions<'tcx, 'exprs, E: AsCoercionSite> {
1317 Dynamic(Vec<&'tcx hir::Expr<'tcx>>),
1318 UpFront(&'exprs [E]),
1321 impl<'tcx, 'exprs, E: AsCoercionSite> CoerceMany<'tcx, 'exprs, E> {
1322 /// The usual case; collect the set of expressions dynamically.
1323 /// If the full set of coercion sites is known before hand,
1324 /// consider `with_coercion_sites()` instead to avoid allocation.
1325 pub fn new(expected_ty: Ty<'tcx>) -> Self {
1326 Self::make(expected_ty, Expressions::Dynamic(vec![]))
1329 /// As an optimization, you can create a `CoerceMany` with a
1330 /// pre-existing slice of expressions. In this case, you are
1331 /// expected to pass each element in the slice to `coerce(...)` in
1332 /// order. This is used with arrays in particular to avoid
1333 /// needlessly cloning the slice.
1334 pub fn with_coercion_sites(expected_ty: Ty<'tcx>, coercion_sites: &'exprs [E]) -> Self {
1335 Self::make(expected_ty, Expressions::UpFront(coercion_sites))
1338 fn make(expected_ty: Ty<'tcx>, expressions: Expressions<'tcx, 'exprs, E>) -> Self {
1339 CoerceMany { expected_ty, final_ty: None, expressions, pushed: 0 }
1342 /// Returns the "expected type" with which this coercion was
1343 /// constructed. This represents the "downward propagated" type
1344 /// that was given to us at the start of typing whatever construct
1345 /// we are typing (e.g., the match expression).
1347 /// Typically, this is used as the expected type when
1348 /// type-checking each of the alternative expressions whose types
1349 /// we are trying to merge.
1350 pub fn expected_ty(&self) -> Ty<'tcx> {
1354 /// Returns the current "merged type", representing our best-guess
1355 /// at the LUB of the expressions we've seen so far (if any). This
1356 /// isn't *final* until you call `self.complete()`, which will return
1357 /// the merged type.
1358 pub fn merged_ty(&self) -> Ty<'tcx> {
1359 self.final_ty.unwrap_or(self.expected_ty)
1362 /// Indicates that the value generated by `expression`, which is
1363 /// of type `expression_ty`, is one of the possibilities that we
1364 /// could coerce from. This will record `expression`, and later
1365 /// calls to `coerce` may come back and add adjustments and things
1369 fcx: &FnCtxt<'a, 'tcx>,
1370 cause: &ObligationCause<'tcx>,
1371 expression: &'tcx hir::Expr<'tcx>,
1372 expression_ty: Ty<'tcx>,
1374 self.coerce_inner(fcx, cause, Some(expression), expression_ty, None, false)
1377 /// Indicates that one of the inputs is a "forced unit". This
1378 /// occurs in a case like `if foo { ... };`, where the missing else
1379 /// generates a "forced unit". Another example is a `loop { break;
1380 /// }`, where the `break` has no argument expression. We treat
1381 /// these cases slightly differently for error-reporting
1382 /// purposes. Note that these tend to correspond to cases where
1383 /// the `()` expression is implicit in the source, and hence we do
1384 /// not take an expression argument.
1386 /// The `augment_error` gives you a chance to extend the error
1387 /// message, in case any results (e.g., we use this to suggest
1388 /// removing a `;`).
1389 pub fn coerce_forced_unit<'a>(
1391 fcx: &FnCtxt<'a, 'tcx>,
1392 cause: &ObligationCause<'tcx>,
1393 augment_error: &mut dyn FnMut(&mut Diagnostic),
1394 label_unit_as_expected: bool,
1401 Some(augment_error),
1402 label_unit_as_expected,
1406 /// The inner coercion "engine". If `expression` is `None`, this
1407 /// is a forced-unit case, and hence `expression_ty` must be
1409 #[instrument(skip(self, fcx, augment_error, label_expression_as_expected), level = "debug")]
1410 pub(crate) fn coerce_inner<'a>(
1412 fcx: &FnCtxt<'a, 'tcx>,
1413 cause: &ObligationCause<'tcx>,
1414 expression: Option<&'tcx hir::Expr<'tcx>>,
1415 mut expression_ty: Ty<'tcx>,
1416 augment_error: Option<&mut dyn FnMut(&mut Diagnostic)>,
1417 label_expression_as_expected: bool,
1419 // Incorporate whatever type inference information we have
1420 // until now; in principle we might also want to process
1421 // pending obligations, but doing so should only improve
1422 // compatibility (hopefully that is true) by helping us
1423 // uncover never types better.
1424 if expression_ty.is_ty_var() {
1425 expression_ty = fcx.infcx.shallow_resolve(expression_ty);
1428 // If we see any error types, just propagate that error
1430 if expression_ty.references_error() || self.merged_ty().references_error() {
1431 self.final_ty = Some(fcx.tcx.ty_error());
1435 // Handle the actual type unification etc.
1436 let result = if let Some(expression) = expression {
1437 if self.pushed == 0 {
1438 // Special-case the first expression we are coercing.
1439 // To be honest, I'm not entirely sure why we do this.
1440 // We don't allow two-phase borrows, see comment in try_find_coercion_lub for why
1446 Some(cause.clone()),
1449 match self.expressions {
1450 Expressions::Dynamic(ref exprs) => fcx.try_find_coercion_lub(
1457 Expressions::UpFront(ref coercion_sites) => fcx.try_find_coercion_lub(
1459 &coercion_sites[0..self.pushed],
1467 // this is a hack for cases where we default to `()` because
1468 // the expression etc has been omitted from the source. An
1469 // example is an `if let` without an else:
1471 // if let Some(x) = ... { }
1473 // we wind up with a second match arm that is like `_ =>
1474 // ()`. That is the case we are considering here. We take
1475 // a different path to get the right "expected, found"
1476 // message and so forth (and because we know that
1477 // `expression_ty` will be unit).
1479 // Another example is `break` with no argument expression.
1480 assert!(expression_ty.is_unit(), "if let hack without unit type");
1481 fcx.at(cause, fcx.param_env)
1482 .eq_exp(label_expression_as_expected, expression_ty, self.merged_ty())
1484 fcx.register_infer_ok_obligations(infer_ok);
1492 self.final_ty = Some(v);
1493 if let Some(e) = expression {
1494 match self.expressions {
1495 Expressions::Dynamic(ref mut buffer) => buffer.push(e),
1496 Expressions::UpFront(coercion_sites) => {
1497 // if the user gave us an array to validate, check that we got
1498 // the next expression in the list, as expected
1500 coercion_sites[self.pushed].as_coercion_site().hir_id,
1508 Err(coercion_error) => {
1509 // Mark that we've failed to coerce the types here to suppress
1510 // any superfluous errors we might encounter while trying to
1511 // emit or provide suggestions on how to fix the initial error.
1512 fcx.set_tainted_by_errors(
1513 fcx.tcx.sess.delay_span_bug(cause.span, "coercion error but no error emitted"),
1515 let (expected, found) = if label_expression_as_expected {
1516 // In the case where this is a "forced unit", like
1517 // `break`, we want to call the `()` "expected"
1518 // since it is implied by the syntax.
1519 // (Note: not all force-units work this way.)"
1520 (expression_ty, self.merged_ty())
1522 // Otherwise, the "expected" type for error
1523 // reporting is the current unification type,
1524 // which is basically the LUB of the expressions
1525 // we've seen so far (combined with the expected
1527 (self.merged_ty(), expression_ty)
1529 let (expected, found) = fcx.resolve_vars_if_possible((expected, found));
1532 let mut unsized_return = false;
1533 let mut visitor = CollectRetsVisitor { ret_exprs: vec![] };
1534 match *cause.code() {
1535 ObligationCauseCode::ReturnNoExpression => {
1536 err = struct_span_err!(
1540 "`return;` in a function whose return type is not `()`"
1542 err.span_label(cause.span, "return type is not `()`");
1544 ObligationCauseCode::BlockTailExpression(blk_id) => {
1545 let parent_id = fcx.tcx.hir().get_parent_node(blk_id);
1546 err = self.report_return_mismatched_types(
1550 coercion_error.clone(),
1556 if !fcx.tcx.features().unsized_locals {
1557 unsized_return = self.is_return_ty_unsized(fcx, blk_id);
1559 if let Some(expression) = expression
1560 && let hir::ExprKind::Loop(loop_blk, ..) = expression.kind {
1561 intravisit::walk_block(& mut visitor, loop_blk);
1564 ObligationCauseCode::ReturnValue(id) => {
1565 err = self.report_return_mismatched_types(
1569 coercion_error.clone(),
1575 if !fcx.tcx.features().unsized_locals {
1576 let id = fcx.tcx.hir().get_parent_node(id);
1577 unsized_return = self.is_return_ty_unsized(fcx, id);
1581 err = fcx.err_ctxt().report_mismatched_types(
1585 coercion_error.clone(),
1590 if let Some(augment_error) = augment_error {
1591 augment_error(&mut err);
1594 let is_insufficiently_polymorphic =
1595 matches!(coercion_error, TypeError::RegionsInsufficientlyPolymorphic(..));
1597 if !is_insufficiently_polymorphic && let Some(expr) = expression {
1598 fcx.emit_coerce_suggestions(
1604 Some(coercion_error),
1608 if visitor.ret_exprs.len() > 0 && let Some(expr) = expression {
1609 self.note_unreachable_loop_return(&mut err, &expr, &visitor.ret_exprs);
1611 let reported = err.emit_unless(unsized_return);
1613 self.final_ty = Some(fcx.tcx.ty_error_with_guaranteed(reported));
1617 fn note_unreachable_loop_return(
1619 err: &mut Diagnostic,
1620 expr: &hir::Expr<'tcx>,
1621 ret_exprs: &Vec<&'tcx hir::Expr<'tcx>>,
1623 let hir::ExprKind::Loop(_, _, _, loop_span) = expr.kind else { return;};
1624 let mut span: MultiSpan = vec![loop_span].into();
1625 span.push_span_label(loop_span, "this might have zero elements to iterate on");
1626 const MAXITER: usize = 3;
1627 let iter = ret_exprs.iter().take(MAXITER);
1628 for ret_expr in iter {
1629 span.push_span_label(
1631 "if the loop doesn't execute, this value would never get returned",
1636 "the function expects a value to always be returned, but loops might run zero times",
1638 if MAXITER < ret_exprs.len() {
1640 "if the loop doesn't execute, {} other values would never get returned",
1641 ret_exprs.len() - MAXITER
1645 "return a value for the case when the loop has zero elements to iterate on, or \
1646 consider changing the return type to account for that possibility",
1650 fn report_return_mismatched_types<'a>(
1652 cause: &ObligationCause<'tcx>,
1655 ty_err: TypeError<'tcx>,
1656 fcx: &FnCtxt<'a, 'tcx>,
1658 expression: Option<&'tcx hir::Expr<'tcx>>,
1659 blk_id: Option<hir::HirId>,
1660 ) -> DiagnosticBuilder<'a, ErrorGuaranteed> {
1661 let mut err = fcx.err_ctxt().report_mismatched_types(cause, expected, found, ty_err);
1663 let mut pointing_at_return_type = false;
1664 let mut fn_output = None;
1666 let parent_id = fcx.tcx.hir().get_parent_node(id);
1667 let parent = fcx.tcx.hir().get(parent_id);
1668 if let Some(expr) = expression
1669 && let hir::Node::Expr(hir::Expr { kind: hir::ExprKind::Closure(&hir::Closure { body, .. }), .. }) = parent
1670 && !matches!(fcx.tcx.hir().body(body).value.kind, hir::ExprKind::Block(..))
1672 fcx.suggest_missing_semicolon(&mut err, expr, expected, true);
1674 // Verify that this is a tail expression of a function, otherwise the
1675 // label pointing out the cause for the type coercion will be wrong
1676 // as prior return coercions would not be relevant (#57664).
1677 let fn_decl = if let (Some(expr), Some(blk_id)) = (expression, blk_id) {
1678 pointing_at_return_type =
1679 fcx.suggest_mismatched_types_on_tail(&mut err, expr, expected, found, blk_id);
1680 if let (Some(cond_expr), true, false) = (
1681 fcx.tcx.hir().get_if_cause(expr.hir_id),
1683 pointing_at_return_type,
1685 // If the block is from an external macro or try (`?`) desugaring, then
1686 // do not suggest adding a semicolon, because there's nowhere to put it.
1687 // See issues #81943 and #87051.
1689 cond_expr.span.desugaring_kind(),
1690 None | Some(DesugaringKind::WhileLoop)
1691 ) && !in_external_macro(fcx.tcx.sess, cond_expr.span)
1694 hir::ExprKind::Match(.., hir::MatchSource::TryDesugar)
1697 err.span_label(cond_expr.span, "expected this to be `()`");
1698 if expr.can_have_side_effects() {
1699 fcx.suggest_semicolon_at_end(cond_expr.span, &mut err);
1702 fcx.get_node_fn_decl(parent).map(|(fn_decl, _, is_main)| (fn_decl, is_main))
1704 fcx.get_fn_decl(parent_id)
1707 if let Some((fn_decl, can_suggest)) = fn_decl {
1708 if blk_id.is_none() {
1709 pointing_at_return_type |= fcx.suggest_missing_return_type(
1715 fcx.tcx.hir().get_parent_item(id).into(),
1718 if !pointing_at_return_type {
1719 fn_output = Some(&fn_decl.output); // `impl Trait` return type
1723 let parent_id = fcx.tcx.hir().get_parent_item(id);
1724 let parent_item = fcx.tcx.hir().get_by_def_id(parent_id.def_id);
1726 if let (Some(expr), Some(_), Some((fn_decl, _, _))) =
1727 (expression, blk_id, fcx.get_node_fn_decl(parent_item))
1729 fcx.suggest_missing_break_or_return_expr(
1740 let ret_coercion_span = fcx.ret_coercion_span.get();
1742 if let Some(sp) = ret_coercion_span
1743 // If the closure has an explicit return type annotation, or if
1744 // the closure's return type has been inferred from outside
1745 // requirements (such as an Fn* trait bound), then a type error
1746 // may occur at the first return expression we see in the closure
1747 // (if it conflicts with the declared return type). Skip adding a
1748 // note in this case, since it would be incorrect.
1749 && let Some(fn_sig) = fcx.body_fn_sig()
1750 && fn_sig.output().is_ty_var()
1755 "return type inferred to be `{}` here",
1761 if let (Some(sp), Some(fn_output)) = (ret_coercion_span, fn_output) {
1762 self.add_impl_trait_explanation(&mut err, cause, fcx, expected, sp, fn_output);
1768 fn add_impl_trait_explanation<'a>(
1770 err: &mut Diagnostic,
1771 cause: &ObligationCause<'tcx>,
1772 fcx: &FnCtxt<'a, 'tcx>,
1775 fn_output: &hir::FnRetTy<'_>,
1777 let return_sp = fn_output.span();
1778 err.span_label(return_sp, "expected because this return type...");
1781 format!("...is found to be `{}` here", fcx.resolve_vars_with_obligations(expected)),
1783 let impl_trait_msg = "for information on `impl Trait`, see \
1784 <https://doc.rust-lang.org/book/ch10-02-traits.html\
1785 #returning-types-that-implement-traits>";
1786 let trait_obj_msg = "for information on trait objects, see \
1787 <https://doc.rust-lang.org/book/ch17-02-trait-objects.html\
1788 #using-trait-objects-that-allow-for-values-of-different-types>";
1789 err.note("to return `impl Trait`, all returned values must be of the same type");
1790 err.note(impl_trait_msg);
1795 .span_to_snippet(return_sp)
1796 .unwrap_or_else(|_| "dyn Trait".to_string());
1797 let mut snippet_iter = snippet.split_whitespace();
1798 let has_impl = snippet_iter.next().map_or(false, |s| s == "impl");
1799 // Only suggest `Box<dyn Trait>` if `Trait` in `impl Trait` is object safe.
1800 let mut is_object_safe = false;
1801 if let hir::FnRetTy::Return(ty) = fn_output
1802 // Get the return type.
1803 && let hir::TyKind::OpaqueDef(..) = ty.kind
1805 let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty);
1806 // Get the `impl Trait`'s `DefId`.
1807 if let ty::Opaque(def_id, _) = ty.kind()
1808 // Get the `impl Trait`'s `Item` so that we can get its trait bounds and
1809 // get the `Trait`'s `DefId`.
1810 && let hir::ItemKind::OpaqueTy(hir::OpaqueTy { bounds, .. }) =
1811 fcx.tcx.hir().expect_item(def_id.expect_local()).kind
1813 // Are of this `impl Trait`'s traits object safe?
1814 is_object_safe = bounds.iter().all(|bound| {
1817 .and_then(|t| t.trait_def_id())
1818 .map_or(false, |def_id| {
1819 fcx.tcx.object_safety_violations(def_id).is_empty()
1826 err.multipart_suggestion(
1827 "you could change the return type to be a boxed trait object",
1829 (return_sp.with_hi(return_sp.lo() + BytePos(4)), "Box<dyn".to_string()),
1830 (return_sp.shrink_to_hi(), ">".to_string()),
1832 Applicability::MachineApplicable,
1834 let sugg = [sp, cause.span]
1838 (sp.shrink_to_lo(), "Box::new(".to_string()),
1839 (sp.shrink_to_hi(), ")".to_string()),
1843 .collect::<Vec<_>>();
1844 err.multipart_suggestion(
1845 "if you change the return type to expect trait objects, box the returned \
1848 Applicability::MaybeIncorrect,
1852 "if the trait `{}` were object safe, you could return a boxed trait object",
1856 err.note(trait_obj_msg);
1858 err.help("you could instead create a new `enum` with a variant for each returned type");
1861 fn is_return_ty_unsized<'a>(&self, fcx: &FnCtxt<'a, 'tcx>, blk_id: hir::HirId) -> bool {
1862 if let Some((fn_decl, _)) = fcx.get_fn_decl(blk_id)
1863 && let hir::FnRetTy::Return(ty) = fn_decl.output
1864 && let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty)
1865 && let ty::Dynamic(..) = ty.kind()
1872 pub fn complete<'a>(self, fcx: &FnCtxt<'a, 'tcx>) -> Ty<'tcx> {
1873 if let Some(final_ty) = self.final_ty {
1876 // If we only had inputs that were of type `!` (or no
1877 // inputs at all), then the final type is `!`.
1878 assert_eq!(self.pushed, 0);
1884 /// Something that can be converted into an expression to which we can
1885 /// apply a coercion.
1886 pub trait AsCoercionSite {
1887 fn as_coercion_site(&self) -> &hir::Expr<'_>;
1890 impl AsCoercionSite for hir::Expr<'_> {
1891 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1896 impl<'a, T> AsCoercionSite for &'a T
1900 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1901 (**self).as_coercion_site()
1905 impl AsCoercionSite for ! {
1906 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1911 impl AsCoercionSite for hir::Arm<'_> {
1912 fn as_coercion_site(&self) -> &hir::Expr<'_> {