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 infering the generic arguments of functions, the argument
22 //! order is relevant, which can lead to the following edge case:
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;
40 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder};
42 use rustc_hir::def_id::DefId;
43 use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
44 use rustc_infer::infer::{Coercion, InferOk, InferResult};
45 use rustc_middle::lint::in_external_macro;
46 use rustc_middle::ty::adjustment::{
47 Adjust, Adjustment, AllowTwoPhase, AutoBorrow, AutoBorrowMutability, PointerCast,
49 use rustc_middle::ty::error::TypeError;
50 use rustc_middle::ty::fold::TypeFoldable;
51 use rustc_middle::ty::relate::RelateResult;
52 use rustc_middle::ty::subst::SubstsRef;
53 use rustc_middle::ty::{self, Ty, TypeAndMut};
54 use rustc_session::parse::feature_err;
55 use rustc_span::symbol::sym;
56 use rustc_span::{self, BytePos, Span};
57 use rustc_target::spec::abi::Abi;
58 use rustc_trait_selection::traits::error_reporting::InferCtxtExt;
59 use rustc_trait_selection::traits::{self, ObligationCause, ObligationCauseCode};
61 use smallvec::{smallvec, SmallVec};
64 struct Coerce<'a, 'tcx> {
65 fcx: &'a FnCtxt<'a, 'tcx>,
66 cause: ObligationCause<'tcx>,
68 /// Determines whether or not allow_two_phase_borrow is set on any
69 /// autoref adjustments we create while coercing. We don't want to
70 /// allow deref coercions to create two-phase borrows, at least initially,
71 /// but we do need two-phase borrows for function argument reborrows.
72 /// See #47489 and #48598
73 /// See docs on the "AllowTwoPhase" type for a more detailed discussion
74 allow_two_phase: AllowTwoPhase,
77 impl<'a, 'tcx> Deref for Coerce<'a, 'tcx> {
78 type Target = FnCtxt<'a, 'tcx>;
79 fn deref(&self) -> &Self::Target {
84 type CoerceResult<'tcx> = InferResult<'tcx, (Vec<Adjustment<'tcx>>, Ty<'tcx>)>;
86 /// Coercing a mutable reference to an immutable works, while
87 /// coercing `&T` to `&mut T` should be forbidden.
88 fn coerce_mutbls<'tcx>(
89 from_mutbl: hir::Mutability,
90 to_mutbl: hir::Mutability,
91 ) -> RelateResult<'tcx, ()> {
92 match (from_mutbl, to_mutbl) {
93 (hir::Mutability::Mut, hir::Mutability::Mut | hir::Mutability::Not)
94 | (hir::Mutability::Not, hir::Mutability::Not) => Ok(()),
95 (hir::Mutability::Not, hir::Mutability::Mut) => Err(TypeError::Mutability),
99 /// Do not require any adjustments, i.e. coerce `x -> x`.
100 fn identity(_: Ty<'_>) -> Vec<Adjustment<'_>> {
104 fn simple(kind: Adjust<'tcx>) -> impl FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>> {
105 move |target| vec![Adjustment { kind, target }]
108 /// This always returns `Ok(...)`.
110 adj: Vec<Adjustment<'tcx>>,
112 obligations: traits::PredicateObligations<'tcx>,
113 ) -> CoerceResult<'tcx> {
114 Ok(InferOk { value: (adj, target), obligations })
117 impl<'f, 'tcx> Coerce<'f, 'tcx> {
119 fcx: &'f FnCtxt<'f, 'tcx>,
120 cause: ObligationCause<'tcx>,
121 allow_two_phase: AllowTwoPhase,
123 Coerce { fcx, cause, allow_two_phase, use_lub: false }
126 fn unify(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> InferResult<'tcx, Ty<'tcx>> {
127 debug!("unify(a: {:?}, b: {:?}, use_lub: {})", a, b, self.use_lub);
128 self.commit_if_ok(|_| {
130 self.at(&self.cause, self.fcx.param_env).lub(b, a)
132 self.at(&self.cause, self.fcx.param_env)
134 .map(|InferOk { value: (), obligations }| InferOk { value: a, obligations })
139 /// Unify two types (using sub or lub) and produce a specific coercion.
140 fn unify_and<F>(&self, a: Ty<'tcx>, b: Ty<'tcx>, f: F) -> CoerceResult<'tcx>
142 F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
145 .and_then(|InferOk { value: ty, obligations }| success(f(ty), ty, obligations))
148 fn coerce(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
149 let a = self.shallow_resolve(a);
150 debug!("Coerce.tys({:?} => {:?})", a, b);
152 // Just ignore error types.
153 if a.references_error() || b.references_error() {
154 return success(vec![], self.fcx.tcx.ty_error(), vec![]);
158 // Subtle: If we are coercing from `!` to `?T`, where `?T` is an unbound
159 // type variable, we want `?T` to fallback to `!` if not
160 // otherwise constrained. An example where this arises:
162 // let _: Option<?T> = Some({ return; });
164 // here, we would coerce from `!` to `?T`.
165 let b = self.shallow_resolve(b);
166 return if self.shallow_resolve(b).is_ty_var() {
167 // Micro-optimization: no need for this if `b` is
168 // already resolved in some way.
169 let diverging_ty = self.next_diverging_ty_var(TypeVariableOrigin {
170 kind: TypeVariableOriginKind::AdjustmentType,
171 span: self.cause.span,
173 self.unify_and(&b, &diverging_ty, simple(Adjust::NeverToAny))
175 success(simple(Adjust::NeverToAny)(b), b, vec![])
179 // Consider coercing the subtype to a DST
181 // NOTE: this is wrapped in a `commit_if_ok` because it creates
182 // a "spurious" type variable, and we don't want to have that
183 // type variable in memory if the coercion fails.
184 let unsize = self.commit_if_ok(|_| self.coerce_unsized(a, b));
187 debug!("coerce: unsize successful");
190 Err(TypeError::ObjectUnsafeCoercion(did)) => {
191 debug!("coerce: unsize not object safe");
192 return Err(TypeError::ObjectUnsafeCoercion(did));
196 debug!("coerce: unsize failed");
198 // Examine the supertype and consider auto-borrowing.
200 // Note: does not attempt to resolve type variables we encounter.
201 // See above for details.
203 ty::RawPtr(mt_b) => {
204 return self.coerce_unsafe_ptr(a, b, mt_b.mutbl);
206 ty::Ref(r_b, _, mutbl_b) => {
207 return self.coerce_borrowed_pointer(a, b, r_b, mutbl_b);
214 // Function items are coercible to any closure
215 // type; function pointers are not (that would
216 // require double indirection).
217 // Additionally, we permit coercion of function
218 // items to drop the unsafe qualifier.
219 self.coerce_from_fn_item(a, b)
222 // We permit coercion of fn pointers to drop the
224 self.coerce_from_fn_pointer(a, a_f, b)
226 ty::Closure(closure_def_id_a, substs_a) => {
227 // Non-capturing closures are coercible to
228 // function pointers or unsafe function pointers.
229 // It cannot convert closures that require unsafe.
230 self.coerce_closure_to_fn(a, closure_def_id_a, substs_a, b)
233 // Otherwise, just use unification rules.
234 self.unify_and(a, b, identity)
239 /// Reborrows `&mut A` to `&mut B` and `&(mut) A` to `&B`.
240 /// To match `A` with `B`, autoderef will be performed,
241 /// calling `deref`/`deref_mut` where necessary.
242 fn coerce_borrowed_pointer(
246 r_b: ty::Region<'tcx>,
247 mutbl_b: hir::Mutability,
248 ) -> CoerceResult<'tcx> {
249 debug!("coerce_borrowed_pointer(a={:?}, b={:?})", a, b);
251 // If we have a parameter of type `&M T_a` and the value
252 // provided is `expr`, we will be adding an implicit borrow,
253 // meaning that we convert `f(expr)` to `f(&M *expr)`. Therefore,
254 // to type check, we will construct the type that `&M*expr` would
257 let (r_a, mt_a) = match *a.kind() {
258 ty::Ref(r_a, ty, mutbl) => {
259 let mt_a = ty::TypeAndMut { ty, mutbl };
260 coerce_mutbls(mt_a.mutbl, mutbl_b)?;
263 _ => return self.unify_and(a, b, identity),
266 let span = self.cause.span;
268 let mut first_error = None;
269 let mut r_borrow_var = None;
270 let mut autoderef = self.autoderef(span, a);
271 let mut found = None;
273 for (referent_ty, autoderefs) in autoderef.by_ref() {
275 // Don't let this pass, otherwise it would cause
276 // &T to autoref to &&T.
280 // At this point, we have deref'd `a` to `referent_ty`. So
281 // imagine we are coercing from `&'a mut Vec<T>` to `&'b mut [T]`.
282 // In the autoderef loop for `&'a mut Vec<T>`, we would get
285 // - `&'a mut Vec<T>` -- 0 derefs, just ignore it
286 // - `Vec<T>` -- 1 deref
287 // - `[T]` -- 2 deref
289 // At each point after the first callback, we want to
290 // check to see whether this would match out target type
291 // (`&'b mut [T]`) if we autoref'd it. We can't just
292 // compare the referent types, though, because we still
293 // have to consider the mutability. E.g., in the case
294 // we've been considering, we have an `&mut` reference, so
295 // the `T` in `[T]` needs to be unified with equality.
297 // Therefore, we construct reference types reflecting what
298 // the types will be after we do the final auto-ref and
299 // compare those. Note that this means we use the target
300 // mutability [1], since it may be that we are coercing
301 // from `&mut T` to `&U`.
303 // One fine point concerns the region that we use. We
304 // choose the region such that the region of the final
305 // type that results from `unify` will be the region we
306 // want for the autoref:
308 // - if in sub mode, that means we want to use `'b` (the
309 // region from the target reference) for both
310 // pointers [2]. This is because sub mode (somewhat
311 // arbitrarily) returns the subtype region. In the case
312 // where we are coercing to a target type, we know we
313 // want to use that target type region (`'b`) because --
314 // for the program to type-check -- it must be the
315 // smaller of the two.
316 // - One fine point. It may be surprising that we can
317 // use `'b` without relating `'a` and `'b`. The reason
318 // that this is ok is that what we produce is
319 // effectively a `&'b *x` expression (if you could
320 // annotate the region of a borrow), and regionck has
321 // code that adds edges from the region of a borrow
322 // (`'b`, here) into the regions in the borrowed
323 // expression (`*x`, here). (Search for "link".)
324 // - if in lub mode, things can get fairly complicated. The
325 // easiest thing is just to make a fresh
326 // region variable [4], which effectively means we defer
327 // the decision to region inference (and regionck, which will add
328 // some more edges to this variable). However, this can wind up
329 // creating a crippling number of variables in some cases --
330 // e.g., #32278 -- so we optimize one particular case [3].
331 // Let me try to explain with some examples:
332 // - The "running example" above represents the simple case,
333 // where we have one `&` reference at the outer level and
334 // ownership all the rest of the way down. In this case,
335 // we want `LUB('a, 'b)` as the resulting region.
336 // - However, if there are nested borrows, that region is
337 // too strong. Consider a coercion from `&'a &'x Rc<T>` to
338 // `&'b T`. In this case, `'a` is actually irrelevant.
339 // The pointer we want is `LUB('x, 'b`). If we choose `LUB('a,'b)`
340 // we get spurious errors (`ui/regions-lub-ref-ref-rc.rs`).
341 // (The errors actually show up in borrowck, typically, because
342 // this extra edge causes the region `'a` to be inferred to something
343 // too big, which then results in borrowck errors.)
344 // - We could track the innermost shared reference, but there is already
345 // code in regionck that has the job of creating links between
346 // the region of a borrow and the regions in the thing being
347 // borrowed (here, `'a` and `'x`), and it knows how to handle
348 // all the various cases. So instead we just make a region variable
349 // and let regionck figure it out.
350 let r = if !self.use_lub {
352 } else if autoderefs == 1 {
355 if r_borrow_var.is_none() {
356 // create var lazily, at most once
357 let coercion = Coercion(span);
358 let r = self.next_region_var(coercion);
359 r_borrow_var = Some(r); // [4] above
361 r_borrow_var.unwrap()
363 let derefd_ty_a = self.tcx.mk_ref(
367 mutbl: mutbl_b, // [1] above
370 match self.unify(derefd_ty_a, b) {
376 if first_error.is_none() {
377 first_error = Some(err);
383 // Extract type or return an error. We return the first error
384 // we got, which should be from relating the "base" type
385 // (e.g., in example above, the failure from relating `Vec<T>`
386 // to the target type), since that should be the least
388 let InferOk { value: ty, mut obligations } = match found {
391 let err = first_error.expect("coerce_borrowed_pointer had no error");
392 debug!("coerce_borrowed_pointer: failed with err = {:?}", err);
397 if ty == a && mt_a.mutbl == hir::Mutability::Not && autoderef.step_count() == 1 {
398 // As a special case, if we would produce `&'a *x`, that's
399 // a total no-op. We end up with the type `&'a T` just as
400 // we started with. In that case, just skip it
401 // altogether. This is just an optimization.
403 // Note that for `&mut`, we DO want to reborrow --
404 // otherwise, this would be a move, which might be an
405 // error. For example `foo(self.x)` where `self` and
406 // `self.x` both have `&mut `type would be a move of
407 // `self.x`, but we auto-coerce it to `foo(&mut *self.x)`,
408 // which is a borrow.
409 assert_eq!(mutbl_b, hir::Mutability::Not); // can only coerce &T -> &U
410 return success(vec![], ty, obligations);
413 let InferOk { value: mut adjustments, obligations: o } =
414 self.adjust_steps_as_infer_ok(&autoderef);
415 obligations.extend(o);
416 obligations.extend(autoderef.into_obligations());
418 // Now apply the autoref. We have to extract the region out of
419 // the final ref type we got.
420 let r_borrow = match ty.kind() {
421 ty::Ref(r_borrow, _, _) => r_borrow,
422 _ => span_bug!(span, "expected a ref type, got {:?}", ty),
424 let mutbl = match mutbl_b {
425 hir::Mutability::Not => AutoBorrowMutability::Not,
426 hir::Mutability::Mut => {
427 AutoBorrowMutability::Mut { allow_two_phase_borrow: self.allow_two_phase }
430 adjustments.push(Adjustment {
431 kind: Adjust::Borrow(AutoBorrow::Ref(r_borrow, mutbl)),
435 debug!("coerce_borrowed_pointer: succeeded ty={:?} adjustments={:?}", ty, adjustments);
437 success(adjustments, ty, obligations)
440 // &[T; n] or &mut [T; n] -> &[T]
441 // or &mut [T; n] -> &mut [T]
442 // or &Concrete -> &Trait, etc.
443 fn coerce_unsized(&self, mut source: Ty<'tcx>, mut target: Ty<'tcx>) -> CoerceResult<'tcx> {
444 debug!("coerce_unsized(source={:?}, target={:?})", source, target);
446 source = self.shallow_resolve(source);
447 target = self.shallow_resolve(target);
448 debug!("coerce_unsized: resolved source={:?} target={:?}", source, target);
450 // These 'if' statements require some explanation.
451 // The `CoerceUnsized` trait is special - it is only
452 // possible to write `impl CoerceUnsized<B> for A` where
453 // A and B have 'matching' fields. This rules out the following
454 // two types of blanket impls:
456 // `impl<T> CoerceUnsized<T> for SomeType`
457 // `impl<T> CoerceUnsized<SomeType> for T`
459 // Both of these trigger a special `CoerceUnsized`-related error (E0376)
461 // We can take advantage of this fact to avoid performing unnecessary work.
462 // If either `source` or `target` is a type variable, then any applicable impl
463 // would need to be generic over the self-type (`impl<T> CoerceUnsized<SomeType> for T`)
464 // or generic over the `CoerceUnsized` type parameter (`impl<T> CoerceUnsized<T> for
467 // However, these are exactly the kinds of impls which are forbidden by
468 // the compiler! Therefore, we can be sure that coercion will always fail
469 // when either the source or target type is a type variable. This allows us
470 // to skip performing any trait selection, and immediately bail out.
471 if source.is_ty_var() {
472 debug!("coerce_unsized: source is a TyVar, bailing out");
473 return Err(TypeError::Mismatch);
475 if target.is_ty_var() {
476 debug!("coerce_unsized: target is a TyVar, bailing out");
477 return Err(TypeError::Mismatch);
481 (self.tcx.lang_items().unsize_trait(), self.tcx.lang_items().coerce_unsized_trait());
482 let (unsize_did, coerce_unsized_did) = if let (Some(u), Some(cu)) = traits {
485 debug!("missing Unsize or CoerceUnsized traits");
486 return Err(TypeError::Mismatch);
489 // Note, we want to avoid unnecessary unsizing. We don't want to coerce to
490 // a DST unless we have to. This currently comes out in the wash since
491 // we can't unify [T] with U. But to properly support DST, we need to allow
492 // that, at which point we will need extra checks on the target here.
494 // Handle reborrows before selecting `Source: CoerceUnsized<Target>`.
495 let reborrow = match (source.kind(), target.kind()) {
496 (&ty::Ref(_, ty_a, mutbl_a), &ty::Ref(_, _, mutbl_b)) => {
497 coerce_mutbls(mutbl_a, mutbl_b)?;
499 let coercion = Coercion(self.cause.span);
500 let r_borrow = self.next_region_var(coercion);
501 let mutbl = match mutbl_b {
502 hir::Mutability::Not => AutoBorrowMutability::Not,
503 hir::Mutability::Mut => AutoBorrowMutability::Mut {
504 // We don't allow two-phase borrows here, at least for initial
505 // implementation. If it happens that this coercion is a function argument,
506 // the reborrow in coerce_borrowed_ptr will pick it up.
507 allow_two_phase_borrow: AllowTwoPhase::No,
511 Adjustment { kind: Adjust::Deref(None), target: ty_a },
513 kind: Adjust::Borrow(AutoBorrow::Ref(r_borrow, mutbl)),
516 .mk_ref(r_borrow, ty::TypeAndMut { mutbl: mutbl_b, ty: ty_a }),
520 (&ty::Ref(_, ty_a, mt_a), &ty::RawPtr(ty::TypeAndMut { mutbl: mt_b, .. })) => {
521 coerce_mutbls(mt_a, mt_b)?;
524 Adjustment { kind: Adjust::Deref(None), target: ty_a },
526 kind: Adjust::Borrow(AutoBorrow::RawPtr(mt_b)),
527 target: self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mt_b, ty: ty_a }),
533 let coerce_source = reborrow.as_ref().map_or(source, |&(_, ref r)| r.target);
535 // Setup either a subtyping or a LUB relationship between
536 // the `CoerceUnsized` target type and the expected type.
537 // We only have the latter, so we use an inference variable
538 // for the former and let type inference do the rest.
539 let origin = TypeVariableOrigin {
540 kind: TypeVariableOriginKind::MiscVariable,
541 span: self.cause.span,
543 let coerce_target = self.next_ty_var(origin);
544 let mut coercion = self.unify_and(coerce_target, target, |target| {
545 let unsize = Adjustment { kind: Adjust::Pointer(PointerCast::Unsize), target };
547 None => vec![unsize],
548 Some((ref deref, ref autoref)) => vec![deref.clone(), autoref.clone(), unsize],
552 let mut selcx = traits::SelectionContext::new(self);
554 // Create an obligation for `Source: CoerceUnsized<Target>`.
555 let cause = ObligationCause::new(
558 ObligationCauseCode::Coercion { source, target },
561 // Use a FIFO queue for this custom fulfillment procedure.
563 // A Vec (or SmallVec) is not a natural choice for a queue. However,
564 // this code path is hot, and this queue usually has a max length of 1
565 // and almost never more than 3. By using a SmallVec we avoid an
566 // allocation, at the (very small) cost of (occasionally) having to
567 // shift subsequent elements down when removing the front element.
568 let mut queue: SmallVec<[_; 4]> = smallvec![traits::predicate_for_trait_def(
575 &[coerce_target.into()]
578 let mut has_unsized_tuple_coercion = false;
580 // Keep resolving `CoerceUnsized` and `Unsize` predicates to avoid
581 // emitting a coercion in cases like `Foo<$1>` -> `Foo<$2>`, where
582 // inference might unify those two inner type variables later.
583 let traits = [coerce_unsized_did, unsize_did];
584 while !queue.is_empty() {
585 let obligation = queue.remove(0);
586 debug!("coerce_unsized resolve step: {:?}", obligation);
587 let bound_predicate = obligation.predicate.kind();
588 let trait_pred = match bound_predicate.skip_binder() {
589 ty::PredicateKind::Trait(trait_pred, _)
590 if traits.contains(&trait_pred.def_id()) =>
592 if unsize_did == trait_pred.def_id() {
593 let unsize_ty = trait_pred.trait_ref.substs[1].expect_ty();
594 if let ty::Tuple(..) = unsize_ty.kind() {
595 debug!("coerce_unsized: found unsized tuple coercion");
596 has_unsized_tuple_coercion = true;
599 bound_predicate.rebind(trait_pred)
602 coercion.obligations.push(obligation);
606 match selcx.select(&obligation.with(trait_pred)) {
607 // Uncertain or unimplemented.
609 if trait_pred.def_id() == unsize_did {
610 let trait_pred = self.resolve_vars_if_possible(trait_pred);
611 let self_ty = trait_pred.skip_binder().self_ty();
612 let unsize_ty = trait_pred.skip_binder().trait_ref.substs[1].expect_ty();
613 debug!("coerce_unsized: ambiguous unsize case for {:?}", trait_pred);
614 match (&self_ty.kind(), &unsize_ty.kind()) {
615 (ty::Infer(ty::TyVar(v)), ty::Dynamic(..))
616 if self.type_var_is_sized(*v) =>
618 debug!("coerce_unsized: have sized infer {:?}", v);
619 coercion.obligations.push(obligation);
620 // `$0: Unsize<dyn Trait>` where we know that `$0: Sized`, try going
624 // Some other case for `$0: Unsize<Something>`. Note that we
625 // hit this case even if `Something` is a sized type, so just
626 // don't do the coercion.
627 debug!("coerce_unsized: ambiguous unsize");
628 return Err(TypeError::Mismatch);
632 debug!("coerce_unsized: early return - ambiguous");
633 return Err(TypeError::Mismatch);
636 Err(traits::Unimplemented) => {
637 debug!("coerce_unsized: early return - can't prove obligation");
638 return Err(TypeError::Mismatch);
641 // Object safety violations or miscellaneous.
643 self.report_selection_error(&obligation, &err, false, false);
644 // Treat this like an obligation and follow through
645 // with the unsizing - the lack of a coercion should
646 // be silent, as it causes a type mismatch later.
649 Ok(Some(impl_source)) => queue.extend(impl_source.nested_obligations()),
653 if has_unsized_tuple_coercion && !self.tcx.features().unsized_tuple_coercion {
655 &self.tcx.sess.parse_sess,
656 sym::unsized_tuple_coercion,
658 "unsized tuple coercion is not stable enough for use and is subject to change",
666 fn coerce_from_safe_fn<F, G>(
669 fn_ty_a: ty::PolyFnSig<'tcx>,
673 ) -> CoerceResult<'tcx>
675 F: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
676 G: FnOnce(Ty<'tcx>) -> Vec<Adjustment<'tcx>>,
678 if let ty::FnPtr(fn_ty_b) = b.kind() {
679 if let (hir::Unsafety::Normal, hir::Unsafety::Unsafe) =
680 (fn_ty_a.unsafety(), fn_ty_b.unsafety())
682 let unsafe_a = self.tcx.safe_to_unsafe_fn_ty(fn_ty_a);
683 return self.unify_and(unsafe_a, b, to_unsafe);
686 self.unify_and(a, b, normal)
689 fn coerce_from_fn_pointer(
692 fn_ty_a: ty::PolyFnSig<'tcx>,
694 ) -> CoerceResult<'tcx> {
695 //! Attempts to coerce from the type of a Rust function item
696 //! into a closure or a `proc`.
699 let b = self.shallow_resolve(b);
700 debug!("coerce_from_fn_pointer(a={:?}, b={:?})", a, b);
702 self.coerce_from_safe_fn(
706 simple(Adjust::Pointer(PointerCast::UnsafeFnPointer)),
711 fn coerce_from_fn_item(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> CoerceResult<'tcx> {
712 //! Attempts to coerce from the type of a Rust function item
713 //! into a closure or a `proc`.
715 let b = self.shallow_resolve(b);
716 debug!("coerce_from_fn_item(a={:?}, b={:?})", a, b);
719 ty::FnPtr(b_sig) => {
720 let a_sig = a.fn_sig(self.tcx);
721 // Intrinsics are not coercible to function pointers
722 if a_sig.abi() == Abi::RustIntrinsic || a_sig.abi() == Abi::PlatformIntrinsic {
723 return Err(TypeError::IntrinsicCast);
726 // Safe `#[target_feature]` functions are not assignable to safe fn pointers (RFC 2396).
727 if let ty::FnDef(def_id, _) = *a.kind() {
728 if b_sig.unsafety() == hir::Unsafety::Normal
729 && !self.tcx.codegen_fn_attrs(def_id).target_features.is_empty()
731 return Err(TypeError::TargetFeatureCast(def_id));
735 let InferOk { value: a_sig, mut obligations } =
736 self.normalize_associated_types_in_as_infer_ok(self.cause.span, a_sig);
738 let a_fn_pointer = self.tcx.mk_fn_ptr(a_sig);
739 let InferOk { value, obligations: o2 } = self.coerce_from_safe_fn(
746 kind: Adjust::Pointer(PointerCast::ReifyFnPointer),
747 target: a_fn_pointer,
750 kind: Adjust::Pointer(PointerCast::UnsafeFnPointer),
755 simple(Adjust::Pointer(PointerCast::ReifyFnPointer)),
758 obligations.extend(o2);
759 Ok(InferOk { value, obligations })
761 _ => self.unify_and(a, b, identity),
765 fn coerce_closure_to_fn(
768 closure_def_id_a: DefId,
769 substs_a: SubstsRef<'tcx>,
771 ) -> CoerceResult<'tcx> {
772 //! Attempts to coerce from the type of a non-capturing closure
773 //! into a function pointer.
776 let b = self.shallow_resolve(b);
779 // At this point we haven't done capture analysis, which means
780 // that the ClosureSubsts just contains an inference variable instead
781 // of tuple of captured types.
783 // All we care here is if any variable is being captured and not the exact paths,
784 // so we check `upvars_mentioned` for root variables being captured.
788 .upvars_mentioned(closure_def_id_a.expect_local())
789 .map_or(true, |u| u.is_empty()) =>
791 // We coerce the closure, which has fn type
792 // `extern "rust-call" fn((arg0,arg1,...)) -> _`
794 // `fn(arg0,arg1,...) -> _`
796 // `unsafe fn(arg0,arg1,...) -> _`
797 let closure_sig = substs_a.as_closure().sig();
798 let unsafety = fn_ty.unsafety();
800 self.tcx.mk_fn_ptr(self.tcx.signature_unclosure(closure_sig, unsafety));
801 debug!("coerce_closure_to_fn(a={:?}, b={:?}, pty={:?})", a, b, pointer_ty);
805 simple(Adjust::Pointer(PointerCast::ClosureFnPointer(unsafety))),
808 _ => self.unify_and(a, b, identity),
812 fn coerce_unsafe_ptr(
816 mutbl_b: hir::Mutability,
817 ) -> CoerceResult<'tcx> {
818 debug!("coerce_unsafe_ptr(a={:?}, b={:?})", a, b);
820 let (is_ref, mt_a) = match *a.kind() {
821 ty::Ref(_, ty, mutbl) => (true, ty::TypeAndMut { ty, mutbl }),
822 ty::RawPtr(mt) => (false, mt),
823 _ => return self.unify_and(a, b, identity),
825 coerce_mutbls(mt_a.mutbl, mutbl_b)?;
827 // Check that the types which they point at are compatible.
828 let a_unsafe = self.tcx.mk_ptr(ty::TypeAndMut { mutbl: mutbl_b, ty: mt_a.ty });
829 // Although references and unsafe ptrs have the same
830 // representation, we still register an Adjust::DerefRef so that
831 // regionck knows that the region for `a` must be valid here.
833 self.unify_and(a_unsafe, b, |target| {
835 Adjustment { kind: Adjust::Deref(None), target: mt_a.ty },
836 Adjustment { kind: Adjust::Borrow(AutoBorrow::RawPtr(mutbl_b)), target },
839 } else if mt_a.mutbl != mutbl_b {
840 self.unify_and(a_unsafe, b, simple(Adjust::Pointer(PointerCast::MutToConstPointer)))
842 self.unify_and(a_unsafe, b, identity)
847 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
848 /// Attempt to coerce an expression to a type, and return the
849 /// adjusted type of the expression, if successful.
850 /// Adjustments are only recorded if the coercion succeeded.
851 /// The expressions *must not* have any pre-existing adjustments.
854 expr: &hir::Expr<'_>,
857 allow_two_phase: AllowTwoPhase,
858 ) -> RelateResult<'tcx, Ty<'tcx>> {
859 let source = self.resolve_vars_with_obligations(expr_ty);
860 debug!("coercion::try({:?}: {:?} -> {:?})", expr, source, target);
862 let cause = self.cause(expr.span, ObligationCauseCode::ExprAssignable);
863 let coerce = Coerce::new(self, cause, allow_two_phase);
864 let ok = self.commit_if_ok(|_| coerce.coerce(source, target))?;
866 let (adjustments, _) = self.register_infer_ok_obligations(ok);
867 self.apply_adjustments(expr, adjustments);
868 Ok(if expr_ty.references_error() { self.tcx.ty_error() } else { target })
871 /// Same as `try_coerce()`, but without side-effects.
872 pub fn can_coerce(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> bool {
873 let source = self.resolve_vars_with_obligations(expr_ty);
874 debug!("coercion::can({:?} -> {:?})", source, target);
876 let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
877 // We don't ever need two-phase here since we throw out the result of the coercion
878 let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
879 self.probe(|_| coerce.coerce(source, target)).is_ok()
882 /// Given a type and a target type, this function will calculate and return
883 /// how many dereference steps needed to achieve `expr_ty <: target`. If
884 /// it's not possible, return `None`.
885 pub fn deref_steps(&self, expr_ty: Ty<'tcx>, target: Ty<'tcx>) -> Option<usize> {
886 let cause = self.cause(rustc_span::DUMMY_SP, ObligationCauseCode::ExprAssignable);
887 // We don't ever need two-phase here since we throw out the result of the coercion
888 let coerce = Coerce::new(self, cause, AllowTwoPhase::No);
890 .autoderef(rustc_span::DUMMY_SP, expr_ty)
891 .find_map(|(ty, steps)| self.probe(|_| coerce.unify(ty, target)).ok().map(|_| steps))
894 /// Given some expressions, their known unified type and another expression,
895 /// tries to unify the types, potentially inserting coercions on any of the
896 /// provided expressions and returns their LUB (aka "common supertype").
898 /// This is really an internal helper. From outside the coercion
899 /// module, you should instantiate a `CoerceMany` instance.
900 fn try_find_coercion_lub<E>(
902 cause: &ObligationCause<'tcx>,
907 ) -> RelateResult<'tcx, Ty<'tcx>>
911 let prev_ty = self.resolve_vars_with_obligations(prev_ty);
912 let new_ty = self.resolve_vars_with_obligations(new_ty);
914 "coercion::try_find_coercion_lub({:?}, {:?}, exprs={:?} exprs)",
920 // Special-case that coercion alone cannot handle:
921 // Function items or non-capturing closures of differing IDs or InternalSubsts.
922 let (a_sig, b_sig) = {
923 let is_capturing_closure = |ty| {
924 if let &ty::Closure(closure_def_id, _substs) = ty {
925 self.tcx.upvars_mentioned(closure_def_id.expect_local()).is_some()
930 if is_capturing_closure(prev_ty.kind()) || is_capturing_closure(new_ty.kind()) {
933 match (prev_ty.kind(), new_ty.kind()) {
934 (ty::FnDef(..), ty::FnDef(..)) => {
935 // Don't reify if the function types have a LUB, i.e., they
936 // are the same function and their parameters have a LUB.
938 .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
940 // We have a LUB of prev_ty and new_ty, just return it.
941 Ok(ok) => return Ok(self.register_infer_ok_obligations(ok)),
943 (Some(prev_ty.fn_sig(self.tcx)), Some(new_ty.fn_sig(self.tcx)))
947 (ty::Closure(_, substs), ty::FnDef(..)) => {
948 let b_sig = new_ty.fn_sig(self.tcx);
951 .signature_unclosure(substs.as_closure().sig(), b_sig.unsafety());
952 (Some(a_sig), Some(b_sig))
954 (ty::FnDef(..), ty::Closure(_, substs)) => {
955 let a_sig = prev_ty.fn_sig(self.tcx);
958 .signature_unclosure(substs.as_closure().sig(), a_sig.unsafety());
959 (Some(a_sig), Some(b_sig))
961 (ty::Closure(_, substs_a), ty::Closure(_, substs_b)) => (
962 Some(self.tcx.signature_unclosure(
963 substs_a.as_closure().sig(),
964 hir::Unsafety::Normal,
966 Some(self.tcx.signature_unclosure(
967 substs_b.as_closure().sig(),
968 hir::Unsafety::Normal,
975 if let (Some(a_sig), Some(b_sig)) = (a_sig, b_sig) {
976 // Intrinsics are not coercible to function pointers.
977 if a_sig.abi() == Abi::RustIntrinsic
978 || a_sig.abi() == Abi::PlatformIntrinsic
979 || b_sig.abi() == Abi::RustIntrinsic
980 || b_sig.abi() == Abi::PlatformIntrinsic
982 return Err(TypeError::IntrinsicCast);
984 // The signature must match.
985 let a_sig = self.normalize_associated_types_in(new.span, a_sig);
986 let b_sig = self.normalize_associated_types_in(new.span, b_sig);
988 .at(cause, self.param_env)
989 .trace(prev_ty, new_ty)
991 .map(|ok| self.register_infer_ok_obligations(ok))?;
993 // Reify both sides and return the reified fn pointer type.
994 let fn_ptr = self.tcx.mk_fn_ptr(sig);
995 let prev_adjustment = match prev_ty.kind() {
996 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(a_sig.unsafety())),
997 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1000 let next_adjustment = match new_ty.kind() {
1001 ty::Closure(..) => Adjust::Pointer(PointerCast::ClosureFnPointer(b_sig.unsafety())),
1002 ty::FnDef(..) => Adjust::Pointer(PointerCast::ReifyFnPointer),
1003 _ => unreachable!(),
1005 for expr in exprs.iter().map(|e| e.as_coercion_site()) {
1006 self.apply_adjustments(
1008 vec![Adjustment { kind: prev_adjustment.clone(), target: fn_ptr }],
1011 self.apply_adjustments(new, vec![Adjustment { kind: next_adjustment, target: fn_ptr }]);
1015 // Configure a Coerce instance to compute the LUB.
1016 // We don't allow two-phase borrows on any autorefs this creates since we
1017 // probably aren't processing function arguments here and even if we were,
1018 // they're going to get autorefed again anyway and we can apply 2-phase borrows
1020 let mut coerce = Coerce::new(self, cause.clone(), AllowTwoPhase::No);
1021 coerce.use_lub = true;
1023 // First try to coerce the new expression to the type of the previous ones,
1024 // but only if the new expression has no coercion already applied to it.
1025 let mut first_error = None;
1026 if !self.typeck_results.borrow().adjustments().contains_key(new.hir_id) {
1027 let result = self.commit_if_ok(|_| coerce.coerce(new_ty, prev_ty));
1030 let (adjustments, target) = self.register_infer_ok_obligations(ok);
1031 self.apply_adjustments(new, adjustments);
1033 "coercion::try_find_coercion_lub: was able to coerce from previous type {:?} to new type {:?}",
1038 Err(e) => first_error = Some(e),
1042 // Then try to coerce the previous expressions to the type of the new one.
1043 // This requires ensuring there are no coercions applied to *any* of the
1044 // previous expressions, other than noop reborrows (ignoring lifetimes).
1046 let expr = expr.as_coercion_site();
1047 let noop = match self.typeck_results.borrow().expr_adjustments(expr) {
1048 &[Adjustment { kind: Adjust::Deref(_), .. }, Adjustment { kind: Adjust::Borrow(AutoBorrow::Ref(_, mutbl_adj)), .. }] =>
1050 match *self.node_ty(expr.hir_id).kind() {
1051 ty::Ref(_, _, mt_orig) => {
1052 let mutbl_adj: hir::Mutability = mutbl_adj.into();
1053 // Reborrow that we can safely ignore, because
1054 // the next adjustment can only be a Deref
1055 // which will be merged into it.
1056 mutbl_adj == mt_orig
1061 &[Adjustment { kind: Adjust::NeverToAny, .. }] | &[] => true,
1067 "coercion::try_find_coercion_lub: older expression {:?} had adjustments, requiring LUB",
1072 .commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1073 .map(|ok| self.register_infer_ok_obligations(ok));
1077 match self.commit_if_ok(|_| coerce.coerce(prev_ty, new_ty)) {
1079 // Avoid giving strange errors on failed attempts.
1080 if let Some(e) = first_error {
1083 self.commit_if_ok(|_| self.at(cause, self.param_env).lub(prev_ty, new_ty))
1084 .map(|ok| self.register_infer_ok_obligations(ok))
1089 "coercion::try_find_coercion_lub: was able to coerce previous type {:?} to new type {:?}",
1092 let (adjustments, target) = self.register_infer_ok_obligations(ok);
1094 let expr = expr.as_coercion_site();
1095 self.apply_adjustments(expr, adjustments.clone());
1103 /// CoerceMany encapsulates the pattern you should use when you have
1104 /// many expressions that are all getting coerced to a common
1105 /// type. This arises, for example, when you have a match (the result
1106 /// of each arm is coerced to a common type). It also arises in less
1107 /// obvious places, such as when you have many `break foo` expressions
1108 /// that target the same loop, or the various `return` expressions in
1111 /// The basic protocol is as follows:
1113 /// - Instantiate the `CoerceMany` with an initial `expected_ty`.
1114 /// This will also serve as the "starting LUB". The expectation is
1115 /// that this type is something which all of the expressions *must*
1116 /// be coercible to. Use a fresh type variable if needed.
1117 /// - For each expression whose result is to be coerced, invoke `coerce()` with.
1118 /// - In some cases we wish to coerce "non-expressions" whose types are implicitly
1119 /// unit. This happens for example if you have a `break` with no expression,
1120 /// or an `if` with no `else`. In that case, invoke `coerce_forced_unit()`.
1121 /// - `coerce()` and `coerce_forced_unit()` may report errors. They hide this
1122 /// from you so that you don't have to worry your pretty head about it.
1123 /// But if an error is reported, the final type will be `err`.
1124 /// - Invoking `coerce()` may cause us to go and adjust the "adjustments" on
1125 /// previously coerced expressions.
1126 /// - When all done, invoke `complete()`. This will return the LUB of
1127 /// all your expressions.
1128 /// - WARNING: I don't believe this final type is guaranteed to be
1129 /// related to your initial `expected_ty` in any particular way,
1130 /// although it will typically be a subtype, so you should check it.
1131 /// - Invoking `complete()` may cause us to go and adjust the "adjustments" on
1132 /// previously coerced expressions.
1137 /// let mut coerce = CoerceMany::new(expected_ty);
1138 /// for expr in exprs {
1139 /// let expr_ty = fcx.check_expr_with_expectation(expr, expected);
1140 /// coerce.coerce(fcx, &cause, expr, expr_ty);
1142 /// let final_ty = coerce.complete(fcx);
1144 pub struct CoerceMany<'tcx, 'exprs, E: AsCoercionSite> {
1145 expected_ty: Ty<'tcx>,
1146 final_ty: Option<Ty<'tcx>>,
1147 expressions: Expressions<'tcx, 'exprs, E>,
1151 /// The type of a `CoerceMany` that is storing up the expressions into
1152 /// a buffer. We use this in `check/mod.rs` for things like `break`.
1153 pub type DynamicCoerceMany<'tcx> = CoerceMany<'tcx, 'tcx, &'tcx hir::Expr<'tcx>>;
1155 enum Expressions<'tcx, 'exprs, E: AsCoercionSite> {
1156 Dynamic(Vec<&'tcx hir::Expr<'tcx>>),
1157 UpFront(&'exprs [E]),
1160 impl<'tcx, 'exprs, E: AsCoercionSite> CoerceMany<'tcx, 'exprs, E> {
1161 /// The usual case; collect the set of expressions dynamically.
1162 /// If the full set of coercion sites is known before hand,
1163 /// consider `with_coercion_sites()` instead to avoid allocation.
1164 pub fn new(expected_ty: Ty<'tcx>) -> Self {
1165 Self::make(expected_ty, Expressions::Dynamic(vec![]))
1168 /// As an optimization, you can create a `CoerceMany` with a
1169 /// pre-existing slice of expressions. In this case, you are
1170 /// expected to pass each element in the slice to `coerce(...)` in
1171 /// order. This is used with arrays in particular to avoid
1172 /// needlessly cloning the slice.
1173 pub fn with_coercion_sites(expected_ty: Ty<'tcx>, coercion_sites: &'exprs [E]) -> Self {
1174 Self::make(expected_ty, Expressions::UpFront(coercion_sites))
1177 fn make(expected_ty: Ty<'tcx>, expressions: Expressions<'tcx, 'exprs, E>) -> Self {
1178 CoerceMany { expected_ty, final_ty: None, expressions, pushed: 0 }
1181 /// Returns the "expected type" with which this coercion was
1182 /// constructed. This represents the "downward propagated" type
1183 /// that was given to us at the start of typing whatever construct
1184 /// we are typing (e.g., the match expression).
1186 /// Typically, this is used as the expected type when
1187 /// type-checking each of the alternative expressions whose types
1188 /// we are trying to merge.
1189 pub fn expected_ty(&self) -> Ty<'tcx> {
1193 /// Returns the current "merged type", representing our best-guess
1194 /// at the LUB of the expressions we've seen so far (if any). This
1195 /// isn't *final* until you call `self.final()`, which will return
1196 /// the merged type.
1197 pub fn merged_ty(&self) -> Ty<'tcx> {
1198 self.final_ty.unwrap_or(self.expected_ty)
1201 /// Indicates that the value generated by `expression`, which is
1202 /// of type `expression_ty`, is one of the possibilities that we
1203 /// could coerce from. This will record `expression`, and later
1204 /// calls to `coerce` may come back and add adjustments and things
1208 fcx: &FnCtxt<'a, 'tcx>,
1209 cause: &ObligationCause<'tcx>,
1210 expression: &'tcx hir::Expr<'tcx>,
1211 expression_ty: Ty<'tcx>,
1213 self.coerce_inner(fcx, cause, Some(expression), expression_ty, None, false)
1216 /// Indicates that one of the inputs is a "forced unit". This
1217 /// occurs in a case like `if foo { ... };`, where the missing else
1218 /// generates a "forced unit". Another example is a `loop { break;
1219 /// }`, where the `break` has no argument expression. We treat
1220 /// these cases slightly differently for error-reporting
1221 /// purposes. Note that these tend to correspond to cases where
1222 /// the `()` expression is implicit in the source, and hence we do
1223 /// not take an expression argument.
1225 /// The `augment_error` gives you a chance to extend the error
1226 /// message, in case any results (e.g., we use this to suggest
1227 /// removing a `;`).
1228 pub fn coerce_forced_unit<'a>(
1230 fcx: &FnCtxt<'a, 'tcx>,
1231 cause: &ObligationCause<'tcx>,
1232 augment_error: &mut dyn FnMut(&mut DiagnosticBuilder<'_>),
1233 label_unit_as_expected: bool,
1240 Some(augment_error),
1241 label_unit_as_expected,
1245 /// The inner coercion "engine". If `expression` is `None`, this
1246 /// is a forced-unit case, and hence `expression_ty` must be
1248 crate fn coerce_inner<'a>(
1250 fcx: &FnCtxt<'a, 'tcx>,
1251 cause: &ObligationCause<'tcx>,
1252 expression: Option<&'tcx hir::Expr<'tcx>>,
1253 mut expression_ty: Ty<'tcx>,
1254 augment_error: Option<&mut dyn FnMut(&mut DiagnosticBuilder<'_>)>,
1255 label_expression_as_expected: bool,
1257 // Incorporate whatever type inference information we have
1258 // until now; in principle we might also want to process
1259 // pending obligations, but doing so should only improve
1260 // compatibility (hopefully that is true) by helping us
1261 // uncover never types better.
1262 if expression_ty.is_ty_var() {
1263 expression_ty = fcx.infcx.shallow_resolve(expression_ty);
1266 // If we see any error types, just propagate that error
1268 if expression_ty.references_error() || self.merged_ty().references_error() {
1269 self.final_ty = Some(fcx.tcx.ty_error());
1273 // Handle the actual type unification etc.
1274 let result = if let Some(expression) = expression {
1275 if self.pushed == 0 {
1276 // Special-case the first expression we are coercing.
1277 // To be honest, I'm not entirely sure why we do this.
1278 // We don't allow two-phase borrows, see comment in try_find_coercion_lub for why
1279 fcx.try_coerce(expression, expression_ty, self.expected_ty, AllowTwoPhase::No)
1281 match self.expressions {
1282 Expressions::Dynamic(ref exprs) => fcx.try_find_coercion_lub(
1289 Expressions::UpFront(ref coercion_sites) => fcx.try_find_coercion_lub(
1291 &coercion_sites[0..self.pushed],
1299 // this is a hack for cases where we default to `()` because
1300 // the expression etc has been omitted from the source. An
1301 // example is an `if let` without an else:
1303 // if let Some(x) = ... { }
1305 // we wind up with a second match arm that is like `_ =>
1306 // ()`. That is the case we are considering here. We take
1307 // a different path to get the right "expected, found"
1308 // message and so forth (and because we know that
1309 // `expression_ty` will be unit).
1311 // Another example is `break` with no argument expression.
1312 assert!(expression_ty.is_unit(), "if let hack without unit type");
1313 fcx.at(cause, fcx.param_env)
1314 .eq_exp(label_expression_as_expected, expression_ty, self.merged_ty())
1316 fcx.register_infer_ok_obligations(infer_ok);
1323 self.final_ty = Some(v);
1324 if let Some(e) = expression {
1325 match self.expressions {
1326 Expressions::Dynamic(ref mut buffer) => buffer.push(e),
1327 Expressions::UpFront(coercion_sites) => {
1328 // if the user gave us an array to validate, check that we got
1329 // the next expression in the list, as expected
1331 coercion_sites[self.pushed].as_coercion_site().hir_id,
1339 Err(coercion_error) => {
1340 let (expected, found) = if label_expression_as_expected {
1341 // In the case where this is a "forced unit", like
1342 // `break`, we want to call the `()` "expected"
1343 // since it is implied by the syntax.
1344 // (Note: not all force-units work this way.)"
1345 (expression_ty, self.final_ty.unwrap_or(self.expected_ty))
1347 // Otherwise, the "expected" type for error
1348 // reporting is the current unification type,
1349 // which is basically the LUB of the expressions
1350 // we've seen so far (combined with the expected
1352 (self.final_ty.unwrap_or(self.expected_ty), expression_ty)
1356 let mut unsized_return = false;
1358 ObligationCauseCode::ReturnNoExpression => {
1359 err = struct_span_err!(
1363 "`return;` in a function whose return type is not `()`"
1365 err.span_label(cause.span, "return type is not `()`");
1367 ObligationCauseCode::BlockTailExpression(blk_id) => {
1368 let parent_id = fcx.tcx.hir().get_parent_node(blk_id);
1369 err = self.report_return_mismatched_types(
1376 expression.map(|expr| (expr, blk_id)),
1378 if !fcx.tcx.features().unsized_locals {
1379 unsized_return = self.is_return_ty_unsized(fcx, blk_id);
1382 ObligationCauseCode::ReturnValue(id) => {
1383 err = self.report_return_mismatched_types(
1392 if !fcx.tcx.features().unsized_locals {
1393 let id = fcx.tcx.hir().get_parent_node(id);
1394 unsized_return = self.is_return_ty_unsized(fcx, id);
1398 err = fcx.report_mismatched_types(cause, expected, found, coercion_error);
1402 if let Some(augment_error) = augment_error {
1403 augment_error(&mut err);
1406 if let Some(expr) = expression {
1407 fcx.emit_coerce_suggestions(&mut err, expr, found, expected, None);
1410 // Error possibly reported in `check_assign` so avoid emitting error again.
1411 let assign_to_bool = expression
1412 // #67273: Use initial expected type as opposed to `expected`.
1413 // Otherwise we end up using prior coercions in e.g. a `match` expression:
1416 // 0 => true, // Because of this...
1417 // 1 => i = 1, // ...`expected == bool` now, but not when checking `i = 1`.
1421 .filter(|e| fcx.is_assign_to_bool(e, self.expected_ty()))
1424 err.emit_unless(assign_to_bool || unsized_return);
1426 self.final_ty = Some(fcx.tcx.ty_error());
1431 fn report_return_mismatched_types<'a>(
1433 cause: &ObligationCause<'tcx>,
1436 ty_err: TypeError<'tcx>,
1437 fcx: &FnCtxt<'a, 'tcx>,
1439 expression: Option<(&'tcx hir::Expr<'tcx>, hir::HirId)>,
1440 ) -> DiagnosticBuilder<'a> {
1441 let mut err = fcx.report_mismatched_types(cause, expected, found, ty_err);
1443 let mut pointing_at_return_type = false;
1444 let mut fn_output = None;
1446 // Verify that this is a tail expression of a function, otherwise the
1447 // label pointing out the cause for the type coercion will be wrong
1448 // as prior return coercions would not be relevant (#57664).
1449 let parent_id = fcx.tcx.hir().get_parent_node(id);
1450 let fn_decl = if let Some((expr, blk_id)) = expression {
1451 pointing_at_return_type =
1452 fcx.suggest_mismatched_types_on_tail(&mut err, expr, expected, found, blk_id);
1453 let parent = fcx.tcx.hir().get(parent_id);
1454 if let (Some(cond_expr), true, false) = (
1455 fcx.tcx.hir().get_if_cause(expr.hir_id),
1457 pointing_at_return_type,
1459 // If the block is from an external macro, then do not suggest
1460 // adding a semicolon, because there's nowhere to put it.
1461 // See issue #81943.
1462 if cond_expr.span.desugaring_kind().is_none()
1463 && !in_external_macro(fcx.tcx.sess, cond_expr.span)
1465 err.span_label(cond_expr.span, "expected this to be `()`");
1466 if expr.can_have_side_effects() {
1467 fcx.suggest_semicolon_at_end(cond_expr.span, &mut err);
1471 fcx.get_node_fn_decl(parent).map(|(fn_decl, _, is_main)| (fn_decl, is_main))
1473 fcx.get_fn_decl(parent_id)
1476 if let Some((fn_decl, can_suggest)) = fn_decl {
1477 if expression.is_none() {
1478 pointing_at_return_type |= fcx.suggest_missing_return_type(
1486 if !pointing_at_return_type {
1487 fn_output = Some(&fn_decl.output); // `impl Trait` return type
1491 let parent_id = fcx.tcx.hir().get_parent_item(id);
1492 let parent_item = fcx.tcx.hir().get(parent_id);
1494 if let (Some((expr, _)), Some((fn_decl, _, _))) =
1495 (expression, fcx.get_node_fn_decl(parent_item))
1497 fcx.suggest_missing_break_or_return_expr(
1498 &mut err, expr, fn_decl, expected, found, id, parent_id,
1502 if let (Some(sp), Some(fn_output)) = (fcx.ret_coercion_span.get(), fn_output) {
1503 self.add_impl_trait_explanation(&mut err, cause, fcx, expected, sp, fn_output);
1508 fn add_impl_trait_explanation<'a>(
1510 err: &mut DiagnosticBuilder<'a>,
1511 cause: &ObligationCause<'tcx>,
1512 fcx: &FnCtxt<'a, 'tcx>,
1515 fn_output: &hir::FnRetTy<'_>,
1517 let return_sp = fn_output.span();
1518 err.span_label(return_sp, "expected because this return type...");
1521 format!("...is found to be `{}` here", fcx.resolve_vars_with_obligations(expected)),
1523 let impl_trait_msg = "for information on `impl Trait`, see \
1524 <https://doc.rust-lang.org/book/ch10-02-traits.html\
1525 #returning-types-that-implement-traits>";
1526 let trait_obj_msg = "for information on trait objects, see \
1527 <https://doc.rust-lang.org/book/ch17-02-trait-objects.html\
1528 #using-trait-objects-that-allow-for-values-of-different-types>";
1529 err.note("to return `impl Trait`, all returned values must be of the same type");
1530 err.note(impl_trait_msg);
1535 .span_to_snippet(return_sp)
1536 .unwrap_or_else(|_| "dyn Trait".to_string());
1537 let mut snippet_iter = snippet.split_whitespace();
1538 let has_impl = snippet_iter.next().map_or(false, |s| s == "impl");
1539 // Only suggest `Box<dyn Trait>` if `Trait` in `impl Trait` is object safe.
1540 let mut is_object_safe = false;
1541 if let hir::FnRetTy::Return(ty) = fn_output {
1542 // Get the return type.
1543 if let hir::TyKind::OpaqueDef(..) = ty.kind {
1544 let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty);
1545 // Get the `impl Trait`'s `DefId`.
1546 if let ty::Opaque(def_id, _) = ty.kind() {
1547 let hir_id = fcx.tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
1548 // Get the `impl Trait`'s `Item` so that we can get its trait bounds and
1549 // get the `Trait`'s `DefId`.
1550 if let hir::ItemKind::OpaqueTy(hir::OpaqueTy { bounds, .. }) =
1551 fcx.tcx.hir().expect_item(hir_id).kind
1553 // Are of this `impl Trait`'s traits object safe?
1554 is_object_safe = bounds.iter().all(|bound| {
1557 .and_then(|t| t.trait_def_id())
1558 .map_or(false, |def_id| {
1559 fcx.tcx.object_safety_violations(def_id).is_empty()
1568 err.multipart_suggestion(
1569 "you could change the return type to be a boxed trait object",
1571 (return_sp.with_hi(return_sp.lo() + BytePos(4)), "Box<dyn".to_string()),
1572 (return_sp.shrink_to_hi(), ">".to_string()),
1574 Applicability::MachineApplicable,
1576 let sugg = vec![sp, cause.span]
1580 (sp.shrink_to_lo(), "Box::new(".to_string()),
1581 (sp.shrink_to_hi(), ")".to_string()),
1585 .collect::<Vec<_>>();
1586 err.multipart_suggestion(
1587 "if you change the return type to expect trait objects, box the returned \
1590 Applicability::MaybeIncorrect,
1594 "if the trait `{}` were object safe, you could return a boxed trait object",
1598 err.note(trait_obj_msg);
1600 err.help("you could instead create a new `enum` with a variant for each returned type");
1603 fn is_return_ty_unsized(&self, fcx: &FnCtxt<'a, 'tcx>, blk_id: hir::HirId) -> bool {
1604 if let Some((fn_decl, _)) = fcx.get_fn_decl(blk_id) {
1605 if let hir::FnRetTy::Return(ty) = fn_decl.output {
1606 let ty = <dyn AstConv<'_>>::ast_ty_to_ty(fcx, ty);
1607 if let ty::Dynamic(..) = ty.kind() {
1615 pub fn complete<'a>(self, fcx: &FnCtxt<'a, 'tcx>) -> Ty<'tcx> {
1616 if let Some(final_ty) = self.final_ty {
1619 // If we only had inputs that were of type `!` (or no
1620 // inputs at all), then the final type is `!`.
1621 assert_eq!(self.pushed, 0);
1627 /// Something that can be converted into an expression to which we can
1628 /// apply a coercion.
1629 pub trait AsCoercionSite {
1630 fn as_coercion_site(&self) -> &hir::Expr<'_>;
1633 impl AsCoercionSite for hir::Expr<'_> {
1634 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1639 impl<'a, T> AsCoercionSite for &'a T
1643 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1644 (**self).as_coercion_site()
1648 impl AsCoercionSite for ! {
1649 fn as_coercion_site(&self) -> &hir::Expr<'_> {
1654 impl AsCoercionSite for hir::Arm<'_> {
1655 fn as_coercion_site(&self) -> &hir::Expr<'_> {