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

use core::{iter::FusedIterator, marker::PhantomData};

use crate::{DoubleEndedLender, ExactSizeLender, FusedLender, Lend, Lender};

/// [`Iterator`] adapter for any [`Lender`] where multiple
/// [`Lend`]s can exist at a time, allowing on-the-fly conversion
/// into an iterator where [`Lending`](crate::Lending) is no
/// longer needed or inferred.
///
/// Implementing [`Iterator`] directly on any [`Lender`] causes
/// name conflicts, but might be possible in the future with
/// specialization.
///
/// This `struct` is created by the [`iter()`](crate::Lender::iter)
/// method on [`Lender`].
#[derive(Clone, Debug)]
#[must_use = "iterators are lazy and do nothing unless consumed"]
pub struct Iter<'this, L: 'this> {
    pub(crate) lender: L,
    pub(crate) _marker: PhantomData<&'this ()>,
}

impl<'this, L: 'this> Iter<'this, L> {
    #[inline(always)]
    pub(crate) fn new(lender: L) -> Iter<'this, L> {
        Iter {
            lender,
            _marker: PhantomData,
        }
    }

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

impl<'this, L: 'this> Iterator for Iter<'this, L>
where
    L: Lender,
    for<'all> Lend<'all, L>: 'this,
{
    type Item = Lend<'this, L>;
    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        // SAFETY: for<'all> Lend<'all, L>: 'this
        unsafe {
            core::mem::transmute::<Option<Lend<'_, L>>, Option<Lend<'this, L>>>(self.lender.next())
        }
    }

    #[inline(always)]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.lender.size_hint()
    }
}

impl<'this, L: 'this> DoubleEndedIterator for Iter<'this, L>
where
    L: DoubleEndedLender,
    for<'all> Lend<'all, L>: 'this,
{
    #[inline]
    fn next_back(&mut self) -> Option<Self::Item> {
        // SAFETY: for<'all> Lend<'all, L>: 'this
        unsafe {
            core::mem::transmute::<Option<Lend<'_, L>>, Option<Lend<'this, L>>>(
                self.lender.next_back(),
            )
        }
    }
}

impl<'this, L: 'this> ExactSizeIterator for Iter<'this, L>
where
    L: ExactSizeLender,
    for<'all> Lend<'all, L>: 'this,
{
    #[inline(always)]
    fn len(&self) -> usize {
        self.lender.len()
    }
}

impl<'this, L: 'this> FusedIterator for Iter<'this, L>
where
    L: FusedLender,
    for<'all> Lend<'all, L>: 'this,
{
}