Enum rustc_middle::ty::sty::RegionKind

pub enum RegionKind {
    ReEarlyBound(EarlyBoundRegion),
    ReLateBound(DebruijnIndex, BoundRegion),
    ReFree(FreeRegion),
    ReStatic,
    ReVar(RegionVid),
    RePlaceholder(PlaceholderRegion),
    ReEmpty(UniverseIndex),
    ReErased,
}

Representation of regions. Note that the NLL checker uses a distinct representation of regions. For this reason, it internally replaces all the regions with inference variables -- the index of the variable is then used to index into internal NLL data structures. See rustc_mir::borrow_check module for more information.

The Region lattice within a given function

In general, the region lattice looks like

static ----------+-----...------+       (greatest)
|                |              |
early-bound and  |              |
free regions     |              |
|                |              |
|                |              |
empty(root)   placeholder(U1)   |
|            /                  |
|           /         placeholder(Un)
empty(U1) --         /
|                   /
...                /
|                 /
empty(Un) --------                      (smallest)

Early-bound/free regions are the named lifetimes in scope from the function declaration. They have relationships to one another determined based on the declared relationships from the function.

Note that inference variables and bound regions are not included in this diagram. In the case of inference variables, they should be inferred to some other region from the diagram. In the case of bound regions, they are excluded because they don't make sense to include -- the diagram indicates the relationship between free regions.

Inference variables

During region inference, we sometimes create inference variables, represented as ReVar. These will be inferred by the code in infer::lexical_region_resolve to some free region from the lattice above (the minimal region that meets the constraints).

During NLL checking, where regions are defined differently, we also use ReVar -- in that case, the index is used to index into the NLL region checker's data structures. The variable may in fact represent either a free region or an inference variable, in that case.

Bound Regions

These are regions that are stored behind a binder and must be substituted with some concrete region before being used. There are two kind of bound regions: early-bound, which are bound in an item's Generics, and are substituted by a InternalSubsts, and late-bound, which are part of higher-ranked types (e.g., for<'a> fn(&'a ())), and are substituted by the likes of liberate_late_bound_regions. The distinction exists because higher-ranked lifetimes aren't supported in all places. See 1.

Unlike Params, bound regions are not supposed to exist "in the wild" outside their binder, e.g., in types passed to type inference, and should first be substituted (by placeholder regions, free regions, or region variables).

Placeholder and Free Regions

One often wants to work with bound regions without knowing their precise identity. For example, when checking a function, the lifetime of a borrow can end up being assigned to some region parameter. In these cases, it must be ensured that bounds on the region can't be accidentally assumed without being checked.

To do this, we replace the bound regions with placeholder markers, which don't satisfy any relation not explicitly provided.

There are two kinds of placeholder regions in rustc: ReFree and RePlaceholder. When checking an item's body, ReFree is supposed to be used. These also support explicit bounds: both the internally-stored scope, which the region is assumed to outlive, as well as other relations stored in the FreeRegionMap. Note that these relations aren't checked when you make_subregion (or eq_types), only by resolve_regions_and_report_errors.

When working with higher-ranked types, some region relations aren't yet known, so you can't just call resolve_regions_and_report_errors. RePlaceholder is designed for this purpose. In these contexts, there's also the risk that some inference variable laying around will get unified with your placeholder region: if you want to check whether for<'a> Foo<'_>: 'a, and you substitute your bound region 'a with a placeholder region '%a, the variable '_ would just be instantiated to the placeholder region '%a, which is wrong because the inference variable is supposed to satisfy the relation for every value of the placeholder region. To ensure that doesn't happen, you can use leak_check. This is more clearly explained by the rustc dev guide.

Variants

ReEarlyBound(EarlyBoundRegion)

Region bound in a type or fn declaration which will be substituted 'early' -- that is, at the same time when type parameters are substituted.

ReLateBound(DebruijnIndex, BoundRegion)

Region bound in a function scope, which will be substituted when the function is called.

ReFree(FreeRegion)

When checking a function body, the types of all arguments and so forth that refer to bound region parameters are modified to refer to free region parameters.

ReStatic

Static data that has an "infinite" lifetime. Top in the region lattice.

ReVar(RegionVid)

A region variable. Should not exist after typeck.

RePlaceholder(PlaceholderRegion)

A placeholder region -- basically, the higher-ranked version of ReFree. Should not exist after typeck.

ReEmpty(UniverseIndex)

Empty lifetime is for data that is never accessed. We tag the empty lifetime with a universe -- the idea is that we don't want exists<'a> { forall<'b> { 'b: 'a } } to be satisfiable. Therefore, the 'empty in a universe U is less than all regions visible from U, but not less than regions not visible from U.

ReErased

Erased region, used by trait selection, in MIR and during codegen.

Implementations

impl RegionKind

Region utilities

pub fn has_name(&self) -> bool

Is this region named by the user?

pub fn is_late_bound(&self) -> bool

pub fn is_placeholder(&self) -> bool

pub fn bound_at_or_above_binder(&self, index: DebruijnIndex) -> bool

pub fn shifted_out_to_binder(&self, to_binder: DebruijnIndex) -> RegionKind

Adjusts any De Bruijn indices so as to make to_binder the innermost binder. That is, if we have something bound at to_binder, it will now be bound at INNERMOST. This is an appropriate thing to do when moving a region out from inside binders:

            for<'a>   fn(for<'b>   for<'c>   fn(&'a u32), _)
