metamap 0.1.1

Metamap is a special `map` data structure for storing arbitrary types, designed to provide a flexible solution for scenarios where the type is uncertain. It allows you to easily store and retrieve various native Rust types as well as custom structs or enums, showcasing excellent flexibility and generalization capabilities.
Documentation 
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

#![doc = include_str!("../readme.md")]
use std::{
    any::{Any, TypeId},
    collections::{HashMap, HashSet},
    fmt::Debug,
};

/// Represents a Metamap object.
///
/// This struct contains a map that associates keys of type `String` with values of type `Box<dyn Any + Send + Sync>`.
/// It also has an optional field `extend` that holds a boxed `Metamap` object.
#[derive(Default)]
pub struct Metamap {
    map: HashMap<String, Box<dyn Any + Send + Sync>>,
    extend: Option<Box<Metamap>>,
}

impl Debug for Metamap {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut keys = self.map.keys().collect::<HashSet<&String>>();
        if let Some(p) = &self.extend {
            let keys2 = p.map.keys().collect::<HashSet<&String>>();
            keys.extend(keys2);
        }
        f.debug_struct("Meta").field("keys", &keys.iter()).finish()
    }
}

impl Metamap {
    pub fn new() -> Self {
        Metamap { map: HashMap::new(), extend: None }
    }

    pub fn inner(&self) -> &HashMap<String, Box<dyn Any + Send + Sync>> {
        &self.map
    }

    #[inline]
    pub fn with_capacity(capacity: usize) -> Self {
        Metamap { map: HashMap::with_capacity(capacity), extend: None }
    }

    pub fn capacity(&self) -> usize {
        self.map.capacity()
    }

    pub fn set<V: Any + Send + Sync>(&mut self, key: impl Into<String>, value: V) -> &mut Self {
        self.map.insert(key.into(), Box::new(value));
        self
    }

    pub fn get<V: Any + Send + Sync>(&self, key: impl Into<String>) -> Option<&V> {
        let key: String = key.into();
        let t = self.map.get(&key).and_then(|v| v.downcast_ref::<V>());
        let r = match t {
            Some(v) => Some(v),
            None => match &self.extend {
                Some(p) => p.get::<V>(key),
                None => None,
            },
        };
        r
    }

    pub fn get_mut<V: Any + Send + Sync>(&mut self, key: impl Into<String>) -> Option<&mut V> {
        let key = key.into();
        let t = self.map.get_mut(&key).and_then(|v| v.downcast_mut::<V>());
        match t {
            Some(v) => Some(v),
            None => None,
        }
    }

    pub fn set_data<V: Any + Send + Sync>(&mut self, value: V) -> &mut Self {
        self.set(type_key::<V>(), value)
    }

    pub fn get_data<V: Any + Send + Sync>(&self) -> Option<&V> {
        self.get(type_key::<V>())
    }

    pub fn get_mut_data<V: Any + Send + Sync>(&mut self) -> Option<&mut V> {
        self.get_mut(type_key::<V>())
    }

    pub fn take<V: Any + Send + Sync>(&mut self, key: impl Into<String>) -> Option<V> {
        let key: String = key.into();
        let t = self.map.remove(&key).and_then(|v| v.downcast::<V>().ok());
        t.map(|v| *v)
    }

    pub fn take_data<V: Any + Send + Sync>(&mut self) -> Option<V> {
        self.take(type_key::<V>())
    }

    pub fn contains(&self, key: impl Into<String>) -> bool {
        self.map.contains_key(&key.into())
    }

    pub fn contains_value<V: Any + Send + Sync>(&self) -> bool {
        self.contains(type_key::<V>())
    }

    pub fn remove(&mut self, key: impl Into<String>) -> Option<Box<dyn Any + Send + Sync>> {
        let key: String = key.into();
        let t = self.map.remove(&key);
        match t {
            Some(v) => Some(v),
            None => None,
        }
    }

    pub fn remove_value<V: Any + Send + Sync>(&mut self) -> Option<Box<dyn Any + Send + Sync>> {
        self.remove(type_key::<V>())
    }

