Struct enum_collections::EnumMap

pub struct EnumMap<'a, K, V>where
    K: Enumerated,{ /* private fields */ }

A key-value map optimized for Enums used as keys.

use enum_collections::{enum_collections, EnumMap, Enumerated};
#[enum_collections]
enum Letter {
    A,
    B,
}

let mut map: EnumMap<Letter, u8> = EnumMap::new();
map.insert(Letter::A, 42);
assert_eq!(Some(&42u8), map.get(Letter::A))

Implementations

impl<'a, K, V> EnumMap<'a, K, V>where
    K: Enumerated,

pub fn new() -> Self

Creates a new EnumMap, with pre-allocated space for all keys of the enum K. With the underlying array righsized, no resizing is further required.

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

Attemps to obtain a value for given key, returning Some(V) if found, or None if no value has been inserted for given key yet.

Args

• key - Instance of K, used to look up the corresponding value.

pub fn insert(&mut self, key: K, value: V)

Stores given value under the provided key. Overrides any existing value previously set.

Args

• key - The instance of K the value inserted can be looked up for.
• values - Value to bind to K.

pub fn remove(&mut self, key: K)

Removes value stored under given key. Further get operations are going to return None.

Trait Implementations

impl<'a, K, V> Default for EnumMap<'a, K, V>where
    K: Enumerated,

fn default() -> Self

Constructs a new instance, capable of holding all values of key K without further resizing.