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

use core::fmt;

use crate::{
    Covar, DoubleEndedLender, FusedLender, Lend, Lender, Lending, higher_order::FnMutHKAOpt,
};

/// A lender that uses a closure to optionally produce elements.
///
/// This `struct` is created by the [`filter_map()`](crate::Lender::filter_map)
/// method on [`Lender`].
#[derive(Clone)]
#[must_use = "lenders are lazy and do nothing unless consumed"]
pub struct FilterMap<L, F> {
    pub(crate) lender: L,
    pub(crate) f: Covar<F>,
}

impl<L, F> FilterMap<L, F> {
    /// Returns the inner lender.
    #[inline(always)]
    pub fn into_inner(self) -> L {
        self.lender
    }

    /// Returns the inner lender and the mapping function.
    #[inline(always)]
    pub fn into_parts(self) -> (L, Covar<F>) {
        (self.lender, self.f)
    }
}

impl<L: Lender, F> FilterMap<L, F> {
    #[inline(always)]
    pub(crate) fn new(lender: L, f: Covar<F>) -> FilterMap<L, F> {
        let _ = L::__check_covariance(crate::CovariantProof::new());
        FilterMap { lender, f }
    }
}

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

impl<'lend, L, F> Lending<'lend> for FilterMap<L, F>
where
    F: for<'all> FnMutHKAOpt<'all, Lend<'all, L>>,
    L: Lender,
{
    type Lend = <F as FnMutHKAOpt<'lend, Lend<'lend, L>>>::B;
}

impl<L, F> Lender for FilterMap<L, F>
where
    for<'all> F: FnMutHKAOpt<'all, Lend<'all, L>>,
    L: Lender,
{
    // SAFETY: the lend is the return type of F, whose covariance
    // has been checked at Covar construction time.
    crate::unsafe_assume_covariance!();
    #[inline]
    fn next(&mut self) -> Option<Lend<'_, Self>> {
        while let Some(x) = self.lender.next() {
            if let Some(y) = (self.f.as_inner_mut())(x) {
                // SAFETY: polonius return
                return Some(unsafe { core::mem::transmute::<Lend<'_, Self>, Lend<'_, Self>>(y) });
            }
        }
        None
    }

    #[inline]
    fn count(mut self) -> usize {
        let mut count = 0;
        while let Some(x) = self.lender.next() {
            if (self.f.as_inner_mut())(x).is_some() {
                count += 1;
            }
        }
        count
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        let (_, upper) = self.lender.size_hint();
        (0, upper)
    }
}

impl<L, F> DoubleEndedLender for FilterMap<L, F>
where
    for<'all> F: FnMutHKAOpt<'all, Lend<'all, L>>,
    L: DoubleEndedLender,
{
    #[inline]
    fn next_back(&mut self) -> Option<Lend<'_, Self>> {
        while let Some(x) = self.lender.next_back() {
            if let Some(y) = (self.f.as_inner_mut())(x) {
                // SAFETY: polonius return
                return Some(unsafe { core::mem::transmute::<Lend<'_, Self>, Lend<'_, Self>>(y) });
            }
        }
        None
    }
}

impl<L, F> FusedLender for FilterMap<L, F>
where
    for<'all> F: FnMutHKAOpt<'all, Lend<'all, L>>,
    L: FusedLender,
{
}