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, ops::ControlFlow};

use crate::{
    DoubleEndedLender, Fuse, FusedLender, Lend, Lender, Lending,
    try_trait_v2::{FromResidual, Try},
};

/// A lender that chains two lenders together, one after the other.
///
/// This `struct` is created by the [`chain()`](crate::Lender::chain) method
/// on [`Lender`].
#[derive(Clone, Debug)]
#[must_use = "lenders are lazy and do nothing unless consumed"]
pub struct Chain<A, B> {
    pub(crate) a: Fuse<A>,
    pub(crate) b: Fuse<B>,
}

impl<A, B> Chain<A, B> {
    /// Returns the two inner lenders.
    #[inline(always)]
    pub fn into_inner(self) -> (A, B) {
        (self.a.into_inner(), self.b.into_inner())
    }
}

impl<A: Lender, B: Lender> Chain<A, B> {
    #[inline]
    pub(crate) fn new(a: A, b: B) -> Self {
        let _ = A::__check_covariance(crate::CovariantProof::new());
        let _ = B::__check_covariance(crate::CovariantProof::new());
        Self {
            a: Fuse::new(a),
            b: Fuse::new(b),
        }
    }
}

impl<'lend, A, B> Lending<'lend> for Chain<A, B>
where
    A: Lender,
    B: Lender + for<'all> Lending<'all, Lend = Lend<'all, A>>,
{
    type Lend = Lend<'lend, A>;
}

impl<A, B> Lender for Chain<A, B>
where
    A: Lender,
    B: Lender + for<'all> Lending<'all, Lend = Lend<'all, A>>,
{
    // SAFETY: the lend is that of A (and B has the same lend type)
    crate::unsafe_assume_covariance!();
    #[inline]
    fn next(&mut self) -> Option<Lend<'_, Self>> {
        self.a.next().or_else(|| self.b.next())
    }

    #[inline]
    fn count(self) -> usize {
        self.a.count() + self.b.count()
    }

    #[inline]
    fn try_fold<Acc, F, R>(&mut self, mut acc: Acc, mut f: F) -> R
    where
        Self: Sized,
        F: FnMut(Acc, Lend<'_, Self>) -> R,
        R: Try<Output = Acc>,
    {
        acc = match self.a.try_fold(acc, &mut f).branch() {
            ControlFlow::Continue(x) => x,
            ControlFlow::Break(x) => return FromResidual::from_residual(x),
        };
        acc = match self.b.try_fold(acc, f).branch() {
            ControlFlow::Continue(x) => x,
            ControlFlow::Break(x) => return FromResidual::from_residual(x),
        };
        Try::from_output(acc)
    }

    #[inline]
    fn fold<Acc, F>(self, mut acc: Acc, mut f: F) -> Acc
    where
        F: FnMut(Acc, Lend<'_, Self>) -> Acc,
    {
        acc = self.a.fold(acc, &mut f);
        acc = self.b.fold(acc, f);
        acc
    }

    #[inline]
    fn advance_by(&mut self, n: usize) -> Result<(), NonZeroUsize> {
        match self.a.advance_by(n) {
            Ok(()) => Ok(()),
            Err(k) => self.b.advance_by(k.get()),
        }
    }

    #[inline]
    fn nth(&mut self, mut n: usize) -> Option<Lend<'_, Self>> {
        n = match self.a.advance_by(n) {
            Ok(()) => match self.a.next() {
                None => 0,
                x => return x,
            },
            Err(k) => k.get(),
        };
        self.b.nth(n)
    }

    #[inline]
    fn find<P>(&mut self, mut predicate: P) -> Option<Lend<'_, Self>>
    where
        P: FnMut(&Lend<'_, Self>) -> bool,
    {
        self.a
            .find(&mut predicate)
            .or_else(|| self.b.find(predicate))
    }

    #[inline]
    fn last(&mut self) -> Option<Lend<'_, Self>>
    where
        Self: Sized,
    {
        let a_last = self.a.last();
        let b_last = self.b.last();
        b_last.or(a_last)
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        let (a_lower, a_upper) = self.a.size_hint();
        let (b_lower, b_upper) = self.b.size_hint();
        let lower = a_lower.saturating_add(b_lower);

        let upper = match (a_upper, b_upper) {
            (Some(x), Some(y)) => x.checked_add(y),
            _ => None,
        };
        (lower, upper)
    }
}

impl<A, B> DoubleEndedLender for Chain<A, B>
where
    A: DoubleEndedLender,
    B: DoubleEndedLender + for<'all> Lending<'all, Lend = Lend<'all, A>>,
{
    #[inline]
    fn next_back(&mut self) -> Option<Lend<'_, Self>> {
        self.b.next_back().or_else(|| self.a.next_back())
    }

    #[inline]
    fn advance_back_by(&mut self, n: usize) -> Result<(), NonZeroUsize> {
        match self.b.advance_back_by(n) {
            Ok(()) => Ok(()),
            Err(k) => self.a.advance_back_by(k.get()),
        }
    }

    #[inline]
    fn nth_back(&mut self, mut n: usize) -> Option<Lend<'_, Self>> {
        n = match self.b.advance_back_by(n) {
            Ok(()) => match self.b.next_back() {
                None => 0,
                x => return x,
            },
            Err(k) => k.get(),
        };
        self.a.nth_back(n)
    }

    #[inline]
    fn rfind<P>(&mut self, mut predicate: P) -> Option<Lend<'_, Self>>
    where
        Self: Sized,
        P: FnMut(&Lend<'_, Self>) -> bool,
    {
        self.b
            .rfind(&mut predicate)
            .or_else(|| self.a.rfind(predicate))
    }

    #[inline]
    fn try_rfold<Acc, F, R>(&mut self, init: Acc, mut f: F) -> R
    where
        Self: Sized,
        F: FnMut(Acc, Lend<'_, Self>) -> R,
        R: Try<Output = Acc>,
    {
        let mut acc = match self.b.try_rfold(init, &mut f).branch() {
            ControlFlow::Continue(x) => x,
            ControlFlow::Break(x) => return FromResidual::from_residual(x),
        };
        acc = match self.a.try_rfold(acc, f).branch() {
            ControlFlow::Continue(x) => x,
            ControlFlow::Break(x) => return FromResidual::from_residual(x),
        };
        Try::from_output(acc)
    }

    #[inline]
    fn rfold<Acc, F>(self, init: Acc, mut f: F) -> Acc
    where
        Self: Sized,
        F: FnMut(Acc, Lend<'_, Self>) -> Acc,
    {
        let mut acc = self.b.rfold(init, &mut f);
        acc = self.a.rfold(acc, f);
        acc
    }
}

impl<A, B> FusedLender for Chain<A, B>
where
    A: FusedLender,
    B: FusedLender + for<'all> Lending<'all, Lend = Lend<'all, A>>,
{
}

impl<A: Default + Lender, B: Default + Lender> Default for Chain<A, B> {
    #[inline(always)]
    fn default() -> Self {
        Chain::new(Default::default(), Default::default())
    }
}