Struct EnumOptionMap 

pub struct EnumOptionMap<T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord>, V, BitsetWord: BitsetWordTrait = u8> { /* private fields */ }

A partial map from enumoid T to values V.

The optional type parameter BitsetWord is passed on to an embedded EnumSet which is used to store the validity bitmap.

Implementations

impl<T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord>, V, BitsetWord: BitsetWordTrait> EnumOptionMap<T, V, BitsetWord>

pub fn new() -> Self

Creates a new empty map.

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 has no value in the map.

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

Returns a reference to the value associated with a given key, or None if the key has no value in the map.

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 has no value in the map.

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 has no value in the map.

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

Sets the value associated with a given index and returns the old value if one was present.

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

Sets the value associated with a given key and returns the old value if one was present.

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

Adds a value at the given index to the map and returns the old value if one was present.

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

Adds a value with the given key to the map and returns the old value if one was present.

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

Removes any value at the given index from the map and returns it if one was present.

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

Removes any value with the given key from the map and returns it if one was present.

pub fn swap_by_index(&mut self, a: EnumIndex<T>, b: EnumIndex<T>)

Swaps two elements in the map by index.

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

Swaps two elements in the map.

pub fn clear(&mut self)

Clears all the elements from the map.

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

pub fn is_full(&self) -> bool

Returns true if the map is fully populated.

pub fn is_vec(&self) -> Option<EnumSize<T>>

Returns the size of a vector needed to represent the map, or None if the map is not representable by a vector.

A map is representable by vector if all the populated values are contiguous with the first key, or if the map is empty.

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

Returns true if the map contains the index.

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

Returns true if the map contains the key.

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

Returns an iterator over the keys and values.

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

Returns a mutable iterator over the keys and values.

pub fn count(&self) -> usize

Returns the number of populated keys in the map.

pub fn keys(&self) -> &EnumSet<T, BitsetWord>

Returns a reference to the set of populated keys.

Trait Implementations

impl<T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord> + Debug, V: Debug, BitsetWord: BitsetWordTrait> Debug for EnumOptionMap<T, V, BitsetWord>

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

Formats the value using the given formatter.

impl<T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord>, V, BitsetWord: BitsetWordTrait> Default for EnumOptionMap<T, V, BitsetWord>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord> + Deserialize<'de>, V: Deserialize<'de>, BitsetWord: BitsetWordTrait> Deserialize<'de> for EnumOptionMap<T, V, BitsetWord>

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> + EnumSetHelper<BitsetWord>, V, BitsetWord: BitsetWordTrait> Drop for EnumOptionMap<T, V, BitsetWord>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord>, V: Eq, BitsetWord: BitsetWordTrait> Eq for EnumOptionMap<T, V, BitsetWord>

impl<T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord>, V, BitsetWord: BitsetWordTrait> Extend<(T, V)> for EnumOptionMap<T, V, BitsetWord>

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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.

impl<T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord>, V, BitsetWord: BitsetWordTrait> FromIterator<(T, V)> for EnumOptionMap<T, V, BitsetWord>

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

Creates a value from an iterator.

impl<T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord>, V: Hash, BitsetWord: BitsetWordTrait> Hash for EnumOptionMap<T, V, BitsetWord>

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<'a, T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord>, V, BitsetWord: BitsetWordTrait> IntoIterator for &'a EnumOptionMap<T, V, BitsetWord>

type Item = (T, &'a V)

The type of the elements being iterated over.

type IntoIter = EnumOptionMapIter<'a, T, V, BitsetWord>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord>, V, BitsetWord: BitsetWordTrait> IntoIterator for &'a mut EnumOptionMap<T, V, BitsetWord>

type Item = (T, &'a mut V)

The type of the elements being iterated over.

type IntoIter = EnumOptionMapIterMut<'a, T, V, BitsetWord>

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> + EnumSetHelper<BitsetWord>, V, BitsetWord: BitsetWordTrait> IntoIterator for EnumOptionMap<T, V, BitsetWord>

type Item = (T, V)

The type of the elements being iterated over.

type IntoIter = EnumOptionMapIntoIter<T, V, BitsetWord>

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> + EnumSetHelper<BitsetWord>, V: PartialEq, BitsetWord: BitsetWordTrait> PartialEq for EnumOptionMap<T, V, BitsetWord>

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<T: EnumArrayHelper<V> + EnumSetHelper<BitsetWord> + Serialize, V: Serialize, BitsetWord: BitsetWordTrait> Serialize for EnumOptionMap<T, V, BitsetWord>

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 EnumMap<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> + 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.