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

use crate::concurrent_iter::ConcurrentIter;

/// Trait to convert a source (collection or generator) into a concurrent iterator; i.e., [`ConcurrentIter`],
/// using its [`into_con_iter`] method.
///
/// It can be considered as the *concurrent counterpart* of the [`IntoIterator`] trait.
///
/// [`into_con_iter`]: crate::IntoConcurrentIter::into_con_iter
///
/// # Examples
///
/// ```
/// use orx_concurrent_iter::*;
///
/// let vec = vec![1, 2];
/// let con_iter = vec.into_con_iter();
/// assert_eq!(con_iter.next(), Some(1));
/// assert_eq!(con_iter.next(), Some(2));
/// assert_eq!(con_iter.next(), None);
///
/// let range = 11..13;
/// let con_iter = range.into_con_iter();
/// assert_eq!(con_iter.next(), Some(11));
/// assert_eq!(con_iter.next(), Some(12));
/// assert_eq!(con_iter.next(), None);
/// ```
pub trait IntoConcurrentIter {
    /// Type of the element that the concurrent iterator yields.
    type Item;

    /// Type of the concurrent iterator that this type can be converted into.
    type IntoIter: ConcurrentIter<Item = Self::Item>;

    /// Trait to convert a source (collection or generator) into a concurrent iterator; i.e., [`ConcurrentIter`],
    /// using its [`into_con_iter`] method.
    ///
    /// It can be considered as the *concurrent counterpart* of the [`IntoIterator`] trait.
    ///
    /// [`into_con_iter`]: crate::IntoConcurrentIter::into_con_iter
    ///
    /// # Examples
    ///
    /// ```
    /// use orx_concurrent_iter::*;
    ///
    /// let vec = vec![1, 2];
    /// let con_iter = vec.into_con_iter();
    /// assert_eq!(con_iter.next(), Some(1));
    /// assert_eq!(con_iter.next(), Some(2));
    /// assert_eq!(con_iter.next(), None);
    ///
    /// let range = 11..13;
    /// let con_iter = range.into_con_iter();
    /// assert_eq!(con_iter.next(), Some(11));
    /// assert_eq!(con_iter.next(), Some(12));
    /// assert_eq!(con_iter.next(), None);
    /// ```
    fn into_con_iter(self) -> Self::IntoIter;
}

impl<I: ConcurrentIter> IntoConcurrentIter for I {
    type Item = I::Item;

    type IntoIter = I;

    fn into_con_iter(self) -> Self::IntoIter {
        self
    }
}