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

use core::{fmt, marker};

use crate::{
    DoubleEndedFallibleLender, ExactSizeFallibleLender, FallibleLend, FallibleLender,
    FallibleLending, FusedFallibleLender,
};

/// Creates a fallible lender that yields nothing.
///
/// The [`FallibleLender`] version of [`core::iter::empty()`].
///
/// # Examples
/// ```rust
/// # use lender::prelude::*;
/// let mut e = lender::fallible_empty::<
///     fallible_lend!(&'lend i32), String,
/// >();
/// let x: Result<Option<&i32>, String> = e.next();
/// assert_eq!(x, Ok(None));
/// ```
#[inline(always)]
pub const fn empty<L: ?Sized + for<'all> FallibleLending<'all>, E>() -> Empty<L, E> {
    Empty(marker::PhantomData)
}

/// A fallible lender that yields nothing.
///
/// This `struct` is created by the
/// [`fallible_empty()`](crate::fallible_empty) function.
///
/// The [`FallibleLender`] version of [`core::iter::Empty`].
#[must_use = "lenders are lazy and do nothing unless consumed"]
#[derive(Clone, Copy, Default)]
#[allow(clippy::type_complexity)]
pub struct Empty<L: ?Sized, E>(marker::PhantomData<(fn() -> E, fn() -> L)>);

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

impl<'lend, L, E> FallibleLending<'lend> for Empty<L, E>
where
    L: ?Sized + for<'all> FallibleLending<'all>,
{
    type Lend = FallibleLend<'lend, L>;
}

impl<L, E> FallibleLender for Empty<L, E>
where
    L: ?Sized + for<'all> FallibleLending<'all>,
{
    type Error = E;
    // SAFETY: the lend is the type parameter L
    crate::unsafe_assume_covariance_fallible!();

    #[inline(always)]
    fn next(&mut self) -> Result<Option<FallibleLend<'_, Self>>, Self::Error> {
        Ok(None)
    }

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

impl<L, E> DoubleEndedFallibleLender for Empty<L, E>
where
    L: ?Sized + for<'all> FallibleLending<'all>,
{
    #[inline(always)]
    fn next_back(&mut self) -> Result<Option<FallibleLend<'_, Self>>, Self::Error> {
        Ok(None)
    }
}

impl<L, E> ExactSizeFallibleLender for Empty<L, E> where L: ?Sized + for<'all> FallibleLending<'all> {}

impl<L, E> FusedFallibleLender for Empty<L, E> where L: ?Sized + for<'all> FallibleLending<'all> {}