veloren_common/
store.rs

1use rayon::prelude::*;
2use std::{
3    cmp::{Eq, Ord, Ordering, PartialEq, PartialOrd},
4    fmt, hash,
5    marker::PhantomData,
6    ops::{Index, IndexMut},
7};
8
9// NOTE: We use u64 to make sure we are consistent across all machines.  We
10// assume that usize fits into 8 bytes.
11pub struct Id<T>(u64, PhantomData<T>);
12
13impl<T> Id<T> {
14    pub fn id(&self) -> u64 { self.0 }
15}
16
17impl<T> Copy for Id<T> {}
18impl<T> Clone for Id<T> {
19    fn clone(&self) -> Self { *self }
20}
21impl<T> Eq for Id<T> {}
22impl<T> PartialEq for Id<T> {
23    fn eq(&self, other: &Self) -> bool { self.0 == other.0 }
24}
25impl<T> Ord for Id<T> {
26    fn cmp(&self, other: &Self) -> Ordering { self.0.cmp(&(other.0)) }
27}
28impl<T> PartialOrd for Id<T> {
29    fn partial_cmp(&self, other: &Self) -> Option<Ordering> { Some(self.cmp(other)) }
30}
31impl<T> fmt::Debug for Id<T> {
32    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
33        write!(f, "Id<{}>({})", std::any::type_name::<T>(), self.0)
34    }
35}
36impl<T> hash::Hash for Id<T> {
37    fn hash<H: hash::Hasher>(&self, h: &mut H) { self.0.hash(h); }
38}
39
40pub struct Store<T> {
41    items: Vec<T>,
42}
43
44impl<T> Default for Store<T> {
45    fn default() -> Self { Self { items: Vec::new() } }
46}
47
48impl<T> Store<T> {
49    pub fn get(&self, id: Id<T>) -> &T {
50        // NOTE: Safe conversion, because it came from usize.
51        self.items.get(id.0 as usize).unwrap()
52    }
53
54    pub fn get_mut(&mut self, id: Id<T>) -> &mut T {
55        // NOTE: Safe conversion, because it came from usize.
56        self.items.get_mut(id.0 as usize).unwrap()
57    }
58
59    pub fn ids(&self) -> impl Iterator<Item = Id<T>> {
60        (0..self.items.len()).map(|i| Id(i as u64, PhantomData))
61    }
62
63    pub fn values(&self) -> impl ExactSizeIterator<Item = &T> { self.items.iter() }
64
65    pub fn values_mut(&mut self) -> impl ExactSizeIterator<Item = &mut T> { self.items.iter_mut() }
66
67    pub fn iter(&self) -> impl Iterator<Item = (Id<T>, &T)> { self.ids().zip(self.values()) }
68
69    pub fn iter_mut(&mut self) -> impl Iterator<Item = (Id<T>, &mut T)> {
70        self.ids().zip(self.values_mut())
71    }
72
73    pub fn insert(&mut self, item: T) -> Id<T> {
74        // NOTE: Assumes usize fits into 8 bytes.
75        let id = Id(self.items.len() as u64, PhantomData);
76        self.items.push(item);
77        id
78    }
79
80    pub fn recreate_id(&self, i: u64) -> Option<Id<T>> {
81        if i as usize >= self.items.len() {
82            None
83        } else {
84            Some(Id::<T>(i, PhantomData))
85        }
86    }
87}
88
89impl<T: Send + Sync> Store<T> {
90    pub fn par_iter_mut(&mut self) -> impl ParallelIterator<Item = (Id<T>, &mut T)> {
91        self.items
92            .par_iter_mut()
93            .enumerate()
94            .map(|(idx, obj)| (Id(idx as u64, PhantomData), obj))
95    }
96}
97
98impl<T> Index<Id<T>> for Store<T> {
99    type Output = T;
100
101    fn index(&self, id: Id<T>) -> &Self::Output { self.get(id) }
102}
103
104impl<T> IndexMut<Id<T>> for Store<T> {
105    fn index_mut(&mut self, id: Id<T>) -> &mut Self::Output { self.get_mut(id) }
106}
veloren_common/store.rs

veloren_common/
store.rs
