Struct rustc_middle::ty::sty::Region

source ·
pub struct Region<'tcx>(pub Interned<'tcx, RegionKind<'tcx>>);
Expand description

Use this rather than RegionKind, whenever possible.

Tuple Fields§

§0: Interned<'tcx, RegionKind<'tcx>>

Implementations§

source§

impl<'tcx> Region<'tcx>

Region utilities

source

pub fn kind(self) -> RegionKind<'tcx>

source

pub fn get_name(self) -> Option<Symbol>

source

pub fn has_name(self) -> bool

Is this region named by the user?

source

pub fn is_static(self) -> bool

source

pub fn is_erased(self) -> bool

source

pub fn is_late_bound(self) -> bool

source

pub fn is_placeholder(self) -> bool

source

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

source

pub fn type_flags(self) -> TypeFlags

source

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.

source

pub fn is_free(self) -> bool

True for free regions other than 'static.

source

pub fn is_free_or_static(self) -> bool

True if self is a free region or static.

source

pub fn is_var(self) -> bool

Trait Implementations§

source§

impl<'tcx> Clone for Region<'tcx>

source§

fn clone(&self) -> Region<'tcx>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'tcx> Debug for Region<'tcx>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'tcx, D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<D> for Region<'tcx>

source§

fn decode(decoder: &mut D) -> Self

source§

impl<'tcx> Deref for Region<'tcx>

§

type Target = RegionKind<TyCtxt<'tcx>>

The resulting type after dereferencing.
source§

fn deref(&self) -> &RegionKind<'tcx>

Dereferences the value.
source§

impl<'tcx> Display for Region<'tcx>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'tcx, E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<E> for Region<'tcx>

source§

fn encode(&self, e: &mut E)

source§

impl<'tcx> From<Region<'tcx>> for GenericArg<'tcx>

source§

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

Converts to this type from the input type.
source§

impl<'tcx> Hash for Region<'tcx>

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for Region<'tcx>

source§

fn hash_stable(
&self,
__hcx: &mut StableHashingContext<'__ctx>,
__hasher: &mut StableHasher
)

source§

impl<'a, 'tcx> Lift<'tcx> for Region<'a>

§

type Lifted = Region<'tcx>

source§

fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted>

source§

impl<'tcx> Ord for Region<'tcx>

source§

fn cmp(&self, other: &Region<'tcx>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere
Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Selfwhere
Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl<'tcx> PartialEq<Region<'tcx>> for Region<'tcx>

source§

fn eq(&self, other: &Region<'tcx>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'tcx> PartialOrd<Region<'tcx>> for Region<'tcx>

source§

fn partial_cmp(&self, other: &Region<'tcx>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

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

§

type Output = <P as Printer<'tcx>>::Region

§

type Error = <P as Printer<'tcx>>::Error

source§

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

source§

impl<'tcx> Relate<'tcx> for Region<'tcx>

source§

fn relate<R: TypeRelation<'tcx>>(
relation: &mut R,
a: Region<'tcx>,
b: Region<'tcx>
) -> RelateResult<'tcx, Region<'tcx>>

source§

impl<'tcx> TypeFoldable<'tcx> for Region<'tcx>

source§

fn try_fold_with<F: FallibleTypeFolder<'tcx>>(
self,
folder: &mut F
) -> Result<Self, F::Error>

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f). Read more
source§

fn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.
source§

impl<'tcx> TypeSuperFoldable<'tcx> for Region<'tcx>

source§

fn try_super_fold_with<F: FallibleTypeFolder<'tcx>>(
self,
_folder: &mut F
) -> Result<Self, F::Error>

Provides a default fold for a type of interest. This should only be called within TypeFolder methods, when a non-custom traversal is desired for the value of the type of interest passed to that method. For example, in MyFolder::try_fold_ty(ty), it is valid to call ty.try_super_fold_with(self), but any other folding should be done with xyz.try_fold_with(self).
source§

fn super_fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

A convenient alternative to try_super_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_super_fold_with.
source§

impl<'tcx> TypeSuperVisitable<'tcx> for Region<'tcx>

source§

fn super_visit_with<V: TypeVisitor<'tcx>>(
&self,
_visitor: &mut V
) -> ControlFlow<V::BreakTy>

Provides a default visit for a type of interest. This should only be called within TypeVisitor methods, when a non-custom traversal is desired for the value of the type of interest passed to that method. For example, in MyVisitor::visit_ty(ty), it is valid to call ty.super_visit_with(self), but any other visiting should be done with xyz.visit_with(self).
source§

