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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
use std::collections::hash_map;
use std::slice;
use std::hash::Hash;
use std::cmp::Eq;
use std::ops::DerefMut;
use std::fmt::{self, Debug};
use std::iter::{Iterator, ExactSizeIterator};

use stable_deref_trait::StableDeref;


use super::TotalOrderMultiMap;


impl<K, V> TotalOrderMultiMap<K, V>
    where K: Hash+Eq+Copy,
          V: StableDeref + DerefMut
{
    /// Return an iterator the keys of this multi map.
    ///
    /// each key will only be returned once, there is
    /// no specific order in which they keys are returned
    pub fn keys(&self) -> Keys<K, V::Target> {
        Keys { inner_iter: self.map_access.keys() }
    }

    /// Returns a iterator over all values grouped by key.
    pub fn group_iter(&self) -> GroupedValues<K, V::Target> {
        GroupedValues { inner_iter: self.map_access.iter() }
    }

    /// Returns a iterator over all values grouped by key
    pub fn group_iter_mut(&mut self) -> GroupedValuesMut<K, V::Target> {
        GroupedValuesMut { inner_iter: self.map_access.iter_mut() }
    }

    /// Returns a iterator over the inner-values in this multi map.
    ///
    /// Inner-Values are returned in the order they where inserted into
    /// the map. Note that
    pub fn values(&self) -> Values<K, V> {
        Values { inner_iter: self.vec_data.iter() }
    }


    /// Returns a iterator over the values in this multi map.
    pub fn values_mut(&mut self) -> ValuesMut<K, V> {
        ValuesMut { inner_iter: self.vec_data.iter_mut() }
    }
}

#[derive(Clone)]
pub struct Keys<'a, K: 'a, T: ?Sized + 'a> {
    inner_iter: hash_map::Keys<'a, K, Vec<*mut T>>
}

impl<'a, K: Debug+'a, T: 'a> Debug for Keys<'a, K, T> {
    fn fmt(&self, fter: &mut fmt::Formatter) -> fmt::Result {
        self.inner_iter.fmt(fter)
    }
}

impl<'a, K: 'a, T: 'a> Iterator for Keys<'a, K, T>
    where K: Copy
{
    type Item = K;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        self.inner_iter.next().map(|&k|k)
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.inner_iter.size_hint()
    }
}

impl<'a, K, T> ExactSizeIterator for Keys<'a, K, T>
    where K: Copy + 'a, T: 'a
{
    #[inline]
    fn len(&self) -> usize {
        self.inner_iter.len()
    }
}

//TODO consider merging this with EntryValues
/// A iterator over `&V::Target` values returned by `GroupedValues`.
///
/// It will iterate over all values associated with a specific key
/// in the order they where inserted.
pub struct Group<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a,
{
    /// Note: we have a & to an *mut so we can only use it as *const/&
    inner_iter: slice::Iter<'a, *mut T>,
    key: K
}

impl<'a, K, T> Clone for Group<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a,
{
    fn clone(&self) -> Self {
        Group {
            key: self.key.clone(),
            inner_iter: self.inner_iter.clone(),
        }
    }
}

impl<'a, K, T> Group<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a,
{
    pub fn key(&self) -> K {
        self.key
    }
}

impl<'a, K, T> Iterator for Group<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a
{
    type Item = &'a T;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        //SAFE see TotalOrderMultiMap safety guarantees/constraints
        self.inner_iter.next().map(|&ptr| unsafe { &*ptr } )
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.inner_iter.size_hint()
    }
}

/// A iterator over `&mut V::Target` values returned by `GroupedValues`.
///
/// It will iterate over all values associated with a specific key
/// in the order they where inserted.
pub struct GroupMut<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a,
{
    /// Note: we have a & to an *mut so we can only use it as *const/&
    inner_iter: slice::IterMut<'a, *mut T>,
    key: K
}

impl<'a, K, T> GroupMut<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a,
{
    pub fn key(&self) -> K {
        self.key
    }
}

impl<'a, K, T> Iterator for GroupMut<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a
{
    type Item = &'a mut T;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        //SAFE see TotalOrderMultiMap safety guarantees/constraints
        self.inner_iter.next().map(|&mut ptr| unsafe { &mut *ptr } )
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.inner_iter.size_hint()
    }
}


impl<'a, K, T> ExactSizeIterator for GroupMut<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a,
{
    #[inline]
    fn len(&self) -> usize {
        self.inner_iter.len()
    }
}

impl<'a, K, T> Debug for Group<'a, K, T>
    where K: Debug + Copy + 'a,
          T: Debug + ?Sized + 'a,
{
    fn fmt(&self, fter: &mut fmt::Formatter) -> fmt::Result {
        fter.write_str("Group { .. }")
    }
}


/// An iterator of Groups (no fixed iteration order).
pub struct GroupedValues<
    'a,
    K: Copy + 'a,
    T: ?Sized + 'a,
