Struct rustc_pattern_analysis::IndexVec
source · #[repr(transparent)]pub struct IndexVec<I, T>where
I: Idx,{
pub raw: Vec<T>,
_marker: PhantomData<fn(_: &I)>,
}
Expand description
An owned contiguous collection of T
s, indexed by I
rather than by usize
.
§Why use this instead of a Vec
?
An IndexVec
allows element access only via a specific associated index type, meaning that
trying to use the wrong index type (possibly accessing an invalid element) will fail at
compile time.
It also documents what the index is indexing: in a HashMap<usize, Something>
it’s not
immediately clear what the usize
means, while a HashMap<FieldIdx, Something>
makes it obvious.
use rustc_index::{Idx, IndexVec};
fn f<I1: Idx, I2: Idx>(vec1: IndexVec<I1, u8>, idx1: I1, idx2: I2) {
&vec1[idx1]; // Ok
&vec1[idx2]; // Compile error!
}
While it’s possible to use u32
or usize
directly for I
,
you almost certainly want to use a newtype_index!
-generated type instead.
This allows to index the IndexVec with the new index type.
Fields§
§raw: Vec<T>
§_marker: PhantomData<fn(_: &I)>
Implementations§
source§impl<I, T> IndexVec<I, T>where
I: Idx,
impl<I, T> IndexVec<I, T>where
I: Idx,
sourcepub const fn from_raw(raw: Vec<T>) -> IndexVec<I, T>
pub const fn from_raw(raw: Vec<T>) -> IndexVec<I, T>
Constructs a new IndexVec<I, T>
from a Vec<T>
.
pub fn with_capacity(capacity: usize) -> IndexVec<I, T>
sourcepub fn from_elem<S>(elem: T, universe: &IndexSlice<I, S>) -> IndexVec<I, T>where
T: Clone,
pub fn from_elem<S>(elem: T, universe: &IndexSlice<I, S>) -> IndexVec<I, T>where
T: Clone,
Creates a new vector with a copy of elem
for each index in universe
.
Thus IndexVec::from_elem(elem, &universe)
is equivalent to
IndexVec::<I, _>::from_elem_n(elem, universe.len())
. That can help
type inference as it ensures that the resulting vector uses the same
index type as universe
, rather than something potentially surprising.
For example, if you want to store data for each local in a MIR body,
using let mut uses = IndexVec::from_elem(vec![], &body.local_decls);
ensures that uses
is an IndexVec<Local, _>
, and thus can give
better error messages later if one accidentally mismatches indices.
sourcepub fn from_elem_n(elem: T, n: usize) -> IndexVec<I, T>where
T: Clone,
pub fn from_elem_n(elem: T, n: usize) -> IndexVec<I, T>where
T: Clone,
Creates a new IndexVec with n copies of the elem
.
sourcepub fn from_fn_n(func: impl FnMut(I) -> T, n: usize) -> IndexVec<I, T>
pub fn from_fn_n(func: impl FnMut(I) -> T, n: usize) -> IndexVec<I, T>
Create an IndexVec
with n
elements, where the value of each
element is the result of func(i)
. (The underlying vector will
be allocated only once, with a capacity of at least n
.)
pub fn as_slice(&self) -> &IndexSlice<I, T>
pub fn as_mut_slice(&mut self) -> &mut IndexSlice<I, T>
sourcepub fn push(&mut self, d: T) -> I
pub fn push(&mut self, d: T) -> I
Pushes an element to the array returning the index where it was pushed to.
pub fn pop(&mut self) -> Option<T>
pub fn into_iter(self) -> IntoIter<T>
pub fn into_iter_enumerated( self, ) -> impl DoubleEndedIterator + ExactSizeIterator
pub fn drain<R>(&mut self, range: R) -> impl Iterator<Item = T>where
R: RangeBounds<usize>,
pub fn drain_enumerated<R>(&mut self, range: R) -> impl Iterator<Item = (I, T)>where
R: RangeBounds<usize>,
pub fn shrink_to_fit(&mut self)
pub fn truncate(&mut self, a: usize)
sourcepub fn ensure_contains_elem(
&mut self,
elem: I,
fill_value: impl FnMut() -> T,
) -> &mut T
pub fn ensure_contains_elem( &mut self, elem: I, fill_value: impl FnMut() -> T, ) -> &mut T
Grows the index vector so that it contains an entry for
elem
; if that is already true, then has no
effect. Otherwise, inserts new values as needed by invoking
fill_value
.
Returns a reference to the elem
entry.
pub fn resize(&mut self, new_len: usize, value: T)where
T: Clone,
pub fn resize_to_elem(&mut self, elem: I, fill_value: impl FnMut() -> T)
pub fn append(&mut self, other: &mut IndexVec<I, T>)
Methods from Deref<Target = IndexSlice<I, T>>§
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
sourcepub fn next_index(&self) -> I
pub fn next_index(&self) -> I
Gives the next index that will be assigned when push
is called.
Manual bounds checks can be done using idx < slice.next_index()
(as opposed to idx.index() < slice.len()
).
pub fn iter(&self) -> Iter<'_, T>
pub fn iter_enumerated(&self) -> impl DoubleEndedIterator + ExactSizeIterator
pub fn indices( &self, ) -> impl DoubleEndedIterator + ExactSizeIterator + Clone + 'static
pub fn iter_mut(&mut self) -> IterMut<'_, T>
pub fn iter_enumerated_mut( &mut self, ) -> impl DoubleEndedIterator + ExactSizeIterator
pub fn last_index(&self) -> Option<I>
pub fn swap(&mut self, a: I, b: I)
pub fn get(&self, index: I) -> Option<&T>
pub fn get_mut(&mut self, index: I) -> Option<&mut T>
sourcepub fn pick2_mut(&mut self, a: I, b: I) -> (&mut T, &mut T)
pub fn pick2_mut(&mut self, a: I, b: I) -> (&mut T, &mut T)
Returns mutable references to two distinct elements, a
and b
.
Panics if a == b
.
sourcepub fn pick3_mut(&mut self, a: I, b: I, c: I) -> (&mut T, &mut T, &mut T)
pub fn pick3_mut(&mut self, a: I, b: I, c: I) -> (&mut T, &mut T, &mut T)
Returns mutable references to three distinct elements.
Panics if the elements are not distinct.
pub fn binary_search(&self, value: &T) -> Result<I, I>where
T: Ord,
sourcepub fn invert_bijective_mapping(&self) -> IndexVec<J, I>
pub fn invert_bijective_mapping(&self) -> IndexVec<J, I>
Invert a bijective mapping, i.e. invert(map)[y] = x
if map[x] = y
,
assuming the values in self
are a permutation of 0..self.len()
.
This is used to go between memory_index
(source field order to memory order)
and inverse_memory_index
(memory order to source field order).
See also FieldsShape::Arbitrary::memory_index
for more details.
Trait Implementations§
source§impl<I, T> Borrow<IndexSlice<I, T>> for IndexVec<I, T>where
I: Idx,
impl<I, T> Borrow<IndexSlice<I, T>> for IndexVec<I, T>where
I: Idx,
source§fn borrow(&self) -> &IndexSlice<I, T>
fn borrow(&self) -> &IndexSlice<I, T>
source§impl<I, T> BorrowMut<IndexSlice<I, T>> for IndexVec<I, T>where
I: Idx,
impl<I, T> BorrowMut<IndexSlice<I, T>> for IndexVec<I, T>where
I: Idx,
source§fn borrow_mut(&mut self) -> &mut IndexSlice<I, T>
fn borrow_mut(&mut self) -> &mut IndexSlice<I, T>
source§impl<I, T> Deref for IndexVec<I, T>where
I: Idx,
impl<I, T> Deref for IndexVec<I, T>where
I: Idx,
source§type Target = IndexSlice<I, T>
type Target = IndexSlice<I, T>
source§fn deref(&self) -> &IndexSlice<I, T>
fn deref(&self) -> &IndexSlice<I, T>
source§impl<I, T> DerefMut for IndexVec<I, T>where
I: Idx,
impl<I, T> DerefMut for IndexVec<I, T>where
I: Idx,
source§fn deref_mut(&mut self) -> &mut IndexSlice<I, T>
fn deref_mut(&mut self) -> &mut IndexSlice<I, T>
source§impl<I, T> Extend<T> for IndexVec<I, T>where
I: Idx,
impl<I, T> Extend<T> for IndexVec<I, T>where
I: Idx,
source§fn extend<J>(&mut self, iter: J)where
J: IntoIterator<Item = T>,
fn extend<J>(&mut self, iter: J)where
J: IntoIterator<Item = T>,
source§fn extend_one(&mut self, item: T)
fn extend_one(&mut self, item: T)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl<I, T> FromIterator<T> for IndexVec<I, T>where
I: Idx,
impl<I, T> FromIterator<T> for IndexVec<I, T>where
I: Idx,
source§impl<'tcx> HasLocalDecls<'tcx> for IndexVec<Local, LocalDecl<'tcx>>
impl<'tcx> HasLocalDecls<'tcx> for IndexVec<Local, LocalDecl<'tcx>>
fn local_decls(&self) -> &IndexSlice<Local, LocalDecl<'tcx>>
source§impl<I, T, CTX> HashStable<CTX> for IndexVec<I, T>where
I: Idx,
T: HashStable<CTX>,
impl<I, T, CTX> HashStable<CTX> for IndexVec<I, T>where
I: Idx,
T: HashStable<CTX>,
fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher<SipHasher128>)
source§impl<'a, I, T> IntoIterator for &'a IndexVec<I, T>where
I: Idx,
impl<'a, I, T> IntoIterator for &'a IndexVec<I, T>where
I: Idx,
source§impl<'a, I, T> IntoIterator for &'a mut IndexVec<I, T>where
I: Idx,
impl<'a, I, T> IntoIterator for &'a mut IndexVec<I, T>where
I: Idx,
source§impl<I, T> IntoIterator for IndexVec<I, T>where
I: Idx,
impl<I, T> IntoIterator for IndexVec<I, T>where
I: Idx,
source§impl<I, T> ParameterizedOverTcx for IndexVec<I, T>where
I: Idx + 'static,
T: ParameterizedOverTcx,
impl<I, T> ParameterizedOverTcx for IndexVec<I, T>where
I: Idx + 'static,
T: ParameterizedOverTcx,
source§impl<I, T, Ix> TypeFoldable<I> for IndexVec<Ix, T>
impl<I, T, Ix> TypeFoldable<I> for IndexVec<Ix, T>
source§fn try_fold_with<F>(
self,
folder: &mut F,
) -> Result<IndexVec<Ix, T>, <F as FallibleTypeFolder<I>>::Error>where
F: FallibleTypeFolder<I>,
fn try_fold_with<F>(
self,
folder: &mut F,
) -> Result<IndexVec<Ix, T>, <F as FallibleTypeFolder<I>>::Error>where
F: FallibleTypeFolder<I>,
source§fn fold_with<F>(self, folder: &mut F) -> Selfwhere
F: TypeFolder<I>,
fn fold_with<F>(self, folder: &mut F) -> Selfwhere
F: TypeFolder<I>,
try_fold_with
for use with infallible
folders. Do not override this method, to ensure coherence with
try_fold_with
.source§impl<I, T, Ix> TypeVisitable<I> for IndexVec<Ix, T>
impl<I, T, Ix> TypeVisitable<I> for IndexVec<Ix, T>
source§fn visit_with<V>(&self, visitor: &mut V) -> <V as TypeVisitor<I>>::Resultwhere
V: TypeVisitor<I>,
fn visit_with<V>(&self, visitor: &mut V) -> <V as TypeVisitor<I>>::Resultwhere
V: TypeVisitor<I>,
impl<I, T> Eq for IndexVec<I, T>
impl<I, T> Send for IndexVec<I, T>
impl<I, T> StructuralPartialEq for IndexVec<I, T>where
I: Idx,
Auto Trait Implementations§
impl<I, T> Freeze for IndexVec<I, T>
impl<I, T> RefUnwindSafe for IndexVec<I, T>where
T: RefUnwindSafe,
impl<I, T> Sync for IndexVec<I, T>where
T: Sync,
impl<I, T> Unpin for IndexVec<I, T>where
T: Unpin,
impl<I, T> UnwindSafe for IndexVec<I, T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§impl<Tcx, T> DepNodeParams<Tcx> for T
impl<Tcx, T> DepNodeParams<Tcx> for T
default fn fingerprint_style() -> FingerprintStyle
source§default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_debug_str(&self, _: Tcx) -> String
source§default fn recover(_: Tcx, _: &DepNode) -> Option<T>
default fn recover(_: Tcx, _: &DepNode) -> Option<T>
DepNode
,
something which is needed when forcing DepNode
s 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<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Filterable for T
impl<T> Filterable for T
source§fn filterable(
self,
filter_name: &'static str,
) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<P> IntoQueryParam<P> for P
impl<P> IntoQueryParam<P> for P
fn into_query_param(self) -> P
source§impl<'tcx, T> IsSuggestable<'tcx> for T
impl<'tcx, T> IsSuggestable<'tcx> for T
source§impl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
source§impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
fn has_type_flags(&self, flags: TypeFlags) -> bool
source§fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
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.fn error_reported(&self) -> Result<(), <I as Interner>::ErrorGuaranteed>
source§fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
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
fn has_escaping_bound_vars(&self) -> bool
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 morefn has_aliases(&self) -> bool
fn has_opaque_types(&self) -> bool
fn has_coroutines(&self) -> bool
fn references_error(&self) -> bool
fn has_non_region_param(&self) -> bool
fn has_infer_regions(&self) -> bool
fn has_infer_types(&self) -> bool
fn has_non_region_infer(&self) -> bool
fn has_infer(&self) -> bool
fn has_placeholders(&self) -> bool
fn has_non_region_placeholders(&self) -> bool
fn has_param(&self) -> bool
source§fn has_free_regions(&self) -> bool
fn has_free_regions(&self) -> bool
fn has_erased_regions(&self) -> bool
source§fn has_erasable_regions(&self) -> bool
fn has_erasable_regions(&self) -> bool
source§fn is_global(&self) -> bool
fn is_global(&self) -> bool
source§fn has_bound_regions(&self) -> bool
fn has_bound_regions(&self) -> bool
source§fn has_non_region_bound_vars(&self) -> bool
fn has_non_region_bound_vars(&self) -> bool
source§fn has_bound_vars(&self) -> bool
fn has_bound_vars(&self) -> bool
source§fn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
impl
specialization.source§impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
source§impl<I, T> UpcastFrom<I, T> for T
impl<I, T> UpcastFrom<I, T> for T
fn upcast_from(from: T, _tcx: I) -> T
source§impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> T
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeSendSync for 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: 24 bytes