compiler/rustc_infer/src/infer/opaque_types.rs

   1 use crate::infer::{InferCtxt, InferOk};
   2 use crate::traits;
   3 use hir::def_id::{DefId, LocalDefId};
   4 use hir::{HirId, OpaqueTyOrigin};
   5 use rustc_data_structures::sync::Lrc;
   6 use rustc_data_structures::vec_map::VecMap;
   7 use rustc_hir as hir;
   8 use rustc_middle::traits::ObligationCause;
   9 use rustc_middle::ty::fold::BottomUpFolder;
  10 use rustc_middle::ty::subst::{GenericArgKind, Subst};
  11 use rustc_middle::ty::{
  12     self, OpaqueHiddenType, OpaqueTypeKey, Ty, TyCtxt, TypeFoldable, TypeSuperVisitable,
  13     TypeVisitable, TypeVisitor,
  14 };
  15 use rustc_span::Span;
  16
  17 use std::ops::ControlFlow;
  18
  19 pub type OpaqueTypeMap<'tcx> = VecMap<OpaqueTypeKey<'tcx>, OpaqueTypeDecl<'tcx>>;
  20
  21 mod table;
  22
  23 pub use table::{OpaqueTypeStorage, OpaqueTypeTable};
  24
  25 use super::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
  26 use super::InferResult;
  27
  28 /// Information about the opaque types whose values we
  29 /// are inferring in this function (these are the `impl Trait` that
  30 /// appear in the return type).
  31 #[derive(Clone, Debug)]
  32 pub struct OpaqueTypeDecl<'tcx> {
  33     /// The hidden types that have been inferred for this opaque type.
  34     /// There can be multiple, but they are all `lub`ed together at the end
  35     /// to obtain the canonical hidden type.
  36     pub hidden_type: OpaqueHiddenType<'tcx>,
  37
  38     /// The origin of the opaque type.
  39     pub origin: hir::OpaqueTyOrigin,
  40 }
  41
  42 impl<'a, 'tcx> InferCtxt<'a, 'tcx> {
  43     pub fn replace_opaque_types_with_inference_vars(
  44         &self,
  45         ty: Ty<'tcx>,
  46         body_id: HirId,
  47         span: Span,
  48         param_env: ty::ParamEnv<'tcx>,
  49     ) -> InferOk<'tcx, Ty<'tcx>> {
  50         if !ty.has_opaque_types() {
  51             return InferOk { value: ty, obligations: vec![] };
  52         }
  53         let mut obligations = vec![];
  54         let replace_opaque_type = |def_id: DefId| {
  55             def_id
  56                 .as_local()
  57                 .map_or(false, |def_id| self.opaque_type_origin(def_id, span).is_some())
  58         };
  59         let value = ty.fold_with(&mut ty::fold::BottomUpFolder {
  60             tcx: self.tcx,
  61             lt_op: |lt| lt,
  62             ct_op: |ct| ct,
  63             ty_op: |ty| match *ty.kind() {
  64                 ty::Opaque(def_id, _substs) if replace_opaque_type(def_id) => {
  65                     let def_span = self.tcx.def_span(def_id);
  66                     let span = if span.contains(def_span) { def_span } else { span };
  67                     let code = traits::ObligationCauseCode::OpaqueReturnType(None);
  68                     let cause = ObligationCause::new(span, body_id, code);
  69                     // FIXME(compiler-errors): We probably should add a new TypeVariableOriginKind
  70                     // for opaque types, and then use that kind to fix the spans for type errors
  71                     // that we see later on.
  72                     let ty_var = self.next_ty_var(TypeVariableOrigin {
  73                         kind: TypeVariableOriginKind::TypeInference,
  74                         span,
  75                     });
  76                     obligations.extend(
  77                         self.handle_opaque_type(ty, ty_var, true, &cause, param_env)
  78                             .unwrap()
  79                             .obligations,
  80                     );
  81                     ty_var
  82                 }
  83                 _ => ty,
  84             },
  85         });
  86         InferOk { value, obligations }
  87     }
  88
  89     pub fn handle_opaque_type(
  90         &self,
  91         a: Ty<'tcx>,
  92         b: Ty<'tcx>,
  93         a_is_expected: bool,
  94         cause: &ObligationCause<'tcx>,
  95         param_env: ty::ParamEnv<'tcx>,
  96     ) -> InferResult<'tcx, ()> {
  97         if a.references_error() || b.references_error() {
  98             return Ok(InferOk { value: (), obligations: vec![] });
  99         }
 100         let (a, b) = if a_is_expected { (a, b) } else { (b, a) };
 101         let process = |a: Ty<'tcx>, b: Ty<'tcx>| match *a.kind() {
 102             ty::Opaque(def_id, substs) if def_id.is_local() => {
 103                 let def_id = def_id.expect_local();
 104                 let origin = if self.defining_use_anchor.is_some() {
 105                     // Check that this is `impl Trait` type is
 106                     // declared by `parent_def_id` -- i.e., one whose
 107                     // value we are inferring.  At present, this is
 108                     // always true during the first phase of
 109                     // type-check, but not always true later on during
 110                     // NLL. Once we support named opaque types more fully,
 111                     // this same scenario will be able to arise during all phases.
 112                     //
 113                     // Here is an example using type alias `impl Trait`
 114                     // that indicates the distinction we are checking for:
 115                     //
 116                     // ```rust
 117                     // mod a {
 118                     //   pub type Foo = impl Iterator;
 119                     //   pub fn make_foo() -> Foo { .. }
 120                     // }
 121                     //
 122                     // mod b {
 123                     //   fn foo() -> a::Foo { a::make_foo() }
 124                     // }
 125                     // ```
 126                     //
 127                     // Here, the return type of `foo` references an
 128                     // `Opaque` indeed, but not one whose value is
 129                     // presently being inferred. You can get into a
 130                     // similar situation with closure return types
 131                     // today:
 132                     //
 133                     // ```rust
 134                     // fn foo() -> impl Iterator { .. }
 135                     // fn bar() {
 136                     //     let x = || foo(); // returns the Opaque assoc with `foo`
 137                     // }
 138                     // ```
 139                     self.opaque_type_origin(def_id, cause.span)?
 140                 } else {
 141                     self.opaque_ty_origin_unchecked(def_id, cause.span)
 142                 };
 143                 if let ty::Opaque(did2, _) = *b.kind() {
 144                     // We could accept this, but there are various ways to handle this situation, and we don't
 145                     // want to make a decision on it right now. Likely this case is so super rare anyway, that
 146                     // no one encounters it in practice.
 147                     // It does occur however in `fn fut() -> impl Future<Output = i32> { async { 42 } }`,
 148                     // where it is of no concern, so we only check for TAITs.
 149                     if let Some(OpaqueTyOrigin::TyAlias) =
 150                         did2.as_local().and_then(|did2| self.opaque_type_origin(did2, cause.span))
 151                     {
 152                         self.tcx
 153                                 .sess
 154                                 .struct_span_err(
 155                                     cause.span,
 156                                     "opaque type's hidden type cannot be another opaque type from the same scope",
 157                                 )
 158                                 .span_label(cause.span, "one of the two opaque types used here has to be outside its defining scope")
 159                                 .span_note(
 160                                     self.tcx.def_span(def_id),
 161                                     "opaque type whose hidden type is being assigned",
 162                                 )
 163                                 .span_note(
 164                                     self.tcx.def_span(did2),
 165                                     "opaque type being used as hidden type",
 166                                 )
 167                                 .emit();
 168                     }
 169                 }
 170                 Some(self.register_hidden_type(
 171                     OpaqueTypeKey { def_id, substs },
 172                     cause.clone(),
 173                     param_env,
 174                     b,
 175                     origin,
 176                 ))
 177             }
 178             _ => None,
 179         };
 180         if let Some(res) = process(a, b) {
 181             res
 182         } else if let Some(res) = process(b, a) {
 183             res
 184         } else {
 185             // Rerun equality check, but this time error out due to
 186             // different types.
 187             match self.at(cause, param_env).define_opaque_types(false).eq(a, b) {
 188                 Ok(_) => span_bug!(
 189                     cause.span,
 190                     "opaque types are never equal to anything but themselves: {:#?}",
 191                     (a.kind(), b.kind())
 192                 ),
 193                 Err(e) => Err(e),
 194             }
 195         }
 196     }
 197
 198     /// Given the map `opaque_types` containing the opaque
 199     /// `impl Trait` types whose underlying, hidden types are being
 200     /// inferred, this method adds constraints to the regions
 201     /// appearing in those underlying hidden types to ensure that they
 202     /// at least do not refer to random scopes within the current
 203     /// function. These constraints are not (quite) sufficient to
 204     /// guarantee that the regions are actually legal values; that
 205     /// final condition is imposed after region inference is done.
 206     ///
 207     /// # The Problem
 208     ///
 209     /// Let's work through an example to explain how it works. Assume
 210     /// the current function is as follows:
 211     ///
 212     /// ```text
 213     /// fn foo<'a, 'b>(..) -> (impl Bar<'a>, impl Bar<'b>)
 214     /// ```
 215     ///
 216     /// Here, we have two `impl Trait` types whose values are being
 217     /// inferred (the `impl Bar<'a>` and the `impl
 218     /// Bar<'b>`). Conceptually, this is sugar for a setup where we
 219     /// define underlying opaque types (`Foo1`, `Foo2`) and then, in
 220     /// the return type of `foo`, we *reference* those definitions:
 221     ///
 222     /// ```text
 223     /// type Foo1<'x> = impl Bar<'x>;
 224     /// type Foo2<'x> = impl Bar<'x>;
 225     /// fn foo<'a, 'b>(..) -> (Foo1<'a>, Foo2<'b>) { .. }
 226     ///                    //  ^^^^ ^^
 227     ///                    //  |    |
 228     ///                    //  |    substs
 229     ///                    //  def_id
 230     /// ```
 231     ///
 232     /// As indicating in the comments above, each of those references
 233     /// is (in the compiler) basically a substitution (`substs`)
 234     /// applied to the type of a suitable `def_id` (which identifies
 235     /// `Foo1` or `Foo2`).
 236     ///
 237     /// Now, at this point in compilation, what we have done is to
 238     /// replace each of the references (`Foo1<'a>`, `Foo2<'b>`) with
 239     /// fresh inference variables C1 and C2. We wish to use the values
 240     /// of these variables to infer the underlying types of `Foo1` and
 241     /// `Foo2`. That is, this gives rise to higher-order (pattern) unification
 242     /// constraints like:
 243     ///
 244     /// ```text
 245     /// for<'a> (Foo1<'a> = C1)
 246     /// for<'b> (Foo1<'b> = C2)
 247     /// ```
 248     ///
 249     /// For these equation to be satisfiable, the types `C1` and `C2`
 250     /// can only refer to a limited set of regions. For example, `C1`
 251     /// can only refer to `'static` and `'a`, and `C2` can only refer
 252     /// to `'static` and `'b`. The job of this function is to impose that
 253     /// constraint.
 254     ///
 255     /// Up to this point, C1 and C2 are basically just random type
 256     /// inference variables, and hence they may contain arbitrary
 257     /// regions. In fact, it is fairly likely that they do! Consider
 258     /// this possible definition of `foo`:
 259     ///
 260     /// ```text
 261     /// fn foo<'a, 'b>(x: &'a i32, y: &'b i32) -> (impl Bar<'a>, impl Bar<'b>) {
 262     ///         (&*x, &*y)
 263     ///     }
 264     /// ```
 265     ///
 266     /// Here, the values for the concrete types of the two impl
 267     /// traits will include inference variables:
 268     ///
 269     /// ```text
 270     /// &'0 i32
 271     /// &'1 i32
 272     /// ```
 273     ///
 274     /// Ordinarily, the subtyping rules would ensure that these are
 275     /// sufficiently large. But since `impl Bar<'a>` isn't a specific
 276     /// type per se, we don't get such constraints by default. This
 277     /// is where this function comes into play. It adds extra
 278     /// constraints to ensure that all the regions which appear in the
 279     /// inferred type are regions that could validly appear.
 280     ///
 281     /// This is actually a bit of a tricky constraint in general. We
 282     /// want to say that each variable (e.g., `'0`) can only take on
 283     /// values that were supplied as arguments to the opaque type
 284     /// (e.g., `'a` for `Foo1<'a>`) or `'static`, which is always in
 285     /// scope. We don't have a constraint quite of this kind in the current
 286     /// region checker.
 287     ///
 288     /// # The Solution
 289     ///
 290     /// We generally prefer to make `<=` constraints, since they
 291     /// integrate best into the region solver. To do that, we find the
 292     /// "minimum" of all the arguments that appear in the substs: that
 293     /// is, some region which is less than all the others. In the case
 294     /// of `Foo1<'a>`, that would be `'a` (it's the only choice, after
 295     /// all). Then we apply that as a least bound to the variables
 296     /// (e.g., `'a <= '0`).
 297     ///
 298     /// In some cases, there is no minimum. Consider this example:
 299     ///
 300     /// ```text
 301     /// fn baz<'a, 'b>() -> impl Trait<'a, 'b> { ... }
 302     /// ```
 303     ///
 304     /// Here we would report a more complex "in constraint", like `'r
 305     /// in ['a, 'b, 'static]` (where `'r` is some region appearing in
 306     /// the hidden type).
 307     ///
 308     /// # Constrain regions, not the hidden concrete type
 309     ///
 310     /// Note that generating constraints on each region `Rc` is *not*
 311     /// the same as generating an outlives constraint on `Tc` itself.
 312     /// For example, if we had a function like this:
 313     ///
 314     /// ```
 315     /// # #![feature(type_alias_impl_trait)]
 316     /// # fn main() {}
 317     /// # trait Foo<'a> {}
 318     /// # impl<'a, T> Foo<'a> for (&'a u32, T) {}
 319     /// fn foo<'a, T>(x: &'a u32, y: T) -> impl Foo<'a> {
 320     ///   (x, y)
 321     /// }
 322     ///
 323     /// // Equivalent to:
 324     /// # mod dummy { use super::*;
 325     /// type FooReturn<'a, T> = impl Foo<'a>;
 326     /// fn foo<'a, T>(x: &'a u32, y: T) -> FooReturn<'a, T> {
 327     ///   (x, y)
 328     /// }
 329     /// # }
 330     /// ```
 331     ///
 332     /// then the hidden type `Tc` would be `(&'0 u32, T)` (where `'0`
 333     /// is an inference variable). If we generated a constraint that
 334     /// `Tc: 'a`, then this would incorrectly require that `T: 'a` --
 335     /// but this is not necessary, because the opaque type we
 336     /// create will be allowed to reference `T`. So we only generate a
 337     /// constraint that `'0: 'a`.
 338     #[instrument(level = "debug", skip(self))]
 339     pub fn register_member_constraints(
 340         &self,
 341         param_env: ty::ParamEnv<'tcx>,
 342         opaque_type_key: OpaqueTypeKey<'tcx>,
 343         concrete_ty: Ty<'tcx>,
 344         span: Span,
 345     ) {
 346         let def_id = opaque_type_key.def_id;
 347
 348         let tcx = self.tcx;
 349
 350         let concrete_ty = self.resolve_vars_if_possible(concrete_ty);
 351
 352         debug!(?concrete_ty);
 353
 354         let first_own_region = match self.opaque_ty_origin_unchecked(def_id, span) {
 355             hir::OpaqueTyOrigin::FnReturn(..) | hir::OpaqueTyOrigin::AsyncFn(..) => {
 356                 // We lower
 357                 //
 358                 // fn foo<'l0..'ln>() -> impl Trait<'l0..'lm>
 359                 //
 360                 // into
 361                 //
 362                 // type foo::<'p0..'pn>::Foo<'q0..'qm>
 363                 // fn foo<l0..'ln>() -> foo::<'static..'static>::Foo<'l0..'lm>.
 364                 //
 365                 // For these types we only iterate over `'l0..lm` below.
 366                 tcx.generics_of(def_id).parent_count
 367             }
 368             // These opaque type inherit all lifetime parameters from their
 369             // parent, so we have to check them all.
 370             hir::OpaqueTyOrigin::TyAlias => 0,
 371         };
 372
 373         // For a case like `impl Foo<'a, 'b>`, we would generate a constraint
 374         // `'r in ['a, 'b, 'static]` for each region `'r` that appears in the
 375         // hidden type (i.e., it must be equal to `'a`, `'b`, or `'static`).
 376         //
 377         // `conflict1` and `conflict2` are the two region bounds that we
 378         // detected which were unrelated. They are used for diagnostics.
 379
 380         // Create the set of choice regions: each region in the hidden
 381         // type can be equal to any of the region parameters of the
 382         // opaque type definition.
 383         let choice_regions: Lrc<Vec<ty::Region<'tcx>>> = Lrc::new(
 384             opaque_type_key.substs[first_own_region..]
 385                 .iter()
 386                 .filter_map(|arg| match arg.unpack() {
 387                     GenericArgKind::Lifetime(r) => Some(r),
 388                     GenericArgKind::Type(_) | GenericArgKind::Const(_) => None,
 389                 })
 390                 .chain(std::iter::once(self.tcx.lifetimes.re_static))
 391                 .collect(),
 392         );
 393
 394         concrete_ty.visit_with(&mut ConstrainOpaqueTypeRegionVisitor {
 395             op: |r| {
 396                 self.member_constraint(
 397                     opaque_type_key.def_id,
 398                     span,
 399                     concrete_ty,
 400                     r,
 401                     &choice_regions,
 402                 )
 403             },
 404         });
 405     }
 406
 407     #[instrument(skip(self), level = "trace")]
 408     pub fn opaque_type_origin(&self, def_id: LocalDefId, span: Span) -> Option<OpaqueTyOrigin> {
 409         let opaque_hir_id = self.tcx.hir().local_def_id_to_hir_id(def_id);
 410         let parent_def_id = self.defining_use_anchor?;
 411         let item_kind = &self.tcx.hir().expect_item(def_id).kind;
 412
 413         let hir::ItemKind::OpaqueTy(hir::OpaqueTy { origin, ..  }) = item_kind else {
 414             span_bug!(
 415                 span,
 416                 "weird opaque type: {:#?}, {:#?}",
 417                 def_id,
 418                 item_kind
 419             )
 420         };
 421         let in_definition_scope = match *origin {
 422             // Async `impl Trait`
 423             hir::OpaqueTyOrigin::AsyncFn(parent) => parent == parent_def_id,
 424             // Anonymous `impl Trait`
 425             hir::OpaqueTyOrigin::FnReturn(parent) => parent == parent_def_id,
 426             // Named `type Foo = impl Bar;`
 427             hir::OpaqueTyOrigin::TyAlias => {
 428                 may_define_opaque_type(self.tcx, parent_def_id, opaque_hir_id)
 429             }
 430         };
 431         trace!(?origin);
 432         in_definition_scope.then_some(*origin)
 433     }
 434
 435     #[instrument(skip(self), level = "trace")]
 436     fn opaque_ty_origin_unchecked(&self, def_id: LocalDefId, span: Span) -> OpaqueTyOrigin {
 437         let origin = match self.tcx.hir().expect_item(def_id).kind {
 438             hir::ItemKind::OpaqueTy(hir::OpaqueTy { origin, .. }) => origin,
 439             ref itemkind => {
 440                 span_bug!(span, "weird opaque type: {:?}, {:#?}", def_id, itemkind)
 441             }
 442         };
 443         trace!(?origin);
 444         origin
 445     }
 446 }
 447
 448 // Visitor that requires that (almost) all regions in the type visited outlive
 449 // `least_region`. We cannot use `push_outlives_components` because regions in
 450 // closure signatures are not included in their outlives components. We need to
 451 // ensure all regions outlive the given bound so that we don't end up with,
 452 // say, `ReVar` appearing in a return type and causing ICEs when other
 453 // functions end up with region constraints involving regions from other
 454 // functions.
 455 //
 456 // We also cannot use `for_each_free_region` because for closures it includes
 457 // the regions parameters from the enclosing item.
 458 //
 459 // We ignore any type parameters because impl trait values are assumed to
 460 // capture all the in-scope type parameters.
 461 struct ConstrainOpaqueTypeRegionVisitor<OP> {
 462     op: OP,
 463 }
 464
 465 impl<'tcx, OP> TypeVisitor<'tcx> for ConstrainOpaqueTypeRegionVisitor<OP>
 466 where
 467     OP: FnMut(ty::Region<'tcx>),
 468 {
 469     fn visit_binder<T: TypeVisitable<'tcx>>(
 470         &mut self,
 471         t: &ty::Binder<'tcx, T>,
 472     ) -> ControlFlow<Self::BreakTy> {
 473         t.super_visit_with(self);
 474         ControlFlow::CONTINUE
 475     }
 476
 477     fn visit_region(&mut self, r: ty::Region<'tcx>) -> ControlFlow<Self::BreakTy> {
 478         match *r {
 479             // ignore bound regions, keep visiting
 480             ty::ReLateBound(_, _) => ControlFlow::CONTINUE,
 481             _ => {
 482                 (self.op)(r);
 483                 ControlFlow::CONTINUE
 484             }
 485         }
 486     }
 487
 488     fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
 489         // We're only interested in types involving regions
 490         if !ty.flags().intersects(ty::TypeFlags::HAS_FREE_REGIONS) {
 491             return ControlFlow::CONTINUE;
 492         }
 493
 494         match ty.kind() {
 495             ty::Closure(_, ref substs) => {
 496                 // Skip lifetime parameters of the enclosing item(s)
 497
 498                 substs.as_closure().tupled_upvars_ty().visit_with(self);
 499                 substs.as_closure().sig_as_fn_ptr_ty().visit_with(self);
 500             }
 501
 502             ty::Generator(_, ref substs, _) => {
 503                 // Skip lifetime parameters of the enclosing item(s)
 504                 // Also skip the witness type, because that has no free regions.
 505
 506                 substs.as_generator().tupled_upvars_ty().visit_with(self);
 507                 substs.as_generator().return_ty().visit_with(self);
 508                 substs.as_generator().yield_ty().visit_with(self);
 509                 substs.as_generator().resume_ty().visit_with(self);
 510             }
 511             _ => {
 512                 ty.super_visit_with(self);
 513             }
 514         }
 515
 516         ControlFlow::CONTINUE
 517     }
 518 }
 519
 520 pub enum UseKind {
 521     DefiningUse,
 522     OpaqueUse,
 523 }
 524
 525 impl UseKind {
 526     pub fn is_defining(self) -> bool {
 527         match self {
 528             UseKind::DefiningUse => true,
 529             UseKind::OpaqueUse => false,
 530         }
 531     }
 532 }
 533
 534 impl<'a, 'tcx> InferCtxt<'a, 'tcx> {
 535     #[instrument(skip(self), level = "debug")]
 536     pub fn register_hidden_type(
 537         &self,
 538         opaque_type_key: OpaqueTypeKey<'tcx>,
 539         cause: ObligationCause<'tcx>,
 540         param_env: ty::ParamEnv<'tcx>,
 541         hidden_ty: Ty<'tcx>,
 542         origin: hir::OpaqueTyOrigin,
 543     ) -> InferResult<'tcx, ()> {
 544         let tcx = self.tcx;
 545         let OpaqueTypeKey { def_id, substs } = opaque_type_key;
 546
 547         // Ideally, we'd get the span where *this specific `ty` came
 548         // from*, but right now we just use the span from the overall
 549         // value being folded. In simple cases like `-> impl Foo`,
 550         // these are the same span, but not in cases like `-> (impl
 551         // Foo, impl Bar)`.
 552         let span = cause.span;
 553
 554         let mut obligations = vec![];
 555         let prev = self.inner.borrow_mut().opaque_types().register(
 556             OpaqueTypeKey { def_id, substs },
 557             OpaqueHiddenType { ty: hidden_ty, span },
 558             origin,
 559         );
 560         if let Some(prev) = prev {
 561             obligations = self.at(&cause, param_env).eq(prev, hidden_ty)?.obligations;
 562         }
 563
 564         let item_bounds = tcx.bound_explicit_item_bounds(def_id.to_def_id());
 565
 566         for predicate in item_bounds.transpose_iter().map(|e| e.map_bound(|(p, _)| *p)) {
 567             debug!(?predicate);
 568             let predicate = predicate.subst(tcx, substs);
 569
 570             let predicate = predicate.fold_with(&mut BottomUpFolder {
 571                 tcx,
 572                 ty_op: |ty| match *ty.kind() {
 573                     // We can't normalize associated types from `rustc_infer`,
 574                     // but we can eagerly register inference variables for them.
 575                     ty::Projection(projection_ty) if !projection_ty.has_escaping_bound_vars() => {
 576                         self.infer_projection(
 577                             param_env,
 578                             projection_ty,
 579                             cause.clone(),
 580                             0,
 581                             &mut obligations,
 582                         )
 583                     }
 584                     // Replace all other mentions of the same opaque type with the hidden type,
 585                     // as the bounds must hold on the hidden type after all.
 586                     ty::Opaque(def_id2, substs2)
 587                         if def_id.to_def_id() == def_id2 && substs == substs2 =>
 588                     {
 589                         hidden_ty
 590                     }
 591                     _ => ty,
 592                 },
 593                 lt_op: |lt| lt,
 594                 ct_op: |ct| ct,
 595             });
 596
 597             if let ty::PredicateKind::Projection(projection) = predicate.kind().skip_binder() {
 598                 if projection.term.references_error() {
 599                     // No point on adding these obligations since there's a type error involved.
 600                     return Ok(InferOk { value: (), obligations: vec![] });
 601                 }
 602                 trace!("{:#?}", projection.term);
 603             }
 604             // Require that the predicate holds for the concrete type.
 605             debug!(?predicate);
 606             obligations.push(traits::Obligation::new(cause.clone(), param_env, predicate));
 607         }
 608         Ok(InferOk { value: (), obligations })
 609     }
 610 }
 611
 612 /// Returns `true` if `opaque_hir_id` is a sibling or a child of a sibling of `def_id`.
 613 ///
 614 /// Example:
 615 /// ```ignore UNSOLVED (is this a bug?)
 616 /// # #![feature(type_alias_impl_trait)]
 617 /// pub mod foo {
 618 ///     pub mod bar {
 619 ///         pub trait Bar { /* ... */ }
 620 ///         pub type Baz = impl Bar;
 621 ///
 622 ///         # impl Bar for () {}
 623 ///         fn f1() -> Baz { /* ... */ }
 624 ///     }
 625 ///     fn f2() -> bar::Baz { /* ... */ }
 626 /// }
 627 /// ```
 628 ///
 629 /// Here, `def_id` is the `LocalDefId` of the defining use of the opaque type (e.g., `f1` or `f2`),
 630 /// and `opaque_hir_id` is the `HirId` of the definition of the opaque type `Baz`.
 631 /// For the above example, this function returns `true` for `f1` and `false` for `f2`.
 632 fn may_define_opaque_type(tcx: TyCtxt<'_>, def_id: LocalDefId, opaque_hir_id: hir::HirId) -> bool {
 633     let mut hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
 634
 635     // Named opaque types can be defined by any siblings or children of siblings.
 636     let scope = tcx.hir().get_defining_scope(opaque_hir_id);
 637     // We walk up the node tree until we hit the root or the scope of the opaque type.
 638     while hir_id != scope && hir_id != hir::CRATE_HIR_ID {
 639         hir_id = tcx.hir().local_def_id_to_hir_id(tcx.hir().get_parent_item(hir_id));
 640     }
 641     // Syntactically, we are allowed to define the concrete type if:
 642     let res = hir_id == scope;
 643     trace!(
 644         "may_define_opaque_type(def={:?}, opaque_node={:?}) = {}",
 645         tcx.hir().find(hir_id),
 646         tcx.hir().get(opaque_hir_id),
 647         res
 648     );
 649     res
 650 }