lender 0.6.2

A lending-iterator trait based on higher-rank trait bounds, with full std::iter::Iterator functionality
Documentation
use core::num::NonZeroUsize;
use core::ops::ControlFlow;

use fallible_iterator::{DoubleEndedFallibleIterator, FallibleIterator};

use crate::try_trait_v2::Try;
use crate::{DoubleEndedFallibleLender, FallibleLend, FallibleLender, FallibleLending};

/// Creates a fallible lender that stores each element from a
/// fallible iterator and lends a reference to it.
///
/// This function can be conveniently accessed using the
/// [`into_fallible_ref_lender`](crate::traits::FallibleIteratorRefExt::into_fallible_ref_lender)
/// extension method.
///
/// Unlike [`from_fallible_iter`](crate::from_fallible_iter),
/// which passes items through transparently, this source
/// stores each element internally and lends a reference to it,
/// turning a `FallibleIterator<Item = T>` into a
/// `FallibleLender` with `FallibleLend<'lend> = &'lend T`.
///
/// # Examples
/// ```rust
/// # use lender::prelude::*;
/// # use fallible_iterator::IteratorExt;
/// let mut lender = lender::from_fallible_iter_ref(
///     [1, 2, 3].into_iter().into_fallible(),
/// );
/// let item: &i32 = lender.next().unwrap().unwrap();
/// assert_eq!(*item, 1);
/// ```
#[inline]
pub fn from_iter_ref<I: FallibleIterator>(iter: I) -> FromIterRef<I> {
    FromIterRef {
        iter,
        current: None,
    }
}

/// A fallible lender that stores each element from a fallible
/// iterator and lends a reference to it.
///
/// This `struct` is created by the
/// [`from_fallible_iter_ref()`](crate::from_fallible_iter_ref)
/// function.
#[derive(Clone, Debug)]
#[must_use = "lenders are lazy and do nothing unless consumed"]
pub struct FromIterRef<I: FallibleIterator> {
    iter: I,
    current: Option<I::Item>,
}

impl<'lend, I: FallibleIterator> FallibleLending<'lend> for FromIterRef<I> {
    type Lend = &'lend I::Item;
}

impl<I: FallibleIterator> FallibleLender for FromIterRef<I> {
    type Error = I::Error;
    crate::check_covariance_fallible!();

    #[inline]
    fn next(&mut self) -> Result<Option<FallibleLend<'_, Self>>, Self::Error> {
        self.current = self.iter.next()?;
        Ok(self.current.as_ref())
    }

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

    #[inline]
    fn nth(&mut self, n: usize) -> Result<Option<FallibleLend<'_, Self>>, Self::Error> {
        self.current = self.iter.nth(n)?;
        Ok(self.current.as_ref())
    }

    #[inline(always)]
    fn count(self) -> Result<usize, Self::Error>
    where
        Self: Sized,
    {
        self.iter.count()
    }

    #[inline]
    fn last<'call>(&'call mut self) -> Result<Option<FallibleLend<'call, Self>>, Self::Error>
    where
        Self: Sized,
    {
        self.current = None;
        while let Some(item) = self.iter.next()? {
            self.current = Some(item);
        }
        Ok(self.current.as_ref())
    }

    #[inline]
    fn advance_by(&mut self, n: usize) -> Result<Result<(), NonZeroUsize>, Self::Error> {
        for i in 0..n {
            if self.iter.next()?.is_none() {
                // SAFETY: `i` is always less than `n`.
                return Ok(Err(unsafe { NonZeroUsize::new_unchecked(n - i) }));
            }
        }
        Ok(Ok(()))
    }

    #[inline]
    fn try_fold<B, F, R>(&mut self, mut init: B, mut f: F) -> Result<R, Self::Error>
    where
        F: FnMut(B, FallibleLend<'_, Self>) -> Result<R, Self::Error>,
        R: Try<Output = B>,
    {
        while let Some(item) = self.iter.next()? {
            match f(init, &item)?.branch() {
                ControlFlow::Break(residual) => return Ok(R::from_residual(residual)),
                ControlFlow::Continue(output) => init = output,
            }
        }
        Ok(R::from_output(init))
    }

    #[inline]
    fn fold<B, F>(self, init: B, mut f: F) -> Result<B, Self::Error>
    where
        Self: Sized,
        F: FnMut(B, FallibleLend<'_, Self>) -> Result<B, Self::Error>,
    {
        self.iter.fold(init, |acc, item| f(acc, &item))
    }
}

impl<I: DoubleEndedFallibleIterator> DoubleEndedFallibleLender for FromIterRef<I> {
    #[inline]
    fn next_back(&mut self) -> Result<Option<FallibleLend<'_, Self>>, Self::Error> {
        self.current = self.iter.next_back()?;
        Ok(self.current.as_ref())
    }

    #[inline]
    fn advance_back_by(&mut self, n: usize) -> Result<Result<(), NonZeroUsize>, Self::Error> {
        for i in 0..n {
            if self.iter.next_back()?.is_none() {
                // SAFETY: `i` is always less than `n`.
                return Ok(Err(unsafe { NonZeroUsize::new_unchecked(n - i) }));
            }
        }
        Ok(Ok(()))
    }

    #[inline]
    fn try_rfold<B, F, R>(&mut self, mut init: B, mut f: F) -> Result<R, Self::Error>
    where
        F: FnMut(B, FallibleLend<'_, Self>) -> Result<R, Self::Error>,
        R: Try<Output = B>,
    {
        while let Some(item) = self.iter.next_back()? {
            match f(init, &item)?.branch() {
                ControlFlow::Break(residual) => return Ok(R::from_residual(residual)),
                ControlFlow::Continue(output) => init = output,
            }
        }
        Ok(R::from_output(init))
    }

    #[inline]
    fn rfold<B, F>(self, init: B, mut f: F) -> Result<B, Self::Error>
    where
        Self: Sized,
        F: FnMut(B, FallibleLend<'_, Self>) -> Result<B, Self::Error>,
    {
        self.iter.rfold(init, |acc, item| f(acc, &item))
    }
}

// Note: FusedFallibleLender and ExactSizeFallibleLender are not
// implemented for FromIterRef because the fallible_iterator crate
// does not expose FusedFallibleIterator or
// ExactSizeFallibleIterator marker traits.

impl<I: FallibleIterator> From<I> for FromIterRef<I> {
    #[inline(always)]
    fn from(iter: I) -> Self {
        from_iter_ref(iter)
    }
}