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

use crate::{
    ConcurrentIter, ExactSizeConcurrentIter,
    chain::chunk_puller_known_len_i::ChainedChunkPullerKnownLenI,
};

/// Chain of two concurrent iterators where the length of the first iterator is
/// known with certainly; i.e., `I` implements `ExactSizeConcurrentIter`.
pub struct ChainKnownLenI<I, J>
where
    I: ConcurrentIter,
    J: ConcurrentIter<Item = I::Item>,
{
    i: I,
    j: J,
    len_i: usize,
}

impl<I, J> ChainKnownLenI<I, J>
where
    I: ConcurrentIter,
    J: ConcurrentIter<Item = I::Item>,
{
    pub(crate) fn new(i: I, j: J, len_i: usize) -> Self {
        Self { i, j, len_i }
    }
}

impl<I, J> ConcurrentIter for ChainKnownLenI<I, J>
where
    I: ConcurrentIter,
    J: ConcurrentIter<Item = I::Item>,
{
    type Item = I::Item;

    type SequentialIter = core::iter::Chain<I::SequentialIter, J::SequentialIter>;

    type ChunkPuller<'i>
        = ChainedChunkPullerKnownLenI<'i, I, J>
    where
        Self: 'i;

    fn into_seq_iter(self) -> Self::SequentialIter {
        self.i.into_seq_iter().chain(self.j.into_seq_iter())
    }

    fn skip_to_end(&self) {
        self.i.skip_to_end();
        self.j.skip_to_end();
    }

    fn next(&self) -> Option<Self::Item> {
        self.i.next().or_else(|| self.j.next())
    }

    fn next_with_idx(&self) -> Option<(usize, Self::Item)> {
        self.i
            .next_with_idx()
            .or_else(|| self.j.next_with_idx().map(|(idx, x)| (self.len_i + idx, x)))
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let (l1, u1) = self.i.size_hint();
        let (l2, u2) = self.j.size_hint();
        match (u1, u2) {
            (Some(u1), Some(u2)) => (l1 + l2, Some(u1 + u2)),
            _ => (l1 + l2, None),
        }
    }

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

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

impl<I, J> ExactSizeConcurrentIter for ChainKnownLenI<I, J>
where
    I: ExactSizeConcurrentIter,
    J: ExactSizeConcurrentIter<Item = I::Item>,
{
    fn len(&self) -> usize {
        self.i.len() + self.j.len()
    }
}