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

use core::{fmt, marker::PhantomData};

use crate::{FusedLender, prelude::*};

/// Creates a new lender that repeats elements endlessly by
/// applying the provided closure, the repeater,
/// `F: FnMut() -> A`.
///
/// The [`repeat_with()`] function calls the repeater over and
/// over again.
///
/// The [`Lender`] version of
/// [`iter::repeat_with()`](core::iter::repeat_with).
///
/// # Examples
/// ```rust
/// # use lender::prelude::*;
/// let mut lender = lender::repeat_with::<
///     lend!(&'lend i32), _,
/// >(|| &0);
/// assert_eq!(lender.next(), Some(&0));
/// ```
#[inline]
pub fn repeat_with<'a, L, F>(f: F) -> RepeatWith<'a, L, F>
where
    L: ?Sized + CovariantLending + 'a,
    F: FnMut() -> Lend<'a, L>,
{
    let _ = L::__check_covariance(crate::CovariantProof::new());
    RepeatWith {
        f,
        _marker: PhantomData,
    }
}

/// A lender that repeats an element endlessly by applying a
/// closure.
///
/// This `struct` is created by the [`repeat_with()`] function.
#[must_use = "lenders are lazy and do nothing unless consumed"]
pub struct RepeatWith<'a, L: ?Sized, F> {
    f: F,
    _marker: core::marker::PhantomData<&'a L>,
}

impl<L: ?Sized, F: Clone> Clone for RepeatWith<'_, L, F> {
    #[inline]
    fn clone(&self) -> Self {
        Self {
            f: self.f.clone(),
            _marker: PhantomData,
        }
    }
}

impl<L: ?Sized, F> fmt::Debug for RepeatWith<'_, L, F> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("RepeatWith").finish_non_exhaustive()
    }
}

impl<'lend, 'a, L, F> Lending<'lend> for RepeatWith<'a, L, F>
where
    L: ?Sized + CovariantLending + 'a,
    F: FnMut() -> Lend<'a, L>,
{
    type Lend = Lend<'lend, L>;
}

impl<'a, L, F> Lender for RepeatWith<'a, L, F>
where
    L: ?Sized + CovariantLending + 'a,
    F: FnMut() -> Lend<'a, L>,
{
    // SAFETY: the lend is the return type of F
    crate::unsafe_assume_covariance!();
    #[inline]
    fn next(&mut self) -> Option<Lend<'_, Self>> {
        // SAFETY: 'a: 'lend
        Some(unsafe { core::mem::transmute::<Lend<'a, L>, Lend<'_, L>>((self.f)()) })
    }

    #[inline(always)]
    fn size_hint(&self) -> (usize, Option<usize>) {
        (usize::MAX, None)
    }

    /// Advances the lender by `n` elements.
    ///
    /// Unlike [`Repeat::advance_by`](crate::Repeat), which is
    /// a no-op, this method calls the closure `n` times
    /// (discarding the results) because the closure may have
    /// side effects.
    #[inline]
    fn advance_by(&mut self, n: usize) -> Result<(), core::num::NonZeroUsize> {
        for _ in 0..n {
            (self.f)();
        }
        Ok(())
    }
}

impl<'a, L, F> DoubleEndedLender for RepeatWith<'a, L, F>
where
    L: ?Sized + CovariantLending + 'a,
    F: FnMut() -> Lend<'a, L>,
{
    #[inline(always)]
    fn next_back(&mut self) -> Option<Lend<'_, Self>> {
        self.next()
    }

    #[inline]
    fn advance_back_by(&mut self, n: usize) -> Result<(), core::num::NonZeroUsize> {
        for _ in 0..n {
            (self.f)();
        }
        Ok(())
    }
}

impl<'a, L, F> FusedLender for RepeatWith<'a, L, F>
where
    L: ?Sized + CovariantLending + 'a,
    F: FnMut() -> Lend<'a, L>,
{
}