Struct TaggedVec

Source

pub struct TaggedVec<Index, Value> { /* private fields */ }

Expand description

A Vec wrapper that allows indexing only via the given Index type.

For actual operation, Index must implement From<usize> and Into<usize>.

Implementations§

Source §

impl<Index, Value> TaggedVec<Index, Value>

Source

pub fn new() -> Self

Creates a new empty TaggedVec.

Source

pub fn with_capacity(capacity: usize) -> Self

Creates a new empty TaggedVec with at least the specified capacity.

Source

pub fn len(&self) -> usize

Returns the number of elements in the TaggedVec.

Source

pub fn is_empty(&self) -> bool

Returns true if the TaggedVec contains no elements.

Source

pub fn capacity(&self) -> usize

Returns the total number of elements the TaggedVec can hold without reallocating.

Source

pub fn as_untagged_slice(&self) -> &[Value]

Returns the untagged slice of the Vec underlying this TaggedVec.

Source

pub fn as_untagged_mut_slice(&mut self) -> &mut [Value]

Returns the untagged mutable slice of the Vec underlying this TaggedVec.

Source

pub fn push(&mut self, value: Value) -> Index
where Index: From<usize>,

Inserts the given value at the back of the TaggedVec, returning its index.

Source

pub fn push_in_place(&mut self, value: impl FnOnce(Index) -> Value) -> Index
where Index: From<usize>,

Insert a single value into the TaggedVec by constructing it in place.

This method allows to create the value while already knowing its index. Returns the index.

Source

pub fn pop(&mut self) -> Option<(Index, Value)>
where Index: From<usize>,

Removes the value at the back of the TaggedVec and returns it with its index.

Source

pub fn insert(&mut self, index: Index, value: Value)
where Index: Into<usize>,

Inserts the given value at position index, shifting all existing values in range index.. one position to the right.

Source

pub fn splice<I: IntoIterator<Item = Value>>( &mut self, range: impl RangeBounds<Index>, replace_with: I, ) -> Splice<'_, I::IntoIter>
where usize: From<Index>, Index: Copy,

See Vec::splice.

Source

pub fn retain(&mut self, f: impl FnMut(&Value) -> bool)

Retains only the values specified by the predicate.

In other words, remove all values v for which f(&v) returns false. This method operates in place, visiting each value exactly once in the original order, and preserves the order of the retained values.

Source

pub fn remove_multi(&mut self, indices: impl IntoIterator<Item = Index>)
where Index: Into<usize> + Clone,

Removes the elements at the specified indices, shifting other elements to the left to fill gaps as required.

The provided indices must be sorted.

Source

pub fn get(&self, index: Index) -> Option<&Value>
where Index: Into<usize>,

Returns a reference to the value at the given index, or None if the index is out of bounds.

Source

pub fn iter( &self, range: impl RangeBounds<Index>, ) -> impl DoubleEndedIterator<Item = (Index, &Value)> + ExactSizeIterator
where Index: From<usize> + Copy, usize: From<Index>,

Returns an iterator over references to the entries of the TaggedVec.

The range specifies which subset of the entries to iterate over. Iterating over a partial range with this argument is more efficient than iterating over the whole vector and skipping the unwanted entries, because the returned iterator does not support the skip optimisation.

Source

pub fn iter_mut( &mut self, range: impl RangeBounds<Index>, ) -> impl DoubleEndedIterator<Item = (Index, &mut Value)> + ExactSizeIterator
where Index: From<usize> + Copy, usize: From<Index>,

Returns an iterator over mutable references to the entries of the TaggedVec.

The range specifies which subset of the entries to iterate over. Iterating over a partial range with this argument is more efficient than iterating over the whole vector and skipping the unwanted entries, because the returned iterator does not support the skip optimisation.

Source

pub fn iter_values(&self) -> Iter<'_, Value>

Returns an iterator over references to the values of the TaggedVec.

Source

pub fn iter_values_mut(&mut self) -> IterMut<'_, Value>

Returns an iterator over mutable references to the values of the TaggedVec.

Source

pub fn iter_indices( &self, range: impl RangeBounds<Index>, ) -> IndexIterator<Index> ⓘ
where Index: From<usize> + Copy, usize: From<Index>,

Returns an iterator over the indices of the TaggedVec.

The range specifies which subset of the entries to iterate over. Iterating over a partial range with this argument is more efficient than iterating over the whole vector and skipping the unwanted entries, because the returned iterator does not support the skip optimisation.

Source

pub fn into_iter( self, range: impl RangeBounds<Index>, ) -> impl DoubleEndedIterator<Item = (Index, Value)> + ExactSizeIterator
where Index: From<usize> + Copy, usize: From<Index>,

Consumes the TaggedVec, returning an iterator over the entries.

The range specifies which subset of the entries to iterate over. Iterating over a partial range with this argument is more efficient than iterating over the whole vector and skipping the unwanted entries, because the returned iterator does not support the skip optimisation.

Source