impl<'tcx> TypeVisitable<'tcx> for Region<'tcx>

source§

fn visit_with<V: TypeVisitor<'tcx>>(
&self,
visitor: &mut V
) -> ControlFlow<V::BreakTy>

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v). Read more
source§

fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool

Returns true if self has any late-bound regions that are either bound by binder or bound by some binder outside of binder. If binder is ty::INNERMOST, this indicates whether there are any late-bound regions that appear free.
source§

fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns true if this type has any regions that escape binder (and hence are not bound by it).
source§

fn has_escaping_bound_vars(&self) -> bool

Return true if this type has regions that are not a part of the type. For example, for<'a> fn(&'a i32) return false, while fn(&'a i32) would return true. The latter can occur when traversing through the former. Read more
source§

fn has_type_flags(&self, flags: TypeFlags) -> bool

source§

fn has_projections(&self) -> bool

source§

fn has_opaque_types(&self) -> bool

source§

fn has_generators(&self) -> bool

source§

fn references_error(&self) -> bool

source§

fn error_reported(&self) -> Result<(), ErrorGuaranteed>

source§

fn has_non_region_param(&self) -> bool

source§

fn has_infer_regions(&self) -> bool

source§

fn has_infer_types(&self) -> bool

source§

fn has_non_region_infer(&self) -> bool

source§

fn needs_infer(&self) -> bool

source§

fn has_placeholders(&self) -> bool

source§

fn needs_subst(&self) -> bool

source§

fn has_free_regions(&self) -> bool

“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound.
source§

fn has_erased_regions(&self) -> bool

source§

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.
source§

fn is_global(&self) -> bool

Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching.
source§

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions
source§

fn has_non_region_late_bound(&self) -> bool

True if there are any late-bound non-region variables
source§

fn has_late_bound_vars(&self) -> bool

True if there are any late-bound variables
source§

fn still_further_specializable(&self) -> bool

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of impl specialization.
source§

impl<'tcx> Copy for Region<'tcx>

source§

impl<'tcx> Eq for Region<'tcx>

source§

impl<'tcx> StructuralEq for Region<'tcx>

source§

impl<'tcx> StructuralPartialEq for Region<'tcx>

Auto Trait Implementations§

§

impl<'tcx> RefUnwindSafe for Region<'tcx>

§

impl<'tcx> !Send for Region<'tcx>

§

impl<'tcx> !Sync for Region<'tcx>

§

impl<'tcx> Unpin for Region<'tcx>

§

impl<'tcx> UnwindSafe for Region<'tcx>

Blanket Implementations§

source§

impl<T> Any for Twhere
T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,

source§

fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T

source§

fn allocate_from_iter<'a>(
arena: &'a Arena<'tcx>,
iter: impl IntoIterator<Item = T>
) -> &'a mut [T]

source§

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Tcx, T> DepNodeParams<Tcx> for Twhere
Tcx: DepContext,
T: for<'a> HashStable<StableHashingContext<'a>> + Debug,

source§

default fn fingerprint_style() -> FingerprintStyle

source§

default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint

This method turns the parameters of a DepNodeConstructor into an opaque Fingerprint to be used in DepNode. Not all DepNodeParams support being turned into a Fingerprint (they don’t need to if the corresponding DepNode is anonymous).
source§

default fn to_debug_str(&self, _: Tcx) -> String

source§

default fn recover(
_: Tcx,
_: &DepNode<<Tcx as DepContext>::DepKind>
) -> Option<T>

This method tries to recover the query key from the given DepNode, something which is needed when forcing DepNodes during red-green evaluation. The query system will only call this method if fingerprint_style() is not FingerprintStyle::Opaque. It is always valid to return None here, in which case incremental compilation will treat the query as having changed instead of forcing it.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, R> InternIteratorElement<T, R> for T

§

type Output = R

source§

fn intern_with<I, F>(iter: I, f: F) -> <T as InternIteratorElement<T, R>>::Outputwhere
I: Iterator<Item = T>,
F: FnOnce(&[T]) -> R,

source§

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> MaybeResult<T> for T

§

type Error = !

source§

fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

source§

fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

source§

impl<T> ToOwned for Twhere
T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<'tcx, T> ToPredicate<'tcx, T> for T

source§

fn to_predicate(self, _tcx: TyCtxt<'tcx>) -> T

source§

impl<T> ToString for Twhere
T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<Tcx, T, D> Value<Tcx, D> for Twhere
Tcx: DepContext,
D: DepKind,

source§

default fn from_cycle_error(tcx: Tcx, _: &[QueryInfo<D>]) -> T

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes