1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
mod index;
use std::{
    alloc::{alloc, dealloc, Layout},
    marker::PhantomData,
    slice::from_raw_parts_mut,
};

use crate::Enumerated;

/// 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]);
/// ```
///
/// Using get and insert functions.
/// ```
/// use enum_collections::{enum_collections, EnumTable, Enumerated};
/// #[derive(Enumerated)]
/// enum Letter {
///     A,
///     B,
/// }
///
/// let mut map: EnumTable<Letter, u8> = EnumTable::new();
/// map.insert(Letter::A, 42);
/// assert_eq!(&42u8, map.get(Letter::A));
/// assert_eq!(&u8::default(), map.get(Letter::B));
/// ```
pub struct EnumTable<'a, K, V>
where
    K: Enumerated,
    V: Default,
{
    values: &'a mut [V],
    _key_phantom_data: PhantomData<K>,
}

impl<'a, K, V> EnumTable<'a, K, V>
where
    K: Enumerated,
    V: Default,
{
    /// 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 new() -> Self {
        Self {
            values: unsafe {
                let raw_memory = alloc(Layout::array::<V>(K::len()).unwrap());
                let values_array: &'a mut [V] = from_raw_parts_mut(raw_memory as *mut V, K::len());
                for value in values_array.iter_mut() {
                    *value = V::default();
                }
                values_array
            },
            _key_phantom_data: PhantomData {},
        }
    }

    /// Obtain a value for given `key`, always returning a value `V`,
    /// as the EnumTable is pre-initialized with defaults.
    ///
    /// ### Args
    /// - `key` - Instance of `K`, used to look up the corresponding value.
    #[inline]
    pub fn get(&self, key: K) -> &V {
        &self.values[key.position()]
    }

    /// Stores given `value` under the provided `key`. Overrides any existing corresponding value.
    ///
    /// ### Args
    /// - `key` - The instance of `K` the value inserted can be looked up for.
    /// - `values` - Value to bind to `K`.
    #[inline]
    pub fn insert(&mut self, key: K, value: V) {
        self.values[key.position()] = value
    }

    /// 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.
    pub fn reset(&mut self, key: K) {
        self.values[key.position()] = V::default();
    }
}

impl<'a, K, V> Default for EnumTable<'a, K, V>
where
    K: Enumerated,
    V: Default,
{
    /// Constructs a new instance, capable of holding all values of key `K` without further resizing.
    fn default() -> Self {
        Self::new()
    }
}

impl<'a, K, V> Drop for EnumTable<'a, K, V>
where
    K: Enumerated,
    V: Default,
{
    /// The underlying memory allocated for values must be deallocated manually, as the destruction of the
    /// fat slice pointer doesn't guarantee it.
    fn drop(&mut self) {
        unsafe {
            dealloc(
                self.values.as_ptr() as *mut u8,
                Layout::array::<Option<V>>(K::len()).unwrap(),
            );
        };
    }
}

#[cfg(test)]
mod tests {
    use crate::Enumerated;

    use super::EnumTable;

    #[derive(Enumerated)]
    pub(super) enum Letter {
        A,
        B,
    }

    #[derive(Eq, PartialEq, Debug, Clone)]
    pub(super) struct Value {
        name: String,
    }

    impl Value {
        pub(super) fn new(name: String) -> Self {
            Self { name }
        }
    }

    impl Default for Value {
        fn default() -> Self {
            Self {
                name: "Non-empty default".to_owned(),
            }
        }
    }

    #[test]
    fn new_all_default() {
        let enum_table = EnumTable::<Letter, Value>::new();
        for index in 0..Letter::len() {
            assert_eq!(Value::default(), enum_table.values[index]);
        }
    }

    #[test]
    fn inserts() {
        let mut enum_table = EnumTable::<Letter, Value>::new();
        let inserted_value = Value::new("Hello".to_string());
        enum_table.insert(Letter::A, inserted_value.clone());
        assert_eq!(&inserted_value, enum_table.get(Letter::A));
        assert_eq!(&Value::default(), enum_table.get(Letter::B));
    }

    #[test]
    fn reset() {
        let mut enum_table = EnumTable::<Letter, Value>::new();
        let inserted_value = Value::new("Hello".to_string());
        enum_table.insert(Letter::A, inserted_value.clone());
        assert_eq!(&inserted_value, enum_table.get(Letter::A));
        enum_table.reset(Letter::A);
        assert_eq!(&Value::default(), enum_table.get(Letter::A));
        assert_eq!(&Value::default(), enum_table.get(Letter::B));
    }
}