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
use crate::{iter::atomic_iter::AtomicIterWithInitialLen, AtomicCounter, AtomicIter};
use std::{cell::UnsafeCell, cmp::Ordering};

/// A concurrent iterator over a vector, consuming the vector and yielding its elements.
#[derive(Debug)]
pub struct ConIterOfVec<T: Send + Sync + Default> {
    vec: UnsafeCell<Vec<T>>,
    vec_len: usize,
    counter: AtomicCounter,
}

impl<T: Send + Sync + Default> ConIterOfVec<T> {
    /// Consumes and creates a concurrent iterator of the given `vec`.
    pub fn new(vec: Vec<T>) -> Self {
        Self {
            vec_len: vec.len(),
            vec: vec.into(),
            counter: AtomicCounter::new(),
        }
    }

    #[inline(always)]
    #[allow(clippy::mut_from_ref)]
    unsafe fn mut_vec(&self) -> &mut Vec<T> {
        unsafe { &mut *self.vec.get() }
    }
}

impl<T: Send + Sync + Default> From<Vec<T>> for ConIterOfVec<T> {
    /// Consumes and creates a concurrent iterator of the given `vec`.
    fn from(vec: Vec<T>) -> Self {
        Self::new(vec)
    }
}

impl<T: Send + Sync + Default> AtomicIter for ConIterOfVec<T> {
    type Item = T;

    fn counter(&self) -> &AtomicCounter {
        &self.counter
    }

    fn get(&self, item_idx: usize) -> Option<Self::Item> {
        match item_idx.cmp(&self.vec_len) {
            Ordering::Less => {
                // SAFETY: only one thread can access the `item_idx`-th position and `item_idx` is in bounds
                let vec = unsafe { self.mut_vec() };
                let value = std::mem::take(&mut vec[item_idx]);
                Some(value)
            }
            _ => None,
        }
    }
}

impl<T: Send + Sync + Default> AtomicIterWithInitialLen for ConIterOfVec<T> {
    fn initial_len(&self) -> usize {
        self.vec_len
    }
}

unsafe impl<T: Send + Sync + Default> Sync for ConIterOfVec<T> {}

unsafe impl<T: Send + Sync + Default> Send for ConIterOfVec<T> {}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        iter::atomic_iter::tests::{
            atomic_exact_fetch_n, atomic_exact_fetch_one, atomic_fetch_n, atomic_fetch_one,
            ATOMIC_FETCH_N, ATOMIC_TEST_LEN,
        },
        ConcurrentIter,
    };

    #[test]
    fn new() {
        let values = vec!['a', 'b', 'c'];
        let con_iter = ConIterOfVec::new(values);

        let mut collected = vec![];
        while let Some(x) = con_iter.next() {
            collected.push(x);
        }

        assert_eq!(collected, vec!['a', 'b', 'c']);
    }

    #[test]
    fn from() {
        let values = vec!['a', 'b', 'c'];
        let con_iter: ConIterOfVec<_> = values.into();

        let mut collected = vec![];
        while let Some(x) = con_iter.next() {
            collected.push(x);
        }

        assert_eq!(collected, vec!['a', 'b', 'c']);
    }

    #[test]
    fn debug() {
        let values = vec!['a', 'b', 'c'];
        let con_iter: ConIterOfVec<_> = values.into();

        assert_eq!(
            format!("{:?}", con_iter),
            "ConIterOfVec { vec: UnsafeCell { .. }, vec_len: 3, counter: AtomicCounter { current: 0 } }"
        );

        assert_eq!(con_iter.next(), Some('a'));

        assert_eq!(
            format!("{:?}", con_iter),
            "ConIterOfVec { vec: UnsafeCell { .. }, vec_len: 3, counter: AtomicCounter { current: 1 } }"
        );
    }

    #[test]
    fn atomic() {
        let values: Vec<_> = (0..ATOMIC_TEST_LEN).collect();
        atomic_fetch_one(ConIterOfVec::new(values.clone()));
        for n in ATOMIC_FETCH_N {
            atomic_fetch_n(ConIterOfVec::new(values.clone()), n);
        }
    }

    #[test]
    fn atomic_exact() {
        let values: Vec<_> = (0..ATOMIC_TEST_LEN).collect();
        atomic_exact_fetch_one(ConIterOfVec::new(values.clone()));
        for n in ATOMIC_FETCH_N {
            atomic_exact_fetch_n(ConIterOfVec::new(values.clone()), n);
        }
    }
}