Struct IndexSlice

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

A view into contiguous Ts, indexed by I rather than by usize.

One common pattern you’ll see is code that uses IndexVec::from_elem to create the storage needed for a particular “universe” (aka the set of all the possible keys that need an associated value) then passes that working area as &mut IndexSlice<I, T> to clarify that nothing will be added nor removed during processing (and, as a bonus, to chase fewer pointers).

Fields

_marker: PhantomData<fn(_: &I)>

raw: [T]

Implementations

impl<I: Idx, T> IndexSlice<I, T>

pub const fn empty<'a>() -> &'a Self

pub const fn from_raw(raw: &[T]) -> &Self

pub fn from_raw_mut(raw: &mut [T]) -> &mut Self

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

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<Item = (I, &T)> + ExactSizeIterator + '_

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

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

pub fn iter_enumerated_mut( &mut self, ) -> impl DoubleEndedIterator<Item = (I, &mut T)> + 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>

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.

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,

impl<I: Idx, J: Idx> IndexSlice<I, J>

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

impl<I: Idx, T> Borrow<IndexSlice<I, T>> for IndexVec<I, T>

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

Immutably borrows from an owned value.

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

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

Mutably borrows from an owned value.

impl<I: Idx, T: Debug> Debug for IndexSlice<I, T>

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

Formats the value using the given formatter.

impl<I: Idx, T> Default for &IndexSlice<I, T>

fn default() -> Self

Returns the “default value” for a type.

impl<I: Idx, T> Default for &mut IndexSlice<I, T>

fn default() -> Self

Returns the “default value” for a type.

impl<I: Hash + Idx, T: Hash> Hash for IndexSlice<I, T>

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

Feeds this value into the given Hasher.

impl<I: Idx, T> Index<I> for IndexSlice<I, T>

type Output = T

The returned type after indexing.

fn index(&self, index: I) -> &T

Performs the indexing (container[index]) operation.

impl<I: Idx, T> IndexMut<I> for IndexSlice<I, T>

fn index_mut(&mut self, index: I) -> &mut T

Performs the mutable indexing (container[index]) operation.

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

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

Creates an iterator from a value.

impl<'a, I: Idx, T> IntoIterator for &'a mut IndexSlice<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?

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

Creates an iterator from a value.

impl<I: PartialEq + Idx, T: PartialEq> PartialEq for IndexSlice<I, T>

fn eq(&self, other: &IndexSlice<I, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I: Idx, T: Clone> ToOwned for IndexSlice<I, T>

type Owned = IndexVec<I, T>

The resulting type after obtaining ownership.

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

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut IndexVec<I, T>)

Uses borrowed data to replace owned data, usually by cloning.

impl<I: Eq + Idx, T: Eq> Eq for IndexSlice<I, T>

impl<I: Idx, T> Send for IndexSlice<I, T>

where T: Send,

impl<I: Idx, T> StructuralPartialEq for IndexSlice<I, T>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.