Struct TaggedVec

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

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

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

Implementations

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

pub fn new() -> Self

Creates a new empty TaggedVec.

pub fn len(&self) -> usize

Returns the number of elements in the TaggedVec.

pub fn is_empty(&self) -> bool

Returns true if the TaggedVec contains no elements.

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.

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.

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.

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

where usize: for<'a> From<&'a Index>,

See Vec::splice.

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.

pub fn iter(&self) -> impl Iterator<Item = (Index, &Value)>

where Index: From<usize>,

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

pub fn iter_mut(&mut self) -> impl Iterator<Item = (Index, &mut Value)>

where Index: From<usize>,

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

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

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

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

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

pub fn iter_indices(&self) -> impl Iterator<Item = Index>

where Index: From<usize>,

Returns an iterator over the indices of the TaggedVec.

Trait Implementations

impl<Index, Value: Clone> Clone for TaggedVec<Index, Value>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Index, Value: Debug> Debug for TaggedVec<Index, Value>

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

Formats the value using the given formatter.

impl<Index, Value> Default for TaggedVec<Index, Value>

fn default() -> Self

Returns the “default value” for a type.

impl<Index, Value> From<TaggedVec<Index, Value>> for Vec<Value>

fn from(value: TaggedVec<Index, Value>) -> Self

Converts to this type from the input type.

impl<Index, Value> From<Vec<Value>> for TaggedVec<Index, Value>

fn from(value: Vec<Value>) -> Self

Converts to this type from the input type.

impl<Index, Value> FromIterator<Value> for TaggedVec<Index, Value>

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl<Index: Into<usize>, Value> Index<Index> for TaggedVec<Index, Value>

type Output = Value

The returned type after indexing.

fn index(&self, index: Index) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<Index: Into<usize>, Value> IndexMut<Index> for TaggedVec<Index, Value>

fn index_mut(&mut self, index: Index) -> &mut Self::Output

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

impl<'a, Index, Value> IntoIterator for &'a TaggedVec<Index, Value>

type Item = &'a Value

The type of the elements being iterated over.

type IntoIter = <&'a Vec<Value> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, Index, Value> IntoIterator for &'a mut TaggedVec<Index, Value>

type Item = &'a mut Value

The type of the elements being iterated over.

type IntoIter = <&'a mut Vec<Value> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Index, Value> IntoIterator for TaggedVec<Index, Value>

type Item = Value

The type of the elements being iterated over.

type IntoIter = <Vec<Value> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Index, Value: Ord> Ord for TaggedVec<Index, Value>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Index, Value: PartialEq> PartialEq for TaggedVec<Index, Value>

fn eq(&self, other: &Self) -> 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<Index, Value: PartialOrd> PartialOrd for TaggedVec<Index, Value>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Index, Value: Eq> Eq for TaggedVec<Index, Value>