# Struct rustc_index::IndexVec

source ·

    #[repr(transparent)]pub struct IndexVec<I: Idx, T> {
        pub raw: Vec<T>,
        _marker: PhantomData<fn(_: &I)>,
    }

Expand description

An owned contiguous collection of `T`s, indexed by `I` rather than by `usize`.

While it’s possible to use `u32` or `usize` directly for `I`, you almost certainly want to use a `newtype_index!`-generated type instead.

## Fields§

§`raw: Vec<T>`§`_marker: PhantomData<fn(_: &I)>`

## Implementations§

source§

### impl<I: Idx, T> IndexVec<I, T>

source

#### pub const fn new() -> Self

source

#### pub const fn from_raw(raw: Vec<T>) -> Self

source

#### pub fn with_capacity(capacity: usize) -> Self

source

#### pub fn from_elem<S>(elem: T, universe: &IndexSlice<I, S>) -> Self
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.

source

#### pub fn from_elem_n(elem: T, n: usize) -> Self
where T: Clone,

source

#### pub fn from_fn_n(func: impl FnMut(I) -> T, n: usize) -> Self

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`.)

source

#### pub fn as_slice(&self) -> &IndexSlice<I, T>

source

#### pub fn as_mut_slice(&mut self) -> &mut IndexSlice<I, T>

source

#### pub fn push(&mut self, d: T) -> I

source

#### pub fn pop(&mut self) -> Option<T>

source

#### pub fn into_iter(self) -> IntoIter<T>

source

#### pub fn into_iter_enumerated( self ) -> impl DoubleEndedIterator<Item = (I, T)> + ExactSizeIterator

source

#### pub fn drain<R: RangeBounds<usize>>( &mut self, range: R ) -> impl Iterator<Item = T> + '_

source

#### pub fn drain_enumerated<R: RangeBounds<usize>>( &mut self, range: R ) -> impl Iterator<Item = (I, T)> + '_

source

#### pub fn shrink_to_fit(&mut self)

source

#### pub fn truncate(&mut self, a: usize)

source

#### 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.

source

#### pub fn resize(&mut self, new_len: usize, value: T)
where T: Clone,

source

#### pub fn resize_to_elem(&mut self, elem: I, fill_value: impl FnMut() -> T)

source§

### impl<I: Idx, T> IndexVec<I, Option<T>>

`IndexVec` is often used as a map, so it provides some map-like APIs.

source

#### pub fn insert(&mut self, index: I, value: T) -> Option<T>

source

#### pub fn get_or_insert_with( &mut self, index: I, value: impl FnOnce() -> T ) -> &mut T

source

#### pub fn remove(&mut self, index: I) -> Option<T>

## Methods from Deref<Target = IndexSlice<I, T>>§

source

#### pub fn len(&self) -> usize

source

#### pub fn is_empty(&self) -> bool

source

#### 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()`).

source

#### pub fn iter(&self) -> Iter<'_, T>

source

#### pub fn iter_enumerated( &self ) -> impl DoubleEndedIterator<Item = (I, &T)> + ExactSizeIterator + '_

source

#### pub fn indices( &self ) -> impl DoubleEndedIterator<Item = I> + ExactSizeIterator + Clone + 'static

source

#### pub fn iter_mut(&mut self) -> IterMut<'_, T>

source

#### pub fn iter_enumerated_mut( &mut self ) -> impl DoubleEndedIterator<Item = (I, &mut T)> + ExactSizeIterator + '_

source

#### pub fn last_index(&self) -> Option<I>

source

#### pub fn swap(&mut self, a: I, b: I)

source

#### pub fn get(&self, index: I) -> Option<&T>

source

#### pub fn get_mut(&mut self, index: I) -> Option<&mut T>

source

#### 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`.

source

#### 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.

source

#### pub fn binary_search(&self, value: &T) -> Result<I, I>
where T: Ord,

source

#### 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: Idx, T> Borrow<IndexSlice<I, T>> for IndexVec<I, T>

source§

#### fn borrow(&self) -> &IndexSlice<I, T>

Immutably borrows from an owned value. Read more
source§

### impl<I: Idx, T> BorrowMut<IndexSlice<I, T>> for IndexVec<I, T>

source§

#### fn borrow_mut(&mut self) -> &mut IndexSlice<I, T>

Mutably borrows from an owned value. Read more
source§

### impl<I: Clone + Idx, T: Clone> Clone for IndexVec<I, T>

source§

#### fn clone(&self) -> IndexVec<I, T>

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<I: Idx, T: Debug> Debug for IndexVec<I, T>

source§

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

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

### impl<D: Decoder, I: Idx, T: Decodable<D>> Decodable<D> for IndexVec<I, T>

source§

#### fn decode(d: &mut D) -> Self

source§

### impl<I: Idx, T> Default for IndexVec<I, T>

source§

#### fn default() -> Self

Returns the “default value” for a type. Read more
source§

### impl<I: Idx, T> Deref for IndexVec<I, T>

§

#### type Target = IndexSlice<I, T>

The resulting type after dereferencing.
source§

#### fn deref(&self) -> &Self::Target

Dereferences the value.
source§

### impl<I: Idx, T> DerefMut for IndexVec<I, T>

source§

#### fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

### impl<S: Encoder, I: Idx, T: Encodable<S>> Encodable<S> for IndexVec<I, T>

source§

#### fn encode(&self, s: &mut S)

source§

### impl<I: Idx, T> Extend<T> for IndexVec<I, T>

source§

#### fn extend<J: IntoIterator<Item = T>>(&mut self, iter: J)

Extends a collection with the contents of an iterator. Read more
source§

#### fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (`extend_one`)
Extends a collection with exactly one element.
source§

#### fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (`extend_one`)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

### impl<I: Idx, T, const N: usize> From<[T; N]> for IndexVec<I, T>

source§

#### fn from(array: [T; N]) -> Self

Converts to this type from the input type.
source§

### impl<I: Idx, T> FromIterator<T> for IndexVec<I, T>

source§

#### fn from_iter<J>(iter: J) -> Self
where J: IntoIterator<Item = T>,

Creates a value from an iterator. Read more
source§

### impl<I: Hash + Idx, T: Hash> Hash for IndexVec<I, T>

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<'a, I: Idx, T> IntoIterator for &'a IndexVec<I, T>

§

#### type Item = &'a T

The type of the elements being iterated over.
§

#### type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?
source§

#### fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value. Read more
source§

### impl<'a, I: Idx, T> IntoIterator for &'a mut IndexVec<I, T>

§

#### type Item = &'a mut T

The type of the elements being iterated over.
§

#### type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?
source§

#### fn into_iter(self) -> IterMut<'a, T>

Creates an iterator from a value. Read more
source§

### impl<I: Idx, T> IntoIterator for IndexVec<I, T>

§

#### type Item = T

The type of the elements being iterated over.
§

#### type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
source§

#### fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value. Read more
source§

### impl<I: PartialEq + Idx, T: PartialEq> PartialEq for IndexVec<I, T>

source§

#### fn eq(&self, other: &IndexVec<I, T>) -> 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<I: Eq + Idx, T: Eq> Eq for IndexVec<I, T>

source§

### impl<I: Idx, T> Send for IndexVec<I, T>
where T: Send,

source§

### impl<I: Idx, T> StructuralEq for IndexVec<I, T>

source§

### impl<I: Idx, T> StructuralPartialEq for IndexVec<I, T>

## Auto Trait Implementations§

§

### 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> Any for T
where T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for T
where T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for T
where U: From<T>,

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> ToOwned for T
where 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<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.

## 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