Struct rustc_borrowck::region_infer::values::RegionValues
source · pub(crate) struct RegionValues<N: Idx> {
elements: Rc<RegionValueElements>,
placeholder_indices: Rc<PlaceholderIndices>,
points: SparseIntervalMatrix<N, PointIndex>,
free_regions: SparseBitMatrix<N, RegionVid>,
placeholders: SparseBitMatrix<N, PlaceholderIndex>,
}
Expand description
Stores the full values for a set of regions (in contrast to
LivenessValues
, which only stores those points in the where a
region is live). The full value for a region may contain points in
the CFG, but also free regions as well as bound universe
placeholders.
Example:
fn foo(x: &'a u32) -> &'a u32 {
let y: &'0 u32 = x; // let's call this `'0`
y
}
Here, the variable '0
would contain the free region 'a
,
because (since it is returned) it must live for at least 'a
. But
it would also contain various points from within the function.
Fields
elements: Rc<RegionValueElements>
placeholder_indices: Rc<PlaceholderIndices>
points: SparseIntervalMatrix<N, PointIndex>
free_regions: SparseBitMatrix<N, RegionVid>
placeholders: SparseBitMatrix<N, PlaceholderIndex>
Placeholders represent bound regions – so something like 'a
in for<’a> fn(&’a u32)`.
Implementations
sourceimpl<N: Idx> RegionValues<N>
impl<N: Idx> RegionValues<N>
sourcepub(crate) fn new(
elements: &Rc<RegionValueElements>,
num_universal_regions: usize,
placeholder_indices: &Rc<PlaceholderIndices>
) -> Self
pub(crate) fn new(
elements: &Rc<RegionValueElements>,
num_universal_regions: usize,
placeholder_indices: &Rc<PlaceholderIndices>
) -> Self
Creates a new set of “region values” that tracks causal information. Each of the regions in num_region_variables will be initialized with an empty set of points and no causal information.
sourcepub(crate) fn add_element(&mut self, r: N, elem: impl ToElementIndex) -> bool
pub(crate) fn add_element(&mut self, r: N, elem: impl ToElementIndex) -> bool
Adds the given element to the value for the given region. Returns whether the element is newly added (i.e., was not already present).
sourcepub(crate) fn add_all_points(&mut self, r: N)
pub(crate) fn add_all_points(&mut self, r: N)
Adds all the control-flow points to the values for r
.
sourcepub(crate) fn add_region(&mut self, r_to: N, r_from: N) -> bool
pub(crate) fn add_region(&mut self, r_to: N, r_from: N) -> bool
Adds all elements in r_from
to r_to
(because e.g., r_to: r_from
).
sourcepub(crate) fn contains(&self, r: N, elem: impl ToElementIndex) -> bool
pub(crate) fn contains(&self, r: N, elem: impl ToElementIndex) -> bool
Returns true
if the region r
contains the given element.
sourcepub(crate) fn merge_liveness<M: Idx>(
&mut self,
to: N,
from: M,
values: &LivenessValues<M>
)
pub(crate) fn merge_liveness<M: Idx>(
&mut self,
to: N,
from: M,
values: &LivenessValues<M>
)
self[to] |= values[from]
, essentially: that is, take all the
elements for the region from
from values
and add them to
the region to
in self
.
sourcepub(crate) fn contains_points(&self, sup_region: N, sub_region: N) -> bool
pub(crate) fn contains_points(&self, sup_region: N, sub_region: N) -> bool
Returns true
if sup_region
contains all the CFG points that
sub_region
contains. Ignores universal regions.
sourcepub(crate) fn locations_outlived_by<'a>(
&'a self,
r: N
) -> impl Iterator<Item = Location> + 'a
pub(crate) fn locations_outlived_by<'a>(
&'a self,
r: N
) -> impl Iterator<Item = Location> + 'a
Returns the locations contained within a given region r
.
sourcepub(crate) fn universal_regions_outlived_by<'a>(
&'a self,
r: N
) -> impl Iterator<Item = RegionVid> + 'a
pub(crate) fn universal_regions_outlived_by<'a>(
&'a self,
r: N
) -> impl Iterator<Item = RegionVid> + 'a
Returns just the universal regions that are contained in a given region’s value.
sourcepub(crate) fn placeholders_contained_in<'a>(
&'a self,
r: N
) -> impl Iterator<Item = PlaceholderRegion> + 'a
pub(crate) fn placeholders_contained_in<'a>(
&'a self,
r: N
) -> impl Iterator<Item = PlaceholderRegion> + 'a
Returns all the elements contained in a given region’s value.
sourcepub(crate) fn elements_contained_in<'a>(
&'a self,
r: N
) -> impl Iterator<Item = RegionElement> + 'a
pub(crate) fn elements_contained_in<'a>(
&'a self,
r: N
) -> impl Iterator<Item = RegionElement> + 'a
Returns all the elements contained in a given region’s value.
sourcepub(crate) fn region_value_str(&self, r: N) -> String
pub(crate) fn region_value_str(&self, r: N) -> String
Returns a “pretty” string value of the region. Meant for debugging.
Trait Implementations
sourceimpl<N: Clone + Idx> Clone for RegionValues<N>
impl<N: Clone + Idx> Clone for RegionValues<N>
sourcefn clone(&self) -> RegionValues<N>
fn clone(&self) -> RegionValues<N>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations
impl<N> RefUnwindSafe for RegionValues<N>
impl<N> !Send for RegionValues<N>
impl<N> !Sync for RegionValues<N>
impl<N> Unpin for RegionValues<N>
impl<N> UnwindSafe for RegionValues<N>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
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: 112 bytes