Merge multipeek peeknth

src/free.rs

@@ -20,9 +20,7 @@ pub use crate::adaptors::{interleave, put_back};
 pub use crate::kmerge_impl::kmerge;
 pub use crate::merge_join::{merge, merge_join_by};
 #[cfg(feature = "use_alloc")]
-pub use crate::multipeek_impl::multipeek;
-#[cfg(feature = "use_alloc")]
-pub use crate::peek_nth::peek_nth;
+pub use crate::multipeek_general::{multipeek, peek_nth};
 #[cfg(feature = "use_alloc")]
 pub use crate::put_back_n_impl::put_back_n;
 #[cfg(feature = "use_alloc")]

src/lib.rs

@@ -115,10 +115,8 @@ pub mod structs {
     pub use crate::kmerge_impl::{KMerge, KMergeBy};
     pub use crate::merge_join::{Merge, MergeBy, MergeJoinBy};
     #[cfg(feature = "use_alloc")]
-    pub use crate::multipeek_impl::MultiPeek;
+    pub use crate::multipeek_general::{MultiPeek, PeekNth};
     pub use crate::pad_tail::PadUsing;
-    #[cfg(feature = "use_alloc")]
-    pub use crate::peek_nth::PeekNth;
     pub use crate::peeking_take_while::PeekingTakeWhile;
     #[cfg(feature = "use_alloc")]
     pub use crate::permutations::Permutations;
@@ -205,10 +203,8 @@ mod lazy_buffer;
 mod merge_join;
 mod minmax;
 #[cfg(feature = "use_alloc")]
-mod multipeek_impl;
+mod multipeek_general;
 mod pad_tail;
-#[cfg(feature = "use_alloc")]
-mod peek_nth;
 mod peeking_take_while;
 #[cfg(feature = "use_alloc")]
 mod permutations;
@@ -4115,7 +4111,7 @@ pub trait Itertools: Iterator {
     where
         Self: Sized,
     {
-        multipeek_impl::multipeek(self)
+        multipeek_general::multipeek(self)
     }
 
     /// Collect the items in this iterator and return a `HashMap` which

src/peek_nth.rs → src/multipeek_general.rs

@@ -1,17 +1,34 @@
-use crate::size_hint;
-use crate::PeekingNext;
+use crate::{size_hint, PeekingNext};
 use alloc::collections::VecDeque;
 use std::iter::Fuse;
 
-/// See [`peek_nth()`] for more information.
-#[derive(Clone, Debug)]
 #[must_use = "iterator adaptors are lazy and do nothing unless consumed"]
-pub struct PeekNth<I>
-where
-    I: Iterator,
-{
+#[derive(Debug, Clone)]
+pub struct MultiPeekGeneral<I: Iterator, Idx> {
     iter: Fuse<I>,
     buf: VecDeque<I::Item>,
+    index: Idx,
+}
+
+/// See [`multipeek()`] for more information.
+pub type MultiPeek<I> = MultiPeekGeneral<I, usize>;
+
+/// See [`peek_nth()`] for more information.
+pub type PeekNth<I> = MultiPeekGeneral<I, ()>;
+
+/// An iterator adaptor that allows the user to peek at multiple `.next()`
+/// values without advancing the base iterator.
+///
+/// [`IntoIterator`] enabled version of [`Itertools::multipeek`](crate::Itertools::multipeek).
+pub fn multipeek<I>(iterable: I) -> MultiPeek<I::IntoIter>
+where
+    I: IntoIterator,
+{
+    MultiPeek {
+        iter: iterable.into_iter().fuse(),
+        buf: VecDeque::new(),
+        index: 0,
+    }
 }
 
 /// A drop-in replacement for [`std::iter::Peekable`] which adds a `peek_nth`
@@ -28,16 +45,60 @@ where
     PeekNth {
         iter: iterable.into_iter().fuse(),
         buf: VecDeque::new(),
+        index: (),
     }
 }
 
-impl<I> PeekNth<I>
-where
-    I: Iterator,
-{
-    /// Works exactly like the `peek` method in [`std::iter::Peekable`].
+pub trait PeekIndex {
+    fn reset_index(&mut self);
+    fn add(&mut self, n: usize);
+    fn index(&self) -> usize;
+}
+
+impl PeekIndex for () {
+    fn reset_index(&mut self) {}
+    fn add(&mut self, _n: usize) {}
+    fn index(&self) -> usize {
+        0
+    }
+}
+
+impl PeekIndex for usize {
+    fn reset_index(&mut self) {
+        *self = 0;
+    }
+    fn add(&mut self, n: usize) {
+        *self += n
+    }
+    fn index(&self) -> usize {
+        *self
+    }
+}
+
+impl<I: Iterator, Idx: PeekIndex> MultiPeekGeneral<I, Idx> {
+    /// Works similarly to `.next()`, but does not advance the iterator itself.
+    ///
+    /// - For `MultiPeekGeneral`, calling `.peek()` will increment the internal index,
+    ///   so the next call to `.peek()` will advance to the next element in the buffer.
+    ///   The actual underlying iterator is not consumed, allowing multiple peeks
+    ///   without advancing the iterator itself.
+    /// - For `peek_nth`, since there is no internal index used, calling `.peek()`
+    ///   multiple times will not advance the internal state or the iterator, providing
+    ///   a consistent view of the same element.
     pub fn peek(&mut self) -> Option<&I::Item> {
-        self.peek_nth(0)
+        let ret = if self.index.index() < self.buf.len() {
+            Some(&self.buf[self.index.index()])
+        } else {
+            match self.iter.next() {
+                Some(x) => {
+                    self.buf.push_back(x);
+                    Some(&self.buf[self.index.index()])
+                }
+                None => return None,
+            }
+        };
+        self.index.add(1);
+        ret
     }
 
     /// Works exactly like the `peek_mut` method in [`std::iter::Peekable`].
@@ -73,7 +134,13 @@ where
 
         self.buf.extend(self.iter.by_ref().take(unbuffered_items));
 
-        self.buf.get(n)
+        let ret = self.buf.get(n);
+
+        if ret.is_some() {
+            self.index.add(n + 1);
+        }
+
+        ret
     }
 
     /// Returns a mutable reference to the `nth` value without advancing the iterator.
@@ -110,6 +177,8 @@ where
     /// assert_eq!(iter.peek_nth_mut(1), None);
     /// ```
     pub fn peek_nth_mut(&mut self, n: usize) -> Option<&mut I::Item> {
+        self.index.add(n);
+
         let unbuffered_items = (n + 1).saturating_sub(self.buf.len());
 
         self.buf.extend(self.iter.by_ref().take(unbuffered_items));
@@ -137,15 +206,36 @@ where
     {
         self.next_if(|next| next == expected)
     }
+
+    /// Works exactly like `next_if`, but for the `nth` value without advancing the iterator.
+    pub fn nth_if(&mut self, n: usize, func: impl FnOnce(&I::Item) -> bool) -> Option<&I::Item> {
+        match self.peek_nth(n) {
+            Some(item) if func(item) => Some(item),
+            _ => None,
+        }
+    }
+
+    /// Works exactly like `next_if_eq`, but for the `nth` value without advancing the iterator.
+    pub fn nth_if_eq<T>(&mut self, n: usize, expected: &T) -> Option<&I::Item>
+    where
+        T: ?Sized,
+        I::Item: PartialEq<T>,
+    {
+        self.nth_if(n, |item| item == expected)
+    }
+}
+impl<I: Iterator> MultiPeek<I> {
+    /// Reset the peeking “cursor”
+    pub fn reset_peek(&mut self) {
+        self.index = 0
+    }
 }
 
-impl<I> Iterator for PeekNth<I>
-where
-    I: Iterator,
-{
+impl<I: Iterator, Idx: PeekIndex> Iterator for MultiPeekGeneral<I, Idx> {
     type Item = I::Item;
 
     fn next(&mut self) -> Option<Self::Item> {
+        self.index.reset_index();
         self.buf.pop_front().or_else(|| self.iter.next())
     }
 
@@ -162,17 +252,28 @@ where
     }
 }
 
-impl<I> ExactSizeIterator for PeekNth<I> where I: ExactSizeIterator {}
+impl<I: ExactSizeIterator, Idx: PeekIndex> ExactSizeIterator for MultiPeekGeneral<I, Idx> {}
 
-impl<I> PeekingNext for PeekNth<I>
+impl<I, Idx> PeekingNext for MultiPeekGeneral<I, Idx>
 where
     I: Iterator,
+    Idx: PeekIndex,
 {
     fn peeking_next<F>(&mut self, accept: F) -> Option<Self::Item>
     where
         F: FnOnce(&Self::Item) -> bool,
     {
-        self.peek().filter(|item| accept(item))?;
+        if self.buf.is_empty() {
+            if let Some(r) = self.peek() {
+                if !accept(r) {
+                    return None;
+                }
+            }
+        } else if let Some(r) = self.buf.front() {
+            if !accept(r) {
+                return None;
+            }
+        }
         self.next()
     }
 }

tests/test_std.rs

@@ -660,6 +660,20 @@ fn test_multipeek() {
     assert_eq!(mp.peek(), None);
 }
 
+#[test]
+fn test_multipeek_peeknth() {
+    let nums = vec![6, 7, 8, 9, 10];
+
+    let mut mp = multipeek(nums);
+    assert_eq!(mp.peek_nth(2), Some(&8));
+    assert_eq!(mp.peek(), Some(&9));
+    assert_eq!(mp.peek(), Some(&10));
+    mp.reset_peek();
+    assert_eq!(mp.peek_nth(1), Some(&7));
+    assert_eq!(mp.peek_nth(3), Some(&9));
+    assert_eq!(mp.peek_nth(10), None);
+}
+
 #[test]
 fn test_multipeek_reset() {
     let data = [1, 2, 3, 4];