Struct enumoid::EnumVec

pub struct EnumVec<T: EnumArrayHelper<V>, V> { /* private fields */ }

A vector of values V indexed by enumoid T.

Implementations

impl<T: EnumArrayHelper<V>, V> EnumVec<T, V>

pub fn new() -> Self

Creates a new vector with no elements.

pub fn new_with<F>(size: EnumSize<T>, f: F) -> Self

where F: FnMut(T) -> V,

Creates a new vector with a specified number of elements generated by a callback function.

pub fn as_slice(&self) -> &[V]

Returns a slice containing all the values in the vector.

pub fn as_slice_mut(&mut self) -> &mut [V]

Returns a mutable slice containing all the values in the vector.

pub fn get_by_index(&self, index: EnumIndex<T>) -> Option<&V>

Returns a reference to the value associated with a given index, or None if the index is beyond the end of the vector.

pub fn get(&self, key: T) -> Option<&V>

Returns a reference to the value associated with a given key, or None if the key is beyond the end of the vector.

pub fn get_by_index_mut(&mut self, index: EnumIndex<T>) -> Option<&mut V>

Returns a mutable reference to the value associated with a given index, or None if the index is beyond the end of the vector.

pub fn get_mut(&mut self, key: T) -> Option<&mut V>

Returns a mutable reference to the value associated with a given key, or None if the key is beyond the end of the vector.

pub fn is_empty(&self) -> bool

Returns true if the vector is empty.

pub fn is_full(&self) -> bool

Returns true if the vector is fully populated.

pub fn contains_index(&self, index: EnumIndex<T>) -> bool

Returns true if the vector contains the index.

pub fn contains(&self, value: T) -> bool

Returns true if the vector contains the key.

pub fn size(&self) -> EnumSize<T>

Returns the size of the vector.

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

Swaps two elements in the vector.

Panics

Panics if a or b are beyond the end of the vector.

pub fn swap_remove(&mut self, key: T) -> Option<V>

Removes an element and returns it, replacing it with the last element.

pub fn remove(&mut self, key: T) -> Option<V>

Removes an element and returns it.

pub fn clear(&mut self)

Clears all the elements from the vector.

pub fn push(&mut self, value: V)

Adds an element to the end of the vector.

Panics

Panics if the vector is already full.

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

Removes an element from the end of the vector and returns it, or None if the vector is empty.

pub fn iter(&self) -> EnumSliceIter<'_, T, V>

Returns an iterator over the keys and elements.

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

Returns a mutable iterator over the keys and elements.

Trait Implementations

impl<T: EnumArrayHelper<V>, V: Clone> Clone for EnumVec<T, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: EnumArrayHelper<V> + Debug, V: Debug> Debug for EnumVec<T, V>

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

Formats the value using the given formatter.

impl<T: EnumArrayHelper<V>, V> Default for EnumVec<T, V>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: EnumArrayHelper<V> + EnumSetHelper<u8> + Deserialize<'de>, V: Deserialize<'de>> Deserialize<'de> for EnumVec<T, V>

fn deserialize<D>(de: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: EnumArrayHelper<V>, V> Drop for EnumVec<T, V>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: EnumArrayHelper<V>, V> FromIterator<V> for EnumVec<T, V>

fn from_iter<I: IntoIterator<Item = V>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: EnumArrayHelper<V>, V: Hash> Hash for EnumVec<T, V>

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: EnumArrayHelper<V>, V> Index<EnumIndex<T>> for EnumVec<T, V>

type Output = V

The returned type after indexing.

fn index(&self, index: EnumIndex<T>) -> &V

Performs the indexing (container[index]) operation.

impl<T: EnumArrayHelper<V>, V> Index<T> for EnumVec<T, V>

type Output = V

The returned type after indexing.

fn index(&self, key: T) -> &V

Performs the indexing (container[index]) operation.

impl<T: EnumArrayHelper<V>, V> IndexMut<EnumIndex<T>> for EnumVec<T, V>

fn index_mut(&mut self, index: EnumIndex<T>) -> &mut V

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

impl<T: EnumArrayHelper<V>, V> IndexMut<T> for EnumVec<T, V>

fn index_mut(&mut self, key: T) -> &mut V

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

impl<'a, T: EnumArrayHelper<V>, V> IntoIterator for &'a EnumVec<T, V>

type Item = (T, &'a V)

The type of the elements being iterated over.

type IntoIter = EnumSliceIter<'a, T, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: EnumArrayHelper<V>, V: PartialEq> PartialEq for EnumVec<T, V>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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.

impl<T: EnumArrayHelper<V> + Serialize, V: Serialize> Serialize for EnumVec<T, V>

fn serialize<S>(&self, ser: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: EnumArrayHelper<V> + EnumSetHelper<u8>, V> TryFrom<EnumOptionMap<T, V>> for EnumVec<T, V>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: EnumOptionMap<T, V>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: EnumArrayHelper<V>, V: Eq> Eq for EnumVec<T, V>