with_prev

Co-authored-by: Warren Wise <warren.a.wise@gmail.com>

Author: warren2k

src/lib.rs

@@ -147,6 +147,7 @@ pub mod structs {
     #[cfg(feature = "use_std")]
     pub use crate::unique_impl::{Unique, UniqueBy};
     pub use crate::with_position::WithPosition;
+    pub use crate::with_prev::WithPrev;
     pub use crate::zip_eq_impl::ZipEq;
     pub use crate::zip_longest::ZipLongest;
     pub use crate::ziptuple::Zip;
@@ -243,6 +244,7 @@ mod tuple_impl;
 mod unique_impl;
 mod unziptuple;
 mod with_position;
+mod with_prev;
 mod zip_eq_impl;
 mod zip_longest;
 mod ziptuple;
@@ -2247,6 +2249,26 @@ pub trait Itertools: Iterator {
         with_position::with_position(self)
     }
 
+    /// Return an iterator adaptor that combines each element except the first with
+    /// a clone of the previous.
+    ///
+    /// ```
+    /// use itertools::Itertools;
+    ///
+    /// let it = (0..4).with_prev();
+    /// itertools::assert_equal(it,
+    ///                         vec![(None, 0),
+    ///                              (Some(0), 1),
+    ///                              (Some(1), 2),
+    ///                              (Some(2), 3)]);
+    /// ```
+    fn with_prev(self) -> WithPrev<Self>
+    where
+        Self: Sized,
+    {
+        with_prev::with_prev(self)
+    }
+
     /// Return an iterator adaptor that yields the indices of all elements
     /// satisfying a predicate, counted from the start of the iterator.
     ///

src/with_prev.rs

@@ -0,0 +1,51 @@
+use std::fmt;
+
+/// An iterator adaptor that combines each element except the first with a clone of the previous.
+///
+/// See [`.with_prev()`](crate::Itertools::with_prev) for more information.
+#[must_use = "iterator adaptors are lazy and do nothing unless consumed"]
+pub struct WithPrev<I>
+where
+    I: Iterator,
+{
+    iter: I,
+    prev: Option<I::Item>,
+}
+
+impl<I> fmt::Debug for WithPrev<I>
+where
+    I: Iterator + fmt::Debug,
+    I::Item: fmt::Debug,
+{
+    debug_fmt_fields!(WithPrev, prev, iter);
+}
+
+impl<I> Clone for WithPrev<I>
+where
+    I: Clone + Iterator,
+    I::Item: Clone,
+{
+    clone_fields!(iter, prev);
+}
+
+/// Create a new `WithPrev` iterator.
+pub fn with_prev<I>(iter: I) -> WithPrev<I>
+where
+    I: Iterator,
+{
+    WithPrev { iter, prev: None }
+}
+
+impl<I> Iterator for WithPrev<I>
+where
+    I: Iterator,
+    I::Item: Clone,
+{
+    type Item = (Option<I::Item>, I::Item);
+
+    fn next(&mut self) -> Option<Self::Item> {
+        let next = self.iter.next()?;
+        let prev = self.prev.replace(next.clone());
+        Some((prev, next))
+    }
+}