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
use super::entity::Entity;
use crate::no_such_entity::NoSuchEntity;
use crate::Entities;
use std::fmt::Debug;
use std::sync::{Arc, RwLock};
#[derive(Debug)]
pub struct VecStorage<T> {
vec: Vec<Option<T>>,
entities: Arc<RwLock<Entities>>,
}
impl<T> VecStorage<T> {
pub fn new(entities: Arc<RwLock<Entities>>, capacity: u32) -> Self {
let mut vec = vec![];
vec.resize_with(capacity as usize, Default::default);
Self { vec, entities }
}
pub fn get(&self, entity: Entity) -> Option<&T> {
let lock = self.entities.read().unwrap();
if lock.exists(entity) {
self.vec
.get(entity.index as usize)
.unwrap_or(&None)
.as_ref()
} else {
None
}
}
pub fn get_mut(&mut self, entity: Entity) -> Option<&mut T> {
let lock = self.entities.read().unwrap();
if lock.exists(entity) {
if let Some(entry) = self.vec.get_mut(entity.index as usize) {
entry.as_mut()
} else {
None
}
} else {
None
}
}
pub fn set(&mut self, entity: Entity, data: T) -> Result<Option<T>, NoSuchEntity> {
let lock = self.entities.read().unwrap();
if lock.exists(entity) {
match self.vec.get_mut(entity.index as usize) {
None => {
let new_len = usize::max(self.vec.capacity() * 2, entity.index as usize + 1);
self.vec.resize_with(new_len, || None);
self.vec[entity.index as usize] = Some(data);
Ok(None)
}
Some(entry) => Ok(entry.replace(data)),
}
} else {
Err(NoSuchEntity {})
}
}
pub fn remove_unchecked(&mut self, entity: Entity) -> Option<T> {
if let Some(entry) = self.vec.get_mut(entity.index as usize) {
entry.take()
} else {
None
}
}
pub fn remove(&mut self, entity: Entity) -> Result<Option<T>, NoSuchEntity> {
let lock = self.entities.read().unwrap();
if lock.exists(entity) {
if let Some(entry) = self.vec.get_mut(entity.index as usize) {
Ok(entry.take())
} else {
Ok(None)
}
} else {
Err(NoSuchEntity)
}
}
pub fn clear(&mut self) {
self.vec.clear();
}
}
#[cfg(test)]
mod tests {
use super::*;
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
struct VecTestData(i32);
#[test]
fn vec_get_not_set() {
let entities = Arc::new(RwLock::new(Entities::new(3)));
let vec = VecStorage::<VecTestData>::new(Arc::clone(&entities), 3);
let entity = Entity {
index: 0,
generation: 0,
};
let entry = vec.get(entity);
assert_eq!(entry, None);
}
#[test]
fn vec_get() -> Result<(), NoSuchEntity> {
let entities = Arc::new(RwLock::new(Entities::new(3)));
let mut vec = VecStorage::<VecTestData>::new(Arc::clone(&entities), 3);
let entity = {
let mut lock = entities.write().unwrap();
lock.spawn()
};
let data = VecTestData(42);
let old_data = vec.set(entity, data)?;
assert_eq!(old_data, None);
let entry = vec.get(entity);
assert_eq!(entry, Some(&data));
Ok(())
}
#[test]
fn vec_set_exists() -> Result<(), NoSuchEntity> {
let entities = Arc::new(RwLock::new(Entities::new(3)));
let mut vec = VecStorage::<VecTestData>::new(Arc::clone(&entities), 3);
let entity = {
let mut lock = entities.write().unwrap();
lock.spawn()
};
let data = VecTestData(42);
let old_data = vec.set(entity, data)?;
assert_eq!(old_data, None);
assert_eq!(vec.get(entity), Some(&data));
let wrong_entity = Entity {
index: 0,
generation: 1,
};
assert!(vec.set(wrong_entity, VecTestData(69)).is_err());
Ok(())
}
#[test]
fn can_insert_after_remove() -> Result<(), NoSuchEntity> {
let entities = Arc::new(RwLock::new(Entities::new(3)));
let mut vec = VecStorage::<VecTestData>::new(Arc::clone(&entities), 3);
let entity = {
let mut lock = entities.write().unwrap();
lock.spawn()
};
let data = VecTestData(42);
vec.set(entity, data)?;
let removed_data = vec.remove(entity)?;
assert_eq!(removed_data, Some(VecTestData(42)));
let missing_entry = vec.get(entity);
assert_eq!(missing_entry, None);
let missing_entry = vec.set(entity, data)?;
assert_eq!(missing_entry, None);
let entry = vec.get(entity);
assert_eq!(entry, Some(&VecTestData(42)));
Ok(())
}
#[test]
fn cannot_access_out_of_bounds() {
let n = 3;
let entities = Arc::new(RwLock::new(Entities::new(3)));
let vec = VecStorage::<VecTestData>::new(Arc::clone(&entities), 3);
let entity = Entity {
index: n,
generation: 0,
};
let nope = vec.get(entity);
assert_eq!(nope, None);
}
#[test]
fn inserting_grows_vec_enough() -> Result<(), NoSuchEntity> {
let capacity = 1;
let n = 3;
let entities = Arc::new(RwLock::new(Entities::new(capacity)));
let mut vec = VecStorage::<VecTestData>::new(Arc::clone(&entities), capacity);
let entity = {
let mut lock = entities.write().unwrap();
for _i in 0..n - 1 {
lock.spawn();
}
lock.spawn()
};
let data = VecTestData(42);
let old_data = vec.set(entity, data)?;
assert_eq!(old_data, None);
let value = vec.get(entity);
assert_eq!(value, Some(&data));
Ok(())
}
#[test]
fn remove_missing_is_ok() -> Result<(), NoSuchEntity> {
let entities = Arc::new(RwLock::new(Entities::new(3)));
let mut vec = VecStorage::<VecTestData>::new(Arc::clone(&entities), 3);
let entity = {
let mut lock = entities.write().unwrap();
lock.spawn()
};
let remove_result = vec.remove(entity)?;
assert_eq!(remove_result, None);
Ok(())
}
#[test]
fn test_iter_update() -> Result<(), NoSuchEntity> {
let entities = Arc::new(RwLock::new(Entities::new(3)));
let mut vec = VecStorage::<VecTestData>::new(Arc::clone(&entities), 3);
let (entity1, entity2) = {
let mut write = entities.write().unwrap();
let entity1 = write.spawn();
let entity2 = write.spawn();
write.spawn();
(entity1, entity2)
};
vec.set(entity1, VecTestData(1))?;
vec.set(entity2, VecTestData(2))?;
{
let read = entities.read().unwrap();
let mut expected_value = 1;
for entity in read.iter() {
if let Some(data) = vec.get_mut(entity) {
assert_eq!(data.0, expected_value);
expected_value += 1;
*data = VecTestData(40 + data.0);
}
}
let mut expected_value = 41;
for entity in read.iter() {
if let Some(data) = vec.get(entity) {
assert_eq!(data.0, expected_value);
expected_value += 1;
}
}
}
Ok(())
}
}