orx-concurrent-iter 3.3.0

A thread-safe and ergonomic concurrent iterator trait and efficient lock-free implementations.
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

use super::chunk_puller::EnumeratedChunkPuller;
use crate::ConcurrentIter;

/// An enumerated version of a concurrent iterator which additionally yields
/// the index of elements in the source collection.
///
/// It can be created by calling [`enumerate`] on a concurrent iterator.
///
/// [`enumerate`]: crate::ConcurrentIter::enumerate
///
/// # Examples
///
/// ```
/// use orx_concurrent_iter::*;
///
/// let vec = vec!['x', 'y'];
///
/// let con_iter = vec.con_iter().enumerate();
/// assert_eq!(con_iter.next(), Some((0, &'x')));
/// assert_eq!(con_iter.next(), Some((1, &'y')));
/// assert_eq!(con_iter.next(), None);
/// ```
pub struct Enumerate<I>
where
    I: ConcurrentIter,
{
    iter: I,
}

impl<I> Enumerate<I>
where
    I: ConcurrentIter,
{
    pub(crate) fn new(iter: I) -> Self {
        Self { iter }
    }
}

impl<I> ConcurrentIter for Enumerate<I>
where
    I: ConcurrentIter,
{
    type Item = (usize, I::Item);

    type SequentialIter = core::iter::Enumerate<I::SequentialIter>;

    type ChunkPuller<'i>
        = EnumeratedChunkPuller<I::ChunkPuller<'i>>
    where
        Self: 'i;

    fn into_seq_iter(self) -> Self::SequentialIter {
        self.iter.into_seq_iter().enumerate()
    }

    fn skip_to_end(&self) {
        self.iter.skip_to_end();
    }

    fn next(&self) -> Option<Self::Item> {
        self.iter.next_with_idx()
    }

    fn next_with_idx(&self) -> Option<(usize, Self::Item)> {
        self.iter.next_with_idx().map(|(i, x)| (i, (i, x)))
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }

    fn is_completed_when_none_returned(&self) -> bool {
        true
    }

    fn chunk_puller(&self, chunk_size: usize) -> Self::ChunkPuller<'_> {
        Self::ChunkPuller::new(self.iter.chunk_puller(chunk_size))
    }
}