gen_map 0.2.2

This crate provides customizable generational maps.
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

use super::{Bomb, DropTracker};
use crate::GenMap;
use std::collections::HashSet;
use std::panic::{catch_unwind, AssertUnwindSafe};
use std::vec::Vec;

type Map = GenMap<i32>;

#[test]
fn iter_on_empty_map_is_empty() {
    let map = Map::new();
    assert_eq!(map.iter().count(), 0);
    assert_eq!(map.iter().len(), 0);
}

#[test]
fn iter_covers_every_value_in_slot_order() {
    let mut map = Map::new();
    let keys: Vec<_> = (0..13).map(|i| map.insert(i)).collect();

    let seen: Vec<_> = map.iter().collect();
    assert_eq!(seen.len(), keys.len());
    for (i, ((key, value), expected)) in seen.iter().zip(&keys).enumerate() {
        assert_eq!(key, expected);
        assert_eq!(**value, i as i32);
        assert!(core::ptr::eq(*value, map.get(*key).unwrap()));
    }
}

#[test]
fn iter_skips_vacant_slots() {
    let mut map = Map::new();
    let keys: Vec<_> = (0..10).map(|i| map.insert(i)).collect();
    for &k in keys.iter().step_by(2) {
        map.remove(k);
    }

    let values: Vec<_> = map.values().copied().collect();
    assert_eq!(values, [1, 3, 5, 7, 9]);
}

#[test]
fn iter_is_exact_size_even_with_gaps() {
    let mut map = Map::new();
    let keys: Vec<_> = (0..10).map(|i| map.insert(i)).collect();
    map.remove(keys[0]);
    map.remove(keys[9]);

    let mut iter = map.iter();
    assert_eq!(iter.len(), 8);
    assert_eq!(iter.size_hint(), (8, Some(8)));
    iter.next();
    assert_eq!(iter.len(), 7);
    assert_eq!(map.keys().len(), 8);
    assert_eq!(map.values().len(), 8);
}

#[test]
fn iter_is_double_ended() {
    let mut map = Map::new();
    for i in 0..6 {
        map.insert(i);
    }
    let backwards: Vec<_> = map.values().rev().copied().collect();
    assert_eq!(backwards, [5, 4, 3, 2, 1, 0]);

    let mut iter = map.values();
    assert_eq!(iter.next(), Some(&0));
    assert_eq!(iter.next_back(), Some(&5));
    assert_eq!(iter.len(), 4);
}

#[test]
fn keys_and_values_match_iter() {
    let mut map = Map::new();
    for i in 0..20 {
        map.insert(i * 10);
    }

    let from_iter: HashSet<_> = map.iter().map(|(k, _)| k).collect();
    let from_keys: HashSet<_> = map.keys().collect();
    assert_eq!(from_iter, from_keys);

    let from_iter: Vec<_> = map.iter().map(|(_, v)| *v).collect();
    let from_values: Vec<_> = map.values().copied().collect();
    assert_eq!(from_iter, from_values);
}

#[test]
fn iter_mut_yields_valid_keys_and_can_modify() {
    let mut map = Map::new();
    let keys: Vec<_> = (0..40).map(|i| map.insert(i)).collect();

    for (key, value) in &mut map {
        assert!(map_contains(&keys, key));
        *value += 1000;
    }
    for value in map.values_mut() {
        *value += 1;
    }

    let values: Vec<_> = map.values().copied().collect();
    assert_eq!(values, (1001..1041).collect::<Vec<_>>());
    assert_eq!(map.iter_mut().len(), 40);
    assert_eq!(map.values_mut().next_back().copied(), Some(1040));
}

fn map_contains(keys: &[crate::Key], key: crate::Key) -> bool {
    keys.contains(&key)
}

#[test]
fn into_iter_yields_owned_values_with_keys() {
    let mut map = Map::new();
    let keys: Vec<_> = (0..40).map(|i| map.insert(i)).collect();
    map.remove(keys[3]);

    let iter = map.into_iter();
    assert_eq!(iter.len(), 39);
    let items: Vec<_> = iter.collect();
    assert_eq!(items.len(), 39);
    assert_eq!(items[0], (keys[0], 0));
    assert_eq!(items[3], (keys[4], 4));
    assert_eq!(items[38], (keys[39], 39));
}

#[test]
fn into_iter_is_double_ended() {
    let mut map = Map::new();
    for i in 0..5 {
        map.insert(i);
    }
    let backwards: Vec<_> = map.into_iter().rev().map(|(_, v)| v).collect();
    assert_eq!(backwards, [4, 3, 2, 1, 0]);
}

