Struct enum_map::EnumMap [−][src]
pub struct EnumMap<K: Enum<V>, V> { /* fields omitted */ }
Expand description
An enum mapping.
This internally uses an array which stores a value for each possible
enum value. To work, it requires implementation of internal (private,
although public due to macro limitations) trait which allows extracting
information about an enum, which can be automatically generated using
#[derive(Enum)]
macro.
Additionally, bool
and u8
automatically derives from Enum
. While
u8
is not technically an enum, it’s convenient to consider it like one.
In particular, reverse-complement in benchmark game could be using u8
as an enum.
Examples
use enum_map::{enum_map, Enum, EnumMap}; #[derive(Enum)] enum Example { A, B, C, } let mut map = EnumMap::default(); // new initializes map with default values assert_eq!(map[Example::A], 0); map[Example::A] = 3; assert_eq!(map[Example::A], 3);
Implementations
impl<K: Enum<V>, V> EnumMap<K, V>
[src]
impl<K: Enum<V>, V> EnumMap<K, V>
[src]pub fn values(&self) -> Values<'_, V>ⓘ
[src]
pub fn values(&self) -> Values<'_, V>ⓘ
[src]An iterator visiting all values. The iterator type is &V
.
Examples
use enum_map::enum_map; let map = enum_map! { false => 3, true => 4 }; let mut values = map.values(); assert_eq!(values.next(), Some(&3)); assert_eq!(values.next(), Some(&4)); assert_eq!(values.next(), None);
pub fn values_mut(&mut self) -> ValuesMut<'_, V>ⓘ
[src]
pub fn values_mut(&mut self) -> ValuesMut<'_, V>ⓘ
[src]An iterator visiting all values mutably. The iterator type is &mut V
.
Examples
use enum_map::enum_map; let mut map = enum_map! { _ => 2 }; for value in map.values_mut() { *value += 2; } assert_eq!(map[false], 4); assert_eq!(map[true], 4);
impl<K: Enum<V>, V: Default> EnumMap<K, V>
[src]
impl<K: Enum<V>, V: Default> EnumMap<K, V>
[src]pub fn clear(&mut self)
[src]
pub fn clear(&mut self)
[src]Clear enum map with default values.
Examples
use enum_map::{Enum, EnumMap}; #[derive(Enum)] enum Example { A, B, } let mut enum_map = EnumMap::<_, String>::default(); enum_map[Example::B] = "foo".into(); enum_map.clear(); assert_eq!(enum_map[Example::A], ""); assert_eq!(enum_map[Example::B], "");
impl<K: Enum<V>, V> EnumMap<K, V>
[src]
impl<K: Enum<V>, V> EnumMap<K, V>
[src]pub fn from_array(array: K::Array) -> EnumMap<K, V>
[src]
pub fn from_array(array: K::Array) -> EnumMap<K, V>
[src]Creates an enum map from array.
pub fn swap(&mut self, a: K, b: K)
[src]
pub fn swap(&mut self, a: K, b: K)
[src]Swaps two indexes.
Examples
use enum_map::enum_map; let mut map = enum_map! { false => 0, true => 1 }; map.swap(false, true); assert_eq!(map[false], 1); assert_eq!(map[true], 0);
pub fn as_mut_slice(&mut self) -> &mut [V]
[src]
pub fn as_mut_slice(&mut self) -> &mut [V]
[src]Converts a mutable enum map to a mutable slice representing values.
Trait Implementations
impl<'a, K: Enum<V>, V: Arbitrary<'a>> Arbitrary<'a> for EnumMap<K, V>
[src]
impl<'a, K: Enum<V>, V: Arbitrary<'a>> Arbitrary<'a> for EnumMap<K, V>
[src]Requires crate feature "arbitrary"
fn arbitrary(u: &mut Unstructured<'a>) -> Result<EnumMap<K, V>>
[src]
fn arbitrary(u: &mut Unstructured<'a>) -> Result<EnumMap<K, V>>
[src]Generate an arbitrary value of Self
from the given unstructured data. Read more
fn size_hint(depth: usize) -> (usize, Option<usize>)
[src]
fn size_hint(depth: usize) -> (usize, Option<usize>)
[src]Get a size hint for how many bytes out of an Unstructured
this type
needs to construct itself. Read more
fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
[src]
fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
[src]Generate an arbitrary value of Self
from the entirety of the given unstructured data. Read more
impl<'de, K, V> Deserialize<'de> for EnumMap<K, V> where
K: Enum<V> + Enum<Option<V>> + Deserialize<'de>,
V: Deserialize<'de>,
[src]
impl<'de, K, V> Deserialize<'de> for EnumMap<K, V> where
K: Enum<V> + Enum<Option<V>> + Deserialize<'de>,
V: Deserialize<'de>,
[src]Requires crate feature "serde"
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
[src]
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
[src]Deserialize this value from the given Serde deserializer. Read more
impl<'a, K, V> Extend<(&'a K, &'a V)> for EnumMap<K, V> where
K: Enum<V> + Copy,
V: Copy,
[src]
impl<'a, K, V> Extend<(&'a K, &'a V)> for EnumMap<K, V> where
K: Enum<V> + Copy,
V: Copy,
[src]fn extend<I: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iter: I)
[src]
fn extend<I: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iter: I)
[src]Extends a collection with the contents of an iterator. Read more
fn extend_one(&mut self, item: A)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl<K: Enum<V>, V> Extend<(K, V)> for EnumMap<K, V>
[src]
impl<K: Enum<V>, V> Extend<(K, V)> for EnumMap<K, V>
[src]fn extend<I: IntoIterator<Item = (K, V)>>(&mut self, iter: I)
[src]
fn extend<I: IntoIterator<Item = (K, V)>>(&mut self, iter: I)
[src]Extends a collection with the contents of an iterator. Read more
fn extend_one(&mut self, item: A)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl<'a, K: Enum<V>, V> IntoIterator for &'a EnumMap<K, V>
[src]
impl<'a, K: Enum<V>, V> IntoIterator for &'a EnumMap<K, V>
[src]impl<'a, K: Enum<V>, V> IntoIterator for &'a mut EnumMap<K, V>
[src]
impl<'a, K: Enum<V>, V> IntoIterator for &'a mut EnumMap<K, V>
[src]impl<K: Enum<V>, V> IntoIterator for EnumMap<K, V>
[src]
impl<K: Enum<V>, V> IntoIterator for EnumMap<K, V>
[src]impl<K: Enum<V> + Serialize, V: Serialize> Serialize for EnumMap<K, V>
[src]
impl<K: Enum<V> + Serialize, V: Serialize> Serialize for EnumMap<K, V>
[src]Requires crate feature "serde"
impl<K: Enum<V>, V> Copy for EnumMap<K, V> where
K::Array: Copy,
[src]
K::Array: Copy,
impl<K: Enum<V>, V: Eq> Eq for EnumMap<K, V>
[src]
Auto Trait Implementations
impl<K, V> RefUnwindSafe for EnumMap<K, V> where
<K as Enum<V>>::Array: RefUnwindSafe,
<K as Enum<V>>::Array: RefUnwindSafe,
impl<K, V> Send for EnumMap<K, V> where
<K as Enum<V>>::Array: Send,
<K as Enum<V>>::Array: Send,
impl<K, V> Sync for EnumMap<K, V> where
<K as Enum<V>>::Array: Sync,
<K as Enum<V>>::Array: Sync,
impl<K, V> Unpin for EnumMap<K, V> where
<K as Enum<V>>::Array: Unpin,
<K as Enum<V>>::Array: Unpin,
impl<K, V> UnwindSafe for EnumMap<K, V> where
<K as Enum<V>>::Array: UnwindSafe,
<K as Enum<V>>::Array: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,