Struct enumoid::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>)

Sets the value associated with a given index.

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

Sets the value associated with a given key.

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.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

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

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

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