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

use alloc::vec::Vec;

/// A collection of slices.
pub trait Slices<'a, T>: Clone
where
    T: 'a,
{
    /// Creates an empty collection of slices.
    fn empty() -> Self;

    /// Number of slices.
    fn num_slices(&self) -> usize;

    /// Iterator over slices.
    fn slices(&self) -> impl Iterator<Item = &'a [T]>;

    /// Iterator over lengths of slices.
    fn lengths(&self) -> impl Iterator<Item = usize>;

    /// Returns a reference to the `f`-th slice.
    /// Returns None if out of bounds.
    fn slice_at(&self, f: usize) -> Option<&'a [T]>;

    /// Returns the `f`-th slice without bounds checks.
    ///
    /// # Safety
    ///
    /// The caller must ensure that `f < self.num_slices()`.
    unsafe fn slice_at_unchecked(&self, f: usize) -> &'a [T];
}

impl<'a, T: 'a> Slices<'a, T> for &'a [Vec<T>] {
    fn empty() -> Self {
        Default::default()
    }

    fn num_slices(&self) -> usize {
        self.len()
    }

    fn slices(&self) -> impl Iterator<Item = &'a [T]> {
        self.iter().map(|x| x.as_slice())
    }

    fn lengths(&self) -> impl Iterator<Item = usize> {
        self.iter().map(|x| x.len())
    }

    fn slice_at(&self, f: usize) -> Option<&'a [T]> {
        self.get(f).map(|x| x.as_slice())
    }

    unsafe fn slice_at_unchecked(&self, f: usize) -> &'a [T] {
        self[f].as_slice()
    }
}