lender 0.6.2

A lending-iterator trait based on higher-rank trait bounds, with full std::iter::Iterator functionality
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use core::ops::ControlFlow;

use crate::{FusedLender, Lend, Lender, Lending, try_trait_v2::Try};

/// A sub-lender over elements of a chunk in a [`Chunky`](crate::Chunky) lender.
///
/// This `struct` is created by the [`Chunky`](crate::Chunky) lender during
/// iteration.
#[derive(Debug)]
#[must_use = "lenders are lazy and do nothing unless consumed"]
pub struct Chunk<'s, T> {
    pub(crate) lender: &'s mut T,
    pub(crate) len: usize,
}

impl<'s, T> Chunk<'s, T> {
    /// Returns the inner lender.
    #[inline(always)]
    pub fn into_inner(self) -> &'s mut T {
        self.lender
    }

    /// Returns the inner lender and the remaining chunk length.
    #[inline(always)]
    pub fn into_parts(self) -> (&'s mut T, usize) {
        (self.lender, self.len)
    }
}

impl<'s, T: Lender> Chunk<'s, T> {
    #[inline(always)]
    pub(crate) fn new(lender: &'s mut T, len: usize) -> Self {
        let _ = T::__check_covariance(crate::CovariantProof::new());
        Self { lender, len }
    }
}

impl<'lend, T> Lending<'lend> for Chunk<'_, T>
where
    T: Lender,
{
    type Lend = Lend<'lend, T>;
}

impl<T> Lender for Chunk<'_, T>
where
    T: Lender,
{
    // SAFETY: the lend is that of T
    crate::unsafe_assume_covariance!();
    #[inline]
    fn next(&mut self) -> Option<Lend<'_, Self>> {
        if self.len == 0 {
            None
        } else {
            self.len -= 1;
            self.lender.next()
        }
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        let (lower, upper) = self.lender.size_hint();
        (lower.min(self.len), upper.map(|x| x.min(self.len)))
    }

    #[inline]
    fn count(self) -> usize
    where
        Self: Sized,
    {
        self.fold(0, |count, _| count + 1)
    }

    /// Returns the `n`th element of this chunk.
    ///
    /// If `n` is greater than or equal to the remaining length of the chunk,
    /// the remaining chunk capacity is exhausted from the underlying lender,
    /// and `None` is returned.
    #[inline]
    fn nth(&mut self, n: usize) -> Option<Lend<'_, Self>> {
        if n >= self.len {
            let _ = self.lender.advance_by(self.len);
            self.len = 0;
            None
        } else {
            self.len -= n + 1;
            self.lender.nth(n)
        }
    }

    #[inline]
    fn try_fold<B, F, R>(&mut self, init: B, mut f: F) -> R
    where
        Self: Sized,
        F: FnMut(B, Lend<'_, Self>) -> R,
        R: Try<Output = B>,
    {
        let mut acc = init;
        while self.len > 0 {
            self.len -= 1;
            match self.lender.next() {
                Some(x) => {
                    acc = match f(acc, x).branch() {
                        ControlFlow::Continue(v) => v,
                        ControlFlow::Break(r) => return R::from_residual(r),
                    };
                }
                None => break,
            }
        }
        R::from_output(acc)
    }

    #[inline]
    fn fold<B, F>(mut self, init: B, mut f: F) -> B
    where
        Self: Sized,
        F: FnMut(B, Lend<'_, Self>) -> B,
    {
        let mut acc = init;
        while self.len > 0 {
            self.len -= 1;
            match self.lender.next() {
                Some(x) => acc = f(acc, x),
                None => break,
            }
        }
        acc
    }
}

impl<L> FusedLender for Chunk<'_, L> where L: FusedLender {}