#[test]
fn into_iter_drops_each_value_exactly_once() {
    let tracker = DropTracker::new();
    let mut map = GenMap::new();
    let keys: Vec<_> = (0..6).map(|_| map.insert(tracker.make_item())).collect();
    map.remove(keys[2]);
    assert_eq!(tracker.total_dropped(), 1);

    let mut iter = map.into_iter();
    drop(iter.next().unwrap());
    assert_eq!(tracker.total_dropped(), 2);
    drop(iter);

    tracker.assert_all_dropped_exactly_once(6);
}

/// A map that held 0 to 7 and had 0, 3 and 7 removed, so it has gaps at
/// both ends and in the middle. The values left are 1, 2, 4, 5 and 6.
fn map_with_gaps() -> Map {
    let mut map = Map::new();
    let keys: Vec<_> = (0..8).map(|i| map.insert(i)).collect();
    for i in [0, 3, 7] {
        map.remove(keys[i]);
    }
    map
}

#[test]
fn every_iterator_skips_gaps_from_the_back() {
    let mut map = map_with_gaps();
    let expected = [6, 5, 4, 2, 1];

    let values: Vec<_> = map.iter().rev().map(|(_, v)| *v).collect();
    assert_eq!(values, expected);
    let values: Vec<_> = map.keys().rev().map(|key| map[key]).collect();
    assert_eq!(values, expected);
    let values: Vec<_> = map.values().rev().copied().collect();
    assert_eq!(values, expected);
    let values: Vec<_> = map.iter_mut().rev().map(|(_, v)| *v).collect();
    assert_eq!(values, expected);
    let values: Vec<_> = map.values_mut().rev().map(|v| *v).collect();
    assert_eq!(values, expected);
    let values: Vec<_> = map.into_iter().rev().map(|(_, v)| v).collect();
    assert_eq!(values, expected);
}

/// Takes from both ends of `iter`, which must yield the values of
/// [`map_with_gaps`], until the two ends meet in the middle.
fn meet_in_the_middle(mut iter: impl DoubleEndedIterator<Item = i32> + ExactSizeIterator) {
    assert_eq!((iter.next(), iter.next_back()), (Some(1), Some(6)));
    assert_eq!(iter.len(), 3);
    assert_eq!((iter.next(), iter.next_back()), (Some(2), Some(5)));
    assert_eq!((iter.next_back(), iter.len()), (Some(4), 0));
    assert_eq!((iter.next(), iter.next_back()), (None, None));
}

#[test]
fn iterators_stop_where_the_front_and_the_back_meet() {
    let mut map = map_with_gaps();
    meet_in_the_middle(map.iter().map(|(_, v)| *v));
    meet_in_the_middle(map.iter_mut().map(|(_, v)| *v));
    meet_in_the_middle(map.into_iter().map(|(_, v)| v));
}

#[test]
fn mutable_iterators_know_their_length() {
    let mut map = map_with_gaps();
    assert_eq!(map.iter_mut().len(), 5);
    let mut values = map.values_mut();
    assert_eq!(values.len(), 5);
    values.next_back();
    assert_eq!(values.size_hint(), (4, Some(4)));
}

#[test]
fn a_cloned_iterator_carries_on_by_itself() {
    let map = map_with_gaps();
    let rest = [2, 4, 5, 6];

    let mut iter = map.iter();
    iter.next();
    let copy = iter.clone();
    assert_eq!(iter.map(|(_, v)| *v).collect::<Vec<_>>(), rest);
    assert_eq!(copy.map(|(_, v)| *v).collect::<Vec<_>>(), rest);

    let mut keys = map.keys();
    keys.next();
    let copy = keys.clone();
    assert_eq!(keys.map(|key| map[key]).collect::<Vec<_>>(), rest);
    assert_eq!(copy.map(|key| map[key]).collect::<Vec<_>>(), rest);

    let mut values = map.values();
    values.next();
    let copy = values.clone();
    assert_eq!(values.copied().collect::<Vec<_>>(), rest);
    assert_eq!(copy.copied().collect::<Vec<_>>(), rest);
}

#[test]
fn iterators_are_fused() {
    let mut map = Map::new();
    map.insert(1);
    let mut iter = map.iter();
    assert!(iter.next().is_some());
    assert!(iter.next().is_none());
    assert!(iter.next().is_none());
}

#[test]
fn into_iter_drops_every_value_once_when_a_drop_panics() {
    let tracker = DropTracker::new();
    let mut map = GenMap::new();
    for i in 0..5 {
        map.insert(Bomb::new(&tracker, i == 2));
    }

    let mut iter = map.into_iter();
    drop(iter.next());
    assert!(catch_unwind(AssertUnwindSafe(move || drop(iter))).is_err());
    tracker.assert_all_dropped_exactly_once(5);
}