Struct enum_collections::EnumTable

pub struct EnumTable<K, V> { /* private fields */ }

A key-value table optimized for Enums used as keys. Initialized with V’s Default values.

use enum_collections::{EnumTable, Enumerated};
#[derive(Enumerated)]
enum Letter {
    A,
    B,
}

let mut map: EnumTable<Letter, u8> = EnumTable::new();
map[Letter::A] = 42;
assert_eq!(42u8, map[Letter::A]);
assert_eq!(u8::default(), map[Letter::B]);

Implementations

impl<K, V> EnumTable<K, V>

where K: Enumerated,

pub fn from_fn(cb: impl FnMut(&K) -> V) -> Self

impl<K, V> EnumTable<K, V>

where K: Enumerated, V: Default,

pub fn new() -> Self

Creates a new EnumTable, with pre-allocated space for all keys of the enum K. With the underlying array righsized, no resizing is further required. All values are initialized with V’s Default value.

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

Resets value of type V corresponding to key to its default by calling its Default trait implementation.

Args

• key - The instance of K pointing at the slot to reset to default.

Trait Implementations

impl<K, V> Debug for EnumTable<K, V>

where K: Enumerated + Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K, V> Default for EnumTable<K, V>

where K: Enumerated, V: Default,

fn default() -> Self

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

impl<F, K, V> From<F> for EnumTable<K, V>

where K: Enumerated, F: FnMut(&K) -> V,

fn from(cb: F) -> Self

Converts to this type from the input type.

impl<K, V> Index<K> for EnumTable<K, V>

where K: Enumerated, V: Default,

type Output = V

The returned type after indexing.

fn index(&self, key: K) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<K, V> IndexMut<K> for EnumTable<K, V>

where K: Enumerated, V: Default,

fn index_mut(&mut self, key: K) -> &mut Self::Output

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

impl<K, V> PartialEq for EnumTable<K, V>

where K: Enumerated, V: Default + PartialEq,

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<K, V> Eq for EnumTable<K, V>

where K: Enumerated, V: Default + Eq,