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

veloren_common/
store.rs