> {
    /// Note: we have a `&` to an `*mut` so we can only use it as `*const`
    inner_iter: hash_map::Iter<'a, K, Vec<*mut T>>
}

impl<'a, K, T> Clone for GroupedValues<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a,
{
    #[inline]
    fn clone(&self) -> Self {
        GroupedValues { inner_iter: self.inner_iter.clone() }
    }

}

impl<'a, K, T> Debug for GroupedValues<'a, K, T>
    where K: Copy + 'a,
          T: Debug + ?Sized + 'a,
{
    fn fmt(&self, fter: &mut fmt::Formatter) -> fmt::Result {
        fter.debug_list()
            .entry(&self.clone())
            .finish()
    }
}

impl<'a, K, T> Iterator for GroupedValues<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a,
{
    type Item = Group<'a, K, T>;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        self.inner_iter.next().map(|(k, values)| {
            Group {
                inner_iter: values.iter(),
                key: *k,
            }
        })
    }
}

/// An iterator of Groups (no fixed iteration order).
pub struct GroupedValuesMut<
    'a,
    K: Copy + 'a,
    T: ?Sized + 'a,
> {
    inner_iter: hash_map::IterMut<'a, K, Vec<*mut T>>
}

impl<'a, K, T> Debug for GroupedValuesMut<'a, K, T>
    where K: Copy + 'a,
          T: Debug + ?Sized + 'a,
{
    fn fmt(&self, fter: &mut fmt::Formatter) -> fmt::Result {
        fter.write_str("GroupedValuesMut { .. }")
    }
}

impl<'a, K, T> Iterator for GroupedValuesMut<'a, K, T>
    where K: Copy + 'a,
          T: ?Sized + 'a,
{
    type Item = GroupMut<'a, K, T>;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        self.inner_iter.next().map(|(k, values)| {
            GroupMut {
                inner_iter: values.iter_mut(),
                key: *k,
            }
        })
    }
}



pub struct Values<'a, K: 'a, V: 'a> {
    inner_iter: slice::Iter<'a, (K, V)>
}

pub struct ValuesMut<'a, K: 'a, V: 'a> {
    inner_iter: slice::IterMut<'a, (K, V)>
}

impl<'a, K: 'a, V: 'a> From<ValuesMut<'a, K, V>> for Values<'a, K, V> {
    fn from(valsmut: ValuesMut<'a, K, V>) -> Self {
        let ValuesMut { inner_iter } = valsmut;
        let as_slice = inner_iter.into_slice();
        let inner_iter = as_slice.iter();
        Values { inner_iter }
    }
}

impl<'a, K: 'a, V: 'a> Clone for Values<'a, K, V> {
    fn clone(&self) -> Self {
        Values { inner_iter: self.inner_iter.clone() }
    }
}

impl<'a, K: 'a, V: 'a> Iterator for Values<'a, K, V>
    where V: StableDeref + DerefMut
{
    type Item = &'a V::Target;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        self.inner_iter.next()
            .map(|&(_, ref v)| &**v)
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.inner_iter.size_hint()
    }
}

impl<'a, K: 'a, V: 'a> ExactSizeIterator for Values<'a, K, V>
    where V: StableDeref + DerefMut
{
    fn len(&self) -> usize {
        self.inner_iter.len()
    }
}

impl<'a, K: 'a, V: 'a> Debug for Values<'a, K, V>
    where V: StableDeref + DerefMut, V::Target: Debug
{
    fn fmt(&self, fter: &mut fmt::Formatter) -> fmt::Result {
        fter.debug_list().entries(self.clone()).finish()
    }
}


impl<'a, K: 'a, V: 'a> Iterator for ValuesMut<'a, K, V>
    where V: StableDeref + DerefMut
{
    type Item = &'a mut V::Target;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        self.inner_iter.next().map(|&mut (_, ref mut v)| {
            &mut **v
        })
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.inner_iter.size_hint()
    }

}

impl<'a, K: 'a, V: 'a> ExactSizeIterator for ValuesMut<'a, K, V>
    where V: StableDeref + DerefMut
{
    fn len(&self) -> usize {
        self.inner_iter.len()
    }
}

impl<'a, K: 'a, V: 'a> Debug for ValuesMut<'a, K, V>
    where V: StableDeref + DerefMut, V::Target: Debug
{
    fn fmt(&self, fter: &mut fmt::Formatter) -> fmt::Result {
        fter.write_str("ValuesMut { .. }")
    }
}

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

    #[test]
    fn convert_mut_values_to_non_mut() {
        let mut map = TotalOrderMultiMap::new();
        map.add("k1", "v1".to_owned());
        map.add("k0", "v2".to_owned());

        let iter: Values<_, _> = map.values_mut().into();
        assert_eq!(
            vec!["v1", "v2"],
            iter.collect::<Vec<_>>()
        )
    }
}