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
80
81
82
83
84
85
86
87
88
89
90

use crate::ChunkPuller;

/// Chunk puller of an enumerated concurrent iterator; i.e., [`Enumerate`]
///
/// [`Enumerate`]: crate::enumerate::Enumerate
pub struct EnumeratedChunkPuller<P>
where
    P: ChunkPuller,
{
    puller: P,
}

impl<P> EnumeratedChunkPuller<P>
where
    P: ChunkPuller,
{
    pub(crate) fn new(puller: P) -> Self {
        Self { puller }
    }
}

impl<P> ChunkPuller for EnumeratedChunkPuller<P>
where
    P: ChunkPuller,
{
    type ChunkItem = (usize, P::ChunkItem);

    type Chunk<'c>
        = EnumeratedChunk<P::Chunk<'c>>
    where
        Self: 'c;

    fn chunk_size(&self) -> usize {
        self.puller.chunk_size()
    }

    fn pull(&mut self) -> Option<Self::Chunk<'_>> {
        self.puller
            .pull_with_idx()
            .map(|(begin_idx, x)| EnumeratedChunk {
                begin_idx,
                chunk: x.enumerate(),
            })
    }

    fn pull_with_idx(&mut self) -> Option<(usize, Self::Chunk<'_>)> {
        self.puller.pull_with_idx().map(|(begin_idx, x)| {
            (
                begin_idx,
                EnumeratedChunk {
                    begin_idx,
                    chunk: x.enumerate(),
                },
            )
        })
    }
}

pub struct EnumeratedChunk<I>
where
    I: ExactSizeIterator,
{
    chunk: core::iter::Enumerate<I>,
    begin_idx: usize,
}

impl<I> Iterator for EnumeratedChunk<I>
where
    I: ExactSizeIterator,
{
    type Item = (usize, I::Item);

    fn next(&mut self) -> Option<Self::Item> {
        self.chunk.next().map(|(i, x)| (self.begin_idx + i, x))
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let len = self.chunk.len();
        (len, Some(len))
    }
}

impl<I> ExactSizeIterator for EnumeratedChunk<I>
where
    I: ExactSizeIterator,
{
    fn len(&self) -> usize {
        self.chunk.len()
    }
}