// Binder:  D3           D2        D1            ^^

Here, the region 'a would have the De Bruijn index D3, because it is the bound 3 binders out. However, if we wanted to refer to that region 'a in the second argument (the _), those two binders would not be in scope. In that case, we might invoke shift_out_to_binder(D3). This would adjust the De Bruijn index of 'a to D1 (the innermost binder).

If we invoke shift_out_to_binder and the region is in fact bound by one of the binders we are shifting out of, that is an error (and should fail an assertion failure).

pub fn type_flags(&self) -> TypeFlags

pub fn free_region_binding_scope(&self, tcx: TyCtxt<'_>) -> DefId

Given an early-bound or free region, returns the DefId where it was bound. For example, consider the regions in this snippet of code:

impl<'a> Foo {
     ^^ -- early bound, declared on an impl

    fn bar<'b, 'c>(x: &self, y: &'b u32, z: &'c u64) where 'static: 'c
           ^^  ^^     ^ anonymous, late-bound
           |   early-bound, appears in where-clauses
           late-bound, appears only in fn args
    {..}
}

Here, free_region_binding_scope('a) would return the DefId of the impl, and for all the other highlighted regions, it would return the DefId of the function. In other cases (not shown), this function might return the DefId of a closure.

Trait Implementations

impl<'tcx> Borrow<RegionKind> for Interned<'tcx, RegionKind>

pub fn borrow(&self) -> &RegionKind

Immutably borrows from an owned value.

impl Clone for RegionKind

pub fn clone(&self) -> RegionKind

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for RegionKind

impl Debug for RegionKind

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<'tcx>> Decodable<__D> for RegionKind

pub fn decode(__decoder: &mut __D) -> Result<Self, <__D as Decoder>::Error>

impl Display for RegionKind

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'tcx, __E: TyEncoder<'tcx>> Encodable<__E> for RegionKind

pub fn encode(&self, __encoder: &mut __E) -> Result<(), <__E as Encoder>::Error>

impl Eq for RegionKind

impl<'tcx> From<&'tcx RegionKind> for GenericArg<'tcx>

pub fn from(r: Region<'tcx>) -> GenericArg<'tcx>

Performs the conversion.

impl Hash for RegionKind

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> HashStable<StableHashingContext<'a>> for RegionKind

pub fn hash_stable(
    &self,
    hcx: &mut StableHashingContext<'a>,
    hasher: &mut StableHasher
)

impl Ord for RegionKind

pub fn cmp(&self, other: &RegionKind) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<RegionKind> for RegionKind

pub fn eq(&self, other: &RegionKind) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &RegionKind) -> bool

This method tests for !=.

impl PartialOrd<RegionKind> for RegionKind

pub fn partial_cmp(&self, other: &RegionKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &RegionKind) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &RegionKind) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &RegionKind) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &RegionKind) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'tcx, P: Printer<'tcx>> Print<'tcx, P> for RegionKind

type Output = P::Region

type Error = P::Error

pub fn print(&self, cx: P) -> Result<Self::Output, Self::Error>

impl StructuralEq for RegionKind

impl StructuralPartialEq for RegionKind