src/librustc_mir/borrow_check/diagnostics/region_name.rs

   1 use std::fmt::{self, Display};
   2
   3 use rustc_errors::DiagnosticBuilder;
   4 use rustc_hir as hir;
   5 use rustc_hir::def::{DefKind, Res};
   6 use rustc_middle::ty::print::RegionHighlightMode;
   7 use rustc_middle::ty::subst::{GenericArgKind, SubstsRef};
   8 use rustc_middle::ty::{self, RegionVid, Ty};
   9 use rustc_span::symbol::kw;
  10 use rustc_span::{symbol::Symbol, Span, DUMMY_SP};
  11
  12 use crate::borrow_check::{nll::ToRegionVid, universal_regions::DefiningTy, MirBorrowckCtxt};
  13
  14 /// A name for a particular region used in emitting diagnostics. This name could be a generated
  15 /// name like `'1`, a name used by the user like `'a`, or a name like `'static`.
  16 #[derive(Debug, Clone)]
  17 crate struct RegionName {
  18     /// The name of the region (interned).
  19     crate name: Symbol,
  20     /// Where the region comes from.
  21     crate source: RegionNameSource,
  22 }
  23
  24 /// Denotes the source of a region that is named by a `RegionName`. For example, a free region that
  25 /// was named by the user would get `NamedFreeRegion` and `'static` lifetime would get `Static`.
  26 /// This helps to print the right kinds of diagnostics.
  27 #[derive(Debug, Clone)]
  28 crate enum RegionNameSource {
  29     /// A bound (not free) region that was substituted at the def site (not an HRTB).
  30     NamedEarlyBoundRegion(Span),
  31     /// A free region that the user has a name (`'a`) for.
  32     NamedFreeRegion(Span),
  33     /// The `'static` region.
  34     Static,
  35     /// The free region corresponding to the environment of a closure.
  36     SynthesizedFreeEnvRegion(Span, String),
  37     /// The region corresponding to an argument.
  38     AnonRegionFromArgument(RegionNameHighlight),
  39     /// The region corresponding to a closure upvar.
  40     AnonRegionFromUpvar(Span, String),
  41     /// The region corresponding to the return type of a closure.
  42     AnonRegionFromOutput(Span, String, String),
  43     /// The region from a type yielded by a generator.
  44     AnonRegionFromYieldTy(Span, String),
  45     /// An anonymous region from an async fn.
  46     AnonRegionFromAsyncFn(Span),
  47 }
  48
  49 /// Describes what to highlight to explain to the user that we're giving an anonymous region a
  50 /// synthesized name, and how to highlight it.
  51 #[derive(Debug, Clone)]
  52 crate enum RegionNameHighlight {
  53     /// The anonymous region corresponds to a reference that was found by traversing the type in the HIR.
  54     MatchedHirTy(Span),
  55     /// The anonymous region corresponds to a `'_` in the generics list of a struct/enum/union.
  56     MatchedAdtAndSegment(Span),
  57     /// The anonymous region corresponds to a region where the type annotation is completely missing
  58     /// from the code, e.g. in a closure arguments `|x| { ... }`, where `x` is a reference.
  59     CannotMatchHirTy(Span, String),
  60 }
  61
  62 impl RegionName {
  63     crate fn was_named(&self) -> bool {
  64         match self.source {
  65             RegionNameSource::NamedEarlyBoundRegion(..)
  66             | RegionNameSource::NamedFreeRegion(..)
  67             | RegionNameSource::Static => true,
  68             RegionNameSource::SynthesizedFreeEnvRegion(..)
  69             | RegionNameSource::AnonRegionFromArgument(..)
  70             | RegionNameSource::AnonRegionFromUpvar(..)
  71             | RegionNameSource::AnonRegionFromOutput(..)
  72             | RegionNameSource::AnonRegionFromYieldTy(..)
  73             | RegionNameSource::AnonRegionFromAsyncFn(..) => false,
  74         }
  75     }
  76
  77     crate fn span(&self) -> Option<Span> {
  78         match self.source {
  79             RegionNameSource::Static => None,
  80             RegionNameSource::NamedEarlyBoundRegion(span)
  81             | RegionNameSource::NamedFreeRegion(span)
  82             | RegionNameSource::SynthesizedFreeEnvRegion(span, _)
  83             | RegionNameSource::AnonRegionFromUpvar(span, _)
  84             | RegionNameSource::AnonRegionFromOutput(span, _, _)
  85             | RegionNameSource::AnonRegionFromYieldTy(span, _)
  86             | RegionNameSource::AnonRegionFromAsyncFn(span) => Some(span),
  87             RegionNameSource::AnonRegionFromArgument(ref highlight) => match *highlight {
  88                 RegionNameHighlight::MatchedHirTy(span)
  89                 | RegionNameHighlight::MatchedAdtAndSegment(span)
  90                 | RegionNameHighlight::CannotMatchHirTy(span, _) => Some(span),
  91             },
  92         }
  93     }
  94
  95     crate fn highlight_region_name(&self, diag: &mut DiagnosticBuilder<'_>) {
  96         match &self.source {
  97             RegionNameSource::NamedFreeRegion(span)
  98             | RegionNameSource::NamedEarlyBoundRegion(span) => {
  99                 diag.span_label(*span, format!("lifetime `{}` defined here", self));
 100             }
 101             RegionNameSource::SynthesizedFreeEnvRegion(span, note) => {
 102                 diag.span_label(
 103                     *span,
 104                     format!("lifetime `{}` represents this closure's body", self),
 105                 );
 106                 diag.note(&note);
 107             }
 108             RegionNameSource::AnonRegionFromArgument(RegionNameHighlight::CannotMatchHirTy(
 109                 span,
 110                 type_name,
 111             )) => {
 112                 diag.span_label(*span, format!("has type `{}`", type_name));
 113             }
 114             RegionNameSource::AnonRegionFromArgument(RegionNameHighlight::MatchedHirTy(span))
 115             | RegionNameSource::AnonRegionFromAsyncFn(span) => {
 116                 diag.span_label(
 117                     *span,
 118                     format!("let's call the lifetime of this reference `{}`", self),
 119                 );
 120             }
 121             RegionNameSource::AnonRegionFromArgument(
 122                 RegionNameHighlight::MatchedAdtAndSegment(span),
 123             ) => {
 124                 diag.span_label(*span, format!("let's call this `{}`", self));
 125             }
 126             RegionNameSource::AnonRegionFromUpvar(span, upvar_name) => {
 127                 diag.span_label(
 128                     *span,
 129                     format!("lifetime `{}` appears in the type of `{}`", self, upvar_name),
 130                 );
 131             }
 132             RegionNameSource::AnonRegionFromOutput(span, mir_description, type_name) => {
 133                 diag.span_label(*span, format!("return type{} is {}", mir_description, type_name));
 134             }
 135             RegionNameSource::AnonRegionFromYieldTy(span, type_name) => {
 136                 diag.span_label(*span, format!("yield type is {}", type_name));
 137             }
 138             RegionNameSource::Static => {}
 139         }
 140     }
 141 }
 142
 143 impl Display for RegionName {
 144     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 145         write!(f, "{}", self.name)
 146     }
 147 }
 148
 149 impl<'tcx> MirBorrowckCtxt<'_, 'tcx> {
 150     /// Generate a synthetic region named `'N`, where `N` is the next value of the counter. Then,
 151     /// increment the counter.
 152     ///
 153     /// This is _not_ idempotent. Call `give_region_a_name` when possible.
 154     fn synthesize_region_name(&self) -> Symbol {
 155         let c = self.next_region_name.replace_with(|counter| *counter + 1);
 156         Symbol::intern(&format!("'{:?}", c))
 157     }
 158
 159     /// Maps from an internal MIR region vid to something that we can
 160     /// report to the user. In some cases, the region vids will map
 161     /// directly to lifetimes that the user has a name for (e.g.,
 162     /// `'static`). But frequently they will not, in which case we
 163     /// have to find some way to identify the lifetime to the user. To
 164     /// that end, this function takes a "diagnostic" so that it can
 165     /// create auxiliary notes as needed.
 166     ///
 167     /// The names are memoized, so this is both cheap to recompute and idempotent.
 168     ///
 169     /// Example (function arguments):
 170     ///
 171     /// Suppose we are trying to give a name to the lifetime of the
 172     /// reference `x`:
 173     ///
 174     /// ```
 175     /// fn foo(x: &u32) { .. }
 176     /// ```
 177     ///
 178     /// This function would create a label like this:
 179     ///
 180     /// ```text
 181     ///  | fn foo(x: &u32) { .. }
 182     ///           ------- fully elaborated type of `x` is `&'1 u32`
 183     /// ```
 184     ///
 185     /// and then return the name `'1` for us to use.
 186     crate fn give_region_a_name(&self, fr: RegionVid) -> Option<RegionName> {
 187         debug!(
 188             "give_region_a_name(fr={:?}, counter={:?})",
 189             fr,
 190             self.next_region_name.try_borrow().unwrap()
 191         );
 192
 193         assert!(self.regioncx.universal_regions().is_universal_region(fr));
 194
 195         if let Some(value) = self.region_names.try_borrow_mut().unwrap().get(&fr) {
 196             return Some(value.clone());
 197         }
 198
 199         let value = self
 200             .give_name_from_error_region(fr)
 201             .or_else(|| self.give_name_if_anonymous_region_appears_in_arguments(fr))
 202             .or_else(|| self.give_name_if_anonymous_region_appears_in_upvars(fr))
 203             .or_else(|| self.give_name_if_anonymous_region_appears_in_output(fr))
 204             .or_else(|| self.give_name_if_anonymous_region_appears_in_yield_ty(fr));
 205
 206         if let Some(ref value) = value {
 207             self.region_names.try_borrow_mut().unwrap().insert(fr, value.clone());
 208         }
 209
 210         debug!("give_region_a_name: gave name {:?}", value);
 211         value
 212     }
 213
 214     /// Checks for the case where `fr` maps to something that the
 215     /// *user* has a name for. In that case, we'll be able to map
 216     /// `fr` to a `Region<'tcx>`, and that region will be one of
 217     /// named variants.
 218     fn give_name_from_error_region(&self, fr: RegionVid) -> Option<RegionName> {
 219         let error_region = self.to_error_region(fr)?;
 220
 221         let tcx = self.infcx.tcx;
 222
 223         debug!("give_region_a_name: error_region = {:?}", error_region);
 224         match error_region {
 225             ty::ReEarlyBound(ebr) => {
 226                 if ebr.has_name() {
 227                     let span = tcx.hir().span_if_local(ebr.def_id).unwrap_or(DUMMY_SP);
 228                     Some(RegionName {
 229                         name: ebr.name,
 230                         source: RegionNameSource::NamedEarlyBoundRegion(span),
 231                     })
 232                 } else {
 233                     None
 234                 }
 235             }
 236
 237             ty::ReStatic => {
 238                 Some(RegionName { name: kw::StaticLifetime, source: RegionNameSource::Static })
 239             }
 240
 241             ty::ReFree(free_region) => match free_region.bound_region {
 242                 ty::BoundRegion::BrNamed(region_def_id, name) => {
 243                     // Get the span to point to, even if we don't use the name.
 244                     let span = tcx.hir().span_if_local(region_def_id).unwrap_or(DUMMY_SP);
 245                     debug!(
 246                         "bound region named: {:?}, is_named: {:?}",
 247                         name,
 248                         free_region.bound_region.is_named()
 249                     );
 250
 251                     if free_region.bound_region.is_named() {
 252                         // A named region that is actually named.
 253                         Some(RegionName { name, source: RegionNameSource::NamedFreeRegion(span) })
 254                     } else {
 255                         // If we spuriously thought that the region is named, we should let the
 256                         // system generate a true name for error messages. Currently this can
 257                         // happen if we have an elided name in an async fn for example: the
 258                         // compiler will generate a region named `'_`, but reporting such a name is
 259                         // not actually useful, so we synthesize a name for it instead.
 260                         let name = self.synthesize_region_name();
 261                         Some(RegionName {
 262                             name,
 263                             source: RegionNameSource::AnonRegionFromAsyncFn(span),
 264                         })
 265                     }
 266                 }
 267
 268                 ty::BoundRegion::BrEnv => {
 269                     let mir_hir_id = self.infcx.tcx.hir().as_local_hir_id(self.mir_def_id);
 270                     let def_ty = self.regioncx.universal_regions().defining_ty;
 271
 272                     if let DefiningTy::Closure(_, substs) = def_ty {
 273                         let args_span = if let hir::ExprKind::Closure(_, _, _, span, _) =
 274                             tcx.hir().expect_expr(mir_hir_id).kind
 275                         {
 276                             span
 277                         } else {
 278                             bug!("Closure is not defined by a closure expr");
 279                         };
 280                         let region_name = self.synthesize_region_name();
 281
 282                         let closure_kind_ty = substs.as_closure().kind_ty();
 283                         let note = match closure_kind_ty.to_opt_closure_kind() {
 284                             Some(ty::ClosureKind::Fn) => {
 285                                 "closure implements `Fn`, so references to captured variables \
 286                                  can't escape the closure"
 287                             }
 288                             Some(ty::ClosureKind::FnMut) => {
 289                                 "closure implements `FnMut`, so references to captured variables \
 290                                  can't escape the closure"
 291                             }
 292                             Some(ty::ClosureKind::FnOnce) => {
 293                                 bug!("BrEnv in a `FnOnce` closure");
 294                             }
 295                             None => bug!("Closure kind not inferred in borrow check"),
 296                         };
 297
 298                         Some(RegionName {
 299                             name: region_name,
 300                             source: RegionNameSource::SynthesizedFreeEnvRegion(
 301                                 args_span,
 302                                 note.to_string(),
 303                             ),
 304                         })
 305                     } else {
 306                         // Can't have BrEnv in functions, constants or generators.
 307                         bug!("BrEnv outside of closure.");
 308                     }
 309                 }
 310
 311                 ty::BoundRegion::BrAnon(_) => None,
 312             },
 313
 314             ty::ReLateBound(..)
 315             | ty::ReVar(..)
 316             | ty::RePlaceholder(..)
 317             | ty::ReEmpty(_)
 318             | ty::ReErased => None,
 319         }
 320     }
 321
 322     /// Finds an argument that contains `fr` and label it with a fully
 323     /// elaborated type, returning something like `'1`. Result looks
 324     /// like:
 325     ///
 326     /// ```text
 327     ///  | fn foo(x: &u32) { .. }
 328     ///           ------- fully elaborated type of `x` is `&'1 u32`
 329     /// ```
 330     fn give_name_if_anonymous_region_appears_in_arguments(
 331         &self,
 332         fr: RegionVid,
 333     ) -> Option<RegionName> {
 334         let implicit_inputs = self.regioncx.universal_regions().defining_ty.implicit_inputs();
 335         let argument_index = self.regioncx.get_argument_index_for_region(self.infcx.tcx, fr)?;
 336
 337         let arg_ty = self.regioncx.universal_regions().unnormalized_input_tys
 338             [implicit_inputs + argument_index];
 339         let (_, span) = self.regioncx.get_argument_name_and_span_for_region(
 340             &self.body,
 341             &self.local_names,
 342             argument_index,
 343         );
 344
 345         self.highlight_if_we_can_match_hir_ty_from_argument(fr, arg_ty, argument_index)
 346             .or_else(|| {
 347                 // `highlight_if_we_cannot_match_hir_ty` needs to know the number we will give to
 348                 // the anonymous region. If it succeeds, the `synthesize_region_name` call below
 349                 // will increment the counter, "reserving" the number we just used.
 350                 let counter = *self.next_region_name.try_borrow().unwrap();
 351                 self.highlight_if_we_cannot_match_hir_ty(fr, arg_ty, span, counter)
 352             })
 353             .map(|highlight| RegionName {
 354                 name: self.synthesize_region_name(),
 355                 source: RegionNameSource::AnonRegionFromArgument(highlight),
 356             })
 357     }
 358
 359     fn highlight_if_we_can_match_hir_ty_from_argument(
 360         &self,
 361         needle_fr: RegionVid,
 362         argument_ty: Ty<'tcx>,
 363         argument_index: usize,
 364     ) -> Option<RegionNameHighlight> {
 365         let mir_hir_id = self.infcx.tcx.hir().as_local_hir_id(self.mir_def_id);
 366         let fn_decl = self.infcx.tcx.hir().fn_decl_by_hir_id(mir_hir_id)?;
 367         let argument_hir_ty: &hir::Ty<'_> = fn_decl.inputs.get(argument_index)?;
 368         match argument_hir_ty.kind {
 369             // This indicates a variable with no type annotation, like
 370             // `|x|`... in that case, we can't highlight the type but
 371             // must highlight the variable.
 372             // NOTE(eddyb) this is handled in/by the sole caller
 373             // (`give_name_if_anonymous_region_appears_in_arguments`).
 374             hir::TyKind::Infer => None,
 375
 376             _ => self.highlight_if_we_can_match_hir_ty(needle_fr, argument_ty, argument_hir_ty),
 377         }
 378     }
 379
 380     /// Attempts to highlight the specific part of a type in an argument
 381     /// that has no type annotation.
 382     /// For example, we might produce an annotation like this:
 383     ///
 384     /// ```text
 385     ///  |     foo(|a, b| b)
 386     ///  |          -  -
 387     ///  |          |  |
 388     ///  |          |  has type `&'1 u32`
 389     ///  |          has type `&'2 u32`
 390     /// ```
 391     fn highlight_if_we_cannot_match_hir_ty(
 392         &self,
 393         needle_fr: RegionVid,
 394         ty: Ty<'tcx>,
 395         span: Span,
 396         counter: usize,
 397     ) -> Option<RegionNameHighlight> {
 398         let mut highlight = RegionHighlightMode::default();
 399         highlight.highlighting_region_vid(needle_fr, counter);
 400         let type_name = self.infcx.extract_type_name(&ty, Some(highlight)).0;
 401
 402         debug!(
 403             "highlight_if_we_cannot_match_hir_ty: type_name={:?} needle_fr={:?}",
 404             type_name, needle_fr
 405         );
 406         if type_name.find(&format!("'{}", counter)).is_some() {
 407             // Only add a label if we can confirm that a region was labelled.
 408
 409             Some(RegionNameHighlight::CannotMatchHirTy(span, type_name))
 410         } else {
 411             None
 412         }
 413     }
 414
 415     /// Attempts to highlight the specific part of a type annotation
 416     /// that contains the anonymous reference we want to give a name
 417     /// to. For example, we might produce an annotation like this:
 418     ///
 419     /// ```text
 420     ///  | fn a<T>(items: &[T]) -> Box<dyn Iterator<Item = &T>> {
 421     ///  |                - let's call the lifetime of this reference `'1`
 422     /// ```
 423     ///
 424     /// the way this works is that we match up `argument_ty`, which is
 425     /// a `Ty<'tcx>` (the internal form of the type) with
 426     /// `argument_hir_ty`, a `hir::Ty` (the syntax of the type
 427     /// annotation). We are descending through the types stepwise,
 428     /// looking in to find the region `needle_fr` in the internal
 429     /// type. Once we find that, we can use the span of the `hir::Ty`
 430     /// to add the highlight.
 431     ///
 432     /// This is a somewhat imperfect process, so along the way we also
 433     /// keep track of the **closest** type we've found. If we fail to
 434     /// find the exact `&` or `'_` to highlight, then we may fall back
 435     /// to highlighting that closest type instead.
 436     fn highlight_if_we_can_match_hir_ty(
 437         &self,
 438         needle_fr: RegionVid,
 439         argument_ty: Ty<'tcx>,
 440         argument_hir_ty: &hir::Ty<'_>,
 441     ) -> Option<RegionNameHighlight> {
 442         let search_stack: &mut Vec<(Ty<'tcx>, &hir::Ty<'_>)> =
 443             &mut vec![(argument_ty, argument_hir_ty)];
 444
 445         while let Some((ty, hir_ty)) = search_stack.pop() {
 446             match (&ty.kind, &hir_ty.kind) {
 447                 // Check if the `argument_ty` is `&'X ..` where `'X`
 448                 // is the region we are looking for -- if so, and we have a `&T`
 449                 // on the RHS, then we want to highlight the `&` like so:
 450                 //
 451                 //     &
 452                 //     - let's call the lifetime of this reference `'1`
 453                 (
 454                     ty::Ref(region, referent_ty, _),
 455                     hir::TyKind::Rptr(_lifetime, referent_hir_ty),
 456                 ) => {
 457                     if region.to_region_vid() == needle_fr {
 458                         // Just grab the first character, the `&`.
 459                         let source_map = self.infcx.tcx.sess.source_map();
 460                         let ampersand_span = source_map.start_point(hir_ty.span);
 461
 462                         return Some(RegionNameHighlight::MatchedHirTy(ampersand_span));
 463                     }
 464
 465                     // Otherwise, let's descend into the referent types.
 466                     search_stack.push((referent_ty, &referent_hir_ty.ty));
 467                 }
 468
 469                 // Match up something like `Foo<'1>`
 470                 (
 471                     ty::Adt(_adt_def, substs),
 472                     hir::TyKind::Path(hir::QPath::Resolved(None, path)),
 473                 ) => {
 474                     match path.res {
 475                         // Type parameters of the type alias have no reason to
 476                         // be the same as those of the ADT.
 477                         // FIXME: We should be able to do something similar to
 478                         // match_adt_and_segment in this case.
 479                         Res::Def(DefKind::TyAlias, _) => (),
 480                         _ => {
 481                             if let Some(last_segment) = path.segments.last() {
 482                                 if let Some(highlight) = self.match_adt_and_segment(
 483                                     substs,
 484                                     needle_fr,
 485                                     last_segment,
 486                                     search_stack,
 487                                 ) {
 488                                     return Some(highlight);
 489                                 }
 490                             }
 491                         }
 492                     }
 493                 }
 494
 495                 // The following cases don't have lifetimes, so we
 496                 // just worry about trying to match up the rustc type
 497                 // with the HIR types:
 498                 (ty::Tuple(elem_tys), hir::TyKind::Tup(elem_hir_tys)) => {
 499                     search_stack.extend(elem_tys.iter().map(|k| k.expect_ty()).zip(*elem_hir_tys));
 500                 }
 501
 502                 (ty::Slice(elem_ty), hir::TyKind::Slice(elem_hir_ty))
 503                 | (ty::Array(elem_ty, _), hir::TyKind::Array(elem_hir_ty, _)) => {
 504                     search_stack.push((elem_ty, elem_hir_ty));
 505                 }
 506
 507                 (ty::RawPtr(mut_ty), hir::TyKind::Ptr(mut_hir_ty)) => {
 508                     search_stack.push((mut_ty.ty, &mut_hir_ty.ty));
 509                 }
 510
 511                 _ => {
 512                     // FIXME there are other cases that we could trace
 513                 }
 514             }
 515         }
 516
 517         None
 518     }
 519
 520     /// We've found an enum/struct/union type with the substitutions
 521     /// `substs` and -- in the HIR -- a path type with the final
 522     /// segment `last_segment`. Try to find a `'_` to highlight in
 523     /// the generic args (or, if not, to produce new zipped pairs of
 524     /// types+hir to search through).
 525     fn match_adt_and_segment<'hir>(
 526         &self,
 527         substs: SubstsRef<'tcx>,
 528         needle_fr: RegionVid,
 529         last_segment: &'hir hir::PathSegment<'hir>,
 530         search_stack: &mut Vec<(Ty<'tcx>, &'hir hir::Ty<'hir>)>,
 531     ) -> Option<RegionNameHighlight> {
 532         // Did the user give explicit arguments? (e.g., `Foo<..>`)
 533         let args = last_segment.args.as_ref()?;
 534         let lifetime =
 535             self.try_match_adt_and_generic_args(substs, needle_fr, args, search_stack)?;
 536         match lifetime.name {
 537             hir::LifetimeName::Param(_)
 538             | hir::LifetimeName::Error
 539             | hir::LifetimeName::Static
 540             | hir::LifetimeName::Underscore => {
 541                 let lifetime_span = lifetime.span;
 542                 Some(RegionNameHighlight::MatchedAdtAndSegment(lifetime_span))
 543             }
 544
 545             hir::LifetimeName::ImplicitObjectLifetimeDefault | hir::LifetimeName::Implicit => {
 546                 // In this case, the user left off the lifetime; so
 547                 // they wrote something like:
 548                 //
 549                 // ```
 550                 // x: Foo<T>
 551                 // ```
 552                 //
 553                 // where the fully elaborated form is `Foo<'_, '1,
 554                 // T>`. We don't consider this a match; instead we let
 555                 // the "fully elaborated" type fallback above handle
 556                 // it.
 557                 None
 558             }
 559         }
 560     }
 561
 562     /// We've found an enum/struct/union type with the substitutions
 563     /// `substs` and -- in the HIR -- a path with the generic
 564     /// arguments `args`. If `needle_fr` appears in the args, return
 565     /// the `hir::Lifetime` that corresponds to it. If not, push onto
 566     /// `search_stack` the types+hir to search through.
 567     fn try_match_adt_and_generic_args<'hir>(
 568         &self,
 569         substs: SubstsRef<'tcx>,
 570         needle_fr: RegionVid,
 571         args: &'hir hir::GenericArgs<'hir>,
 572         search_stack: &mut Vec<(Ty<'tcx>, &'hir hir::Ty<'hir>)>,
 573     ) -> Option<&'hir hir::Lifetime> {
 574         for (kind, hir_arg) in substs.iter().zip(args.args) {
 575             match (kind.unpack(), hir_arg) {
 576                 (GenericArgKind::Lifetime(r), hir::GenericArg::Lifetime(lt)) => {
 577                     if r.to_region_vid() == needle_fr {
 578                         return Some(lt);
 579                     }
 580                 }
 581
 582                 (GenericArgKind::Type(ty), hir::GenericArg::Type(hir_ty)) => {
 583                     search_stack.push((ty, hir_ty));
 584                 }
 585
 586                 (GenericArgKind::Const(_ct), hir::GenericArg::Const(_hir_ct)) => {
 587                     // Lifetimes cannot be found in consts, so we don't need
 588                     // to search anything here.
 589                 }
 590
 591                 (
 592                     GenericArgKind::Lifetime(_)
 593                     | GenericArgKind::Type(_)
 594                     | GenericArgKind::Const(_),
 595                     _,
 596                 ) => {
 597                     // I *think* that HIR lowering should ensure this
 598                     // doesn't happen, even in erroneous
 599                     // programs. Else we should use delay-span-bug.
 600                     span_bug!(
 601                         hir_arg.span(),
 602                         "unmatched subst and hir arg: found {:?} vs {:?}",
 603                         kind,
 604                         hir_arg,
 605                     );
 606                 }
 607             }
 608         }
 609
 610         None
 611     }
 612
 613     /// Finds a closure upvar that contains `fr` and label it with a
 614     /// fully elaborated type, returning something like `'1`. Result
 615     /// looks like:
 616     ///
 617     /// ```text
 618     ///  | let x = Some(&22);
 619     ///        - fully elaborated type of `x` is `Option<&'1 u32>`
 620     /// ```
 621     fn give_name_if_anonymous_region_appears_in_upvars(&self, fr: RegionVid) -> Option<RegionName> {
 622         let upvar_index = self.regioncx.get_upvar_index_for_region(self.infcx.tcx, fr)?;
 623         let (upvar_name, upvar_span) = self.regioncx.get_upvar_name_and_span_for_region(
 624             self.infcx.tcx,
 625             &self.upvars,
 626             upvar_index,
 627         );
 628         let region_name = self.synthesize_region_name();
 629
 630         Some(RegionName {
 631             name: region_name,
 632             source: RegionNameSource::AnonRegionFromUpvar(upvar_span, upvar_name.to_string()),
 633         })
 634     }
 635
 636     /// Checks for arguments appearing in the (closure) return type. It
 637     /// must be a closure since, in a free fn, such an argument would
 638     /// have to either also appear in an argument (if using elision)
 639     /// or be early bound (named, not in argument).
 640     fn give_name_if_anonymous_region_appears_in_output(&self, fr: RegionVid) -> Option<RegionName> {
 641         let tcx = self.infcx.tcx;
 642
 643         let return_ty = self.regioncx.universal_regions().unnormalized_output_ty;
 644         debug!("give_name_if_anonymous_region_appears_in_output: return_ty = {:?}", return_ty);
 645         if !tcx.any_free_region_meets(&return_ty, |r| r.to_region_vid() == fr) {
 646             return None;
 647         }
 648
 649         let mut highlight = RegionHighlightMode::default();
 650         highlight.highlighting_region_vid(fr, *self.next_region_name.try_borrow().unwrap());
 651         let type_name = self.infcx.extract_type_name(&return_ty, Some(highlight)).0;
 652
 653         let mir_hir_id = tcx.hir().as_local_hir_id(self.mir_def_id);
 654
 655         let (return_span, mir_description) = match tcx.hir().get(mir_hir_id) {
 656             hir::Node::Expr(hir::Expr {
 657                 kind: hir::ExprKind::Closure(_, return_ty, _, span, gen_move),
 658                 ..
 659             }) => (
 660                 match return_ty.output {
 661                     hir::FnRetTy::DefaultReturn(_) => tcx.sess.source_map().end_point(*span),
 662                     hir::FnRetTy::Return(_) => return_ty.output.span(),
 663                 },
 664                 if gen_move.is_some() { " of generator" } else { " of closure" },
 665             ),
 666             hir::Node::ImplItem(hir::ImplItem {
 667                 kind: hir::ImplItemKind::Fn(method_sig, _),
 668                 ..
 669             }) => (method_sig.decl.output.span(), ""),
 670             _ => (self.body.span, ""),
 671         };
 672
 673         Some(RegionName {
 674             // This counter value will already have been used, so this function will increment it
 675             // so the next value will be used next and return the region name that would have been
 676             // used.
 677             name: self.synthesize_region_name(),
 678             source: RegionNameSource::AnonRegionFromOutput(
 679                 return_span,
 680                 mir_description.to_string(),
 681                 type_name,
 682             ),
 683         })
 684     }
 685
 686     fn give_name_if_anonymous_region_appears_in_yield_ty(
 687         &self,
 688         fr: RegionVid,
 689     ) -> Option<RegionName> {
 690         // Note: generators from `async fn` yield `()`, so we don't have to
 691         // worry about them here.
 692         let yield_ty = self.regioncx.universal_regions().yield_ty?;
 693         debug!("give_name_if_anonymous_region_appears_in_yield_ty: yield_ty = {:?}", yield_ty,);
 694
 695         let tcx = self.infcx.tcx;
 696
 697         if !tcx.any_free_region_meets(&yield_ty, |r| r.to_region_vid() == fr) {
 698             return None;
 699         }
 700
 701         let mut highlight = RegionHighlightMode::default();
 702         highlight.highlighting_region_vid(fr, *self.next_region_name.try_borrow().unwrap());
 703         let type_name = self.infcx.extract_type_name(&yield_ty, Some(highlight)).0;
 704
 705         let mir_hir_id = tcx.hir().as_local_hir_id(self.mir_def_id);
 706
 707         let yield_span = match tcx.hir().get(mir_hir_id) {
 708             hir::Node::Expr(hir::Expr {
 709                 kind: hir::ExprKind::Closure(_, _, _, span, _), ..
 710             }) => (tcx.sess.source_map().end_point(*span)),
 711             _ => self.body.span,
 712         };
 713
 714         debug!(
 715             "give_name_if_anonymous_region_appears_in_yield_ty: \
 716              type_name = {:?}, yield_span = {:?}",
 717             yield_span, type_name,
 718         );
 719
 720         Some(RegionName {
 721             name: self.synthesize_region_name(),
 722             source: RegionNameSource::AnonRegionFromYieldTy(yield_span, type_name),
 723         })
 724     }
 725 }