    pub fn merge(&mut self, meta: Metamap) -> &mut Self {
        for (k, v) in meta.map {
            self.map.insert(k, v);
        }
        self
    }

    pub fn extend(&mut self, meta: Metamap) -> &mut Self {
        self.extend = Some(Box::new(meta));
        self
    }

    pub fn iter(&self) -> std::collections::hash_map::Iter<String, Box<dyn Any + Send + Sync>> {
        self.map.iter()
    }

    pub fn iter_mut(&mut self) -> std::collections::hash_map::IterMut<String, Box<dyn Any + Send + Sync>> {
        self.map.iter_mut()
    }

    pub fn keys(&self) -> Vec<String> {
        let mut keys = self.map.keys().collect::<HashSet<&String>>();
        if let Some(p) = &self.extend {
            let keys2 = p.map.keys().collect::<HashSet<&String>>();
            keys.extend(keys2);
        }
        keys.iter().map(|k| k.to_string()).collect()
    }

    pub fn len(&self) -> usize {
        self.map.len()
    }

    pub fn is_empty(&self) -> bool {
        self.map.is_empty()
    }

    pub fn clear(&mut self) {
        self.map.clear();
    }
}

pub fn type_key<T: 'static>() -> String {
    format!("{:?}", TypeId::of::<T>())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_metadata() {
        #[derive(Debug, PartialEq, Eq)]
        enum TestEnum {
            A,
            B,
        }

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

        #[derive(Debug, PartialEq, Eq)]
        struct TupleData(i32, String);

        let mut meta = Metamap::new();
        meta.set_data(TestEnum::A);
        meta.set_data(TestData { name: "test".to_string() });
        meta.set_data(TupleData(1, "tuple".to_string()));

        assert_eq!(*meta.get_data::<TestEnum>().unwrap(), TestEnum::A);
        assert_ne!(*meta.get_data::<TestEnum>().unwrap(), TestEnum::B);
        assert_eq!(*meta.get_data::<TestData>().unwrap(), TestData { name: "test".to_string() });
        assert_eq!(*meta.get_data::<TupleData>().unwrap(), TupleData(1, "tuple".to_string()));

        assert_eq!(meta.take_data::<TestData>().unwrap(), TestData { name: "test".to_string() });
        assert_eq!(meta.take_data::<TestEnum>().unwrap(), TestEnum::A);
        assert_eq!(meta.take_data::<TupleData>().unwrap(), TupleData(1, "tuple".to_string()));

        assert!(meta.get_data::<TestData>().is_none());
        assert!(meta.get_data::<TestEnum>().is_none());
        assert!(meta.get_data::<TupleData>().is_none());
    }

    #[test]
    fn test_meta() {
        let mut meta = Metamap::new();
        meta.set("a", 1);
        meta.set("b", "2");
        meta.set("c", 3.0);
        meta.set("d", "4".to_string());
        meta.set("e", vec![1, 2, 3]);
        meta.set("f", vec!["1", "2", "3"]);
        meta.set("g", vec![1.0, 2.0, 3.0]);
        meta.set("h", vec!["1".to_string(), "2".to_string(), "3".to_string()]);
        meta.set("i", vec![vec![1, 2], vec![3, 4]]);
        meta.set("j", vec![vec!["1", "2"], vec!["3", "4"]]);
        meta.set("k", vec![vec![1.0, 2.0], vec![3.0, 4.0]]);
        meta.set("l", vec![vec!["1".to_string(), "2".to_string()], vec!["3".to_string(), "4".to_string()]]);

        assert_eq!(*meta.get::<i32>("a").unwrap(), 1);
        assert_eq!(*meta.get::<&str>("b").unwrap(), "2");
        assert_eq!(*meta.get::<f64>("c").unwrap(), 3.0);
        assert_eq!(*meta.get::<String>("d").unwrap(), "4".to_string());
        assert_eq!(*meta.get::<Vec<i32>>("e").unwrap(), vec![1, 2, 3]);
        assert_eq!(*meta.get::<Vec<&str>>("f").unwrap(), vec!["1", "2", "3"]);
        assert_eq!(*meta.get::<Vec<f64>>("g").unwrap(), vec![1.0, 2.0, 3.0]);
        assert_eq!(*meta.get::<Vec<String>>("h").unwrap(), vec!["1".to_string(), "2".to_string(), "3".to_string()]);
        assert_eq!(*meta.get::<Vec<Vec<i32>>>("i").unwrap(), vec![vec![1, 2], vec![3, 4]]);
        assert_eq!(*meta.get::<Vec<Vec<&str>>>("j").unwrap(), vec![vec!["1", "2"], vec!["3", "4"]]);
    }

    #[test]
    fn test_mut_meta() {
        let mut meta = Metamap::new();
        meta.set("a", 1);
        meta.set("b", "2");
        meta.set("c", 3.0);
        meta.set("d", "4".to_string());
        meta.set("e", vec![1, 2, 3]);
        meta.set("f", vec!["1", "2", "3"]);
        meta.set("g", vec![1.0, 2.0, 3.0]);
        meta.set("h", vec!["1".to_string(), "2".to_string(), "3".to_string()]);
        meta.set("i", vec![vec![1, 2], vec![3, 4]]);
        meta.set("j", vec![vec!["1", "2"], vec!["3", "4"]]);
        meta.set("k", vec![vec![1.0, 2.0], vec![3.0, 4.0]]);
        meta.set("l", vec![vec!["1".to_string(), "2".to_string()], vec!["3".to_string(), "4".to_string()]]);

        *meta.get_mut::<i32>("a").unwrap() = 2;
        *meta.get_mut::<&str>("b").unwrap() = "3";
        *meta.get_mut::<f64>("c").unwrap() = 4.0;
        *meta.get_mut::<String>("d").unwrap() = "5".to_string();
        *meta.get_mut::<Vec<i32>>("e").unwrap() = vec![2, 3, 4];
        *meta.get_mut::<Vec<&str>>("f").unwrap() = vec!["2", "3", "4"];
        *meta.get_mut::<Vec<f64>>("g").unwrap() = vec![2.0, 3.0, 4.0];
        *meta.get_mut::<Vec<String>>("h").unwrap() = vec!["2".to_string(), "3".to_string(), "4".to_string()];
        *meta.get_mut::<Vec<Vec<i32>>>("i").unwrap() = vec![vec![2, 3], vec![4, 5]];
        *meta.get_mut::<Vec<Vec<&str>>>("j").unwrap() = vec![vec!["2", "3"], vec!["4", "5"]];

        assert_eq!(*meta.get::<i32>("a").unwrap(), 2);
        assert_eq!(*meta.get::<&str>("b").unwrap(), "3");
        assert_eq!(*meta.get::<f64>("c").unwrap(), 4.0);
        assert_eq!(*meta.get::<String>("d").unwrap(), "5".to_string());
        assert_eq!(*meta.get::<Vec<i32>>("e").unwrap(), vec![2, 3, 4]);
        assert_eq!(*meta.get::<Vec<&str>>("f").unwrap(), vec!["2", "3", "4"]);
        assert_eq!(*meta.get::<Vec<f64>>("g").unwrap(), vec![2.0, 3.0, 4.0]);
        assert_eq!(*meta.get::<Vec<String>>("h").unwrap(), vec!["2".to_string(), "3".to_string(), "4".to_string()]);
        assert_eq!(*meta.get::<Vec<Vec<i32>>>("i").unwrap(), vec![vec![2, 3], vec![4, 5]]);
        assert_eq!(*meta.get::<Vec<Vec<&str>>>("j").unwrap(), vec![vec!["2", "3"], vec!["4", "5"]]);
    }

    #[test]
    fn test_meta_merge() {
        let mut meta1 = Metamap::new();
        meta1.set("a", 1);
        meta1.set("b", "2");
        meta1.set("c", 3.0);
        meta1.set("d", "4".to_string());
        meta1.set("e", vec![1, 2, 3]);
        meta1.set("f", vec!["1", "2", "3"]);
        meta1.set("g", vec![1.0, 2.0, 3.0]);
        meta1.set("h", vec!["1".to_string(), "2".to_string(), "3".to_string()]);
        meta1.set("i", vec![vec![1, 2], vec![3, 4]]);
        meta1.set("j", vec![vec!["1", "2"], vec!["3", "4"]]);
        meta1.set("k", vec![vec![1.0, 2.0], vec![3.0, 4.0]]);
        meta1.set("l", vec![vec!["1".to_string(), "2".to_string()], vec!["3".to_string(), "4".to_string()]]);

        let mut meta2 = Metamap::new();
        meta2.set("e", vec![2, 3, 4]);
        meta2.set("f", vec!["2", "3", "4"]);
        meta2.set("g", vec![2.0, 3.0, 4.0]);
        meta2.set("h", vec!["2".to_string(), "3".to_string(), "4".to_string()]);
        meta2.set("i", vec![vec![2, 3], vec![4, 5]]);
        meta2.set("j", vec![vec!["2", "3"], vec!["4", "5"]]);

        meta1.merge(meta2);

        assert_eq!(*meta1.get::<i32>("a").unwrap(), 1);
        assert_eq!(*meta1.get::<&str>("b").unwrap(), "2");
        assert_eq!(*meta1.get::<f64>("c").unwrap(), 3.0);
        assert_eq!(*meta1.get::<String>("d").unwrap(), "4".to_string());
        assert_eq!(*meta1.get::<Vec<i32>>("e").unwrap(), vec![2, 3, 4]);
        assert_eq!(*meta1.get::<Vec<&str>>("f").unwrap(), vec!["2", "3", "4"]);
        assert_eq!(*meta1.get::<Vec<f64>>("g").unwrap(), vec![2.0, 3.0, 4.0]);
        assert_eq!(*meta1.get::<Vec<String>>("h").unwrap(), vec!["2".to_string(), "3".to_string(), "4".to_string()]);
        assert_eq!(*meta1.get::<Vec<Vec<i32>>>("i").unwrap(), vec![vec![2, 3], vec![4, 5]]);
        assert_eq!(*meta1.get::<Vec<Vec<&str>>>("j").unwrap(), vec![vec!["2", "3"], vec!["4", "5"]]);
    }

    #[test]
    fn test_meta_extend() {
        let mut meta1 = Metamap::new();
        meta1.set("a", 1);
        meta1.set("b", "2");
        meta1.set("c", 3.0);
        meta1.set("d", "4".to_string());
        meta1.set("e", vec![1, 2, 3]);
        meta1.set("f", vec!["1", "2", "3"]);
        meta1.set("g", vec![1.0, 2.0, 3.0]);

        let mut meta2 = Metamap::new();
        meta2.set("e", vec![2, 3, 4]);
        meta2.set("i", vec![vec![2, 3], vec![4, 5]]);
        meta2.set("j", vec![vec!["2", "3"], vec!["4", "5"]]);

        meta1.extend(meta2);

        assert_eq!(*meta1.get::<i32>("a").unwrap(), 1);
        assert_eq!(*meta1.get::<&str>("b").unwrap(), "2");
        assert_eq!(*meta1.get::<f64>("c").unwrap(), 3.0);
        assert_eq!(*meta1.get::<String>("d").unwrap(), "4".to_string());
        assert_eq!(*meta1.get::<Vec<i32>>("e").unwrap(), vec![1, 2, 3]);
        assert_eq!(*meta1.get::<Vec<&str>>("f").unwrap(), vec!["1", "2", "3"]);
        assert_eq!(*meta1.get::<Vec<f64>>("g").unwrap(), vec![1.0, 2.0, 3.0]);
        assert_eq!(*meta1.get::<Vec<Vec<i32>>>("i").unwrap(), vec![vec![2, 3], vec![4, 5]]);
        assert_eq!(*meta1.get::<Vec<Vec<&str>>>("j").unwrap(), vec![vec!["2", "3"], vec!["4", "5"]]);
    }
}