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
91
92

use super::chunk_puller::CopiedChunkPuller;
use crate::{ExactSizeConcurrentIter, concurrent_iter::ConcurrentIter};
use core::{iter::Copied, marker::PhantomData};

/// A concurrent iterator which copies all elements.
///
/// This is useful when you have an iterator over `&T`, but you need an iterator over `T`.
///
/// Copied concurrent iterator can be created by calling [`copied`] on a concurrent iterator.
///
/// [`copied`]: crate::ConcurrentIter::copied
pub struct ConIterCopied<'a, I, T>
where
    T: Copy,
    I: ConcurrentIter<Item = &'a T>,
{
    con_iter: I,
    phantom: PhantomData<&'a T>,
}

unsafe impl<'a, I, T> Sync for ConIterCopied<'a, I, T>
where
    T: Copy + Send,
    I: ConcurrentIter<Item = &'a T>,
{
}

impl<'a, I, T> ConIterCopied<'a, I, T>
where
    T: Copy,
    I: ConcurrentIter<Item = &'a T>,
{
    pub(crate) fn new(con_iter: I) -> Self {
        Self {
            con_iter,
            phantom: PhantomData,
        }
    }
}

impl<'a, I, T> ConcurrentIter for ConIterCopied<'a, I, T>
where
    T: Copy + Send,
    I: ConcurrentIter<Item = &'a T>,
{
    type Item = T;

    type SequentialIter = Copied<I::SequentialIter>;

    type ChunkPuller<'i>
        = CopiedChunkPuller<'a, T, I::ChunkPuller<'i>>
    where
        Self: 'i;

    fn into_seq_iter(self) -> Self::SequentialIter {
        self.con_iter.into_seq_iter().copied()
    }

    fn skip_to_end(&self) {
        self.con_iter.skip_to_end()
    }

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

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

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

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

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

impl<'a, I, T> ExactSizeConcurrentIter for ConIterCopied<'a, I, T>
where
    T: Copy + Send,
    I: ExactSizeConcurrentIter<Item = &'a T>,
{
    fn len(&self) -> usize {
        self.con_iter.len()
    }
}