Add Itertools::enumerate_ok

Squashed commit of the following: commit 146fb0e Author: NoneTheWisr <[email protected]> Date: Sun Jan 16 12:44:41 2022 +0400 mob next [ci-skip] [ci skip] [skip ci] commit aa2db90 Author: NoneTheWisr <[email protected]> Date: Sun Jan 16 12:19:55 2022 +0400 mob next [ci-skip] [ci skip] [skip ci] commit f473fee Author: sshah1 <[email protected]> Date: Sun Jan 16 09:09:32 2022 +0100 mob next [ci-skip] [ci skip] [skip ci] commit ff4628c Author: Preet Dua <[email protected]> Date: Sat Jan 15 23:58:18 2022 -0800 mob next [ci-skip] [ci skip] [skip ci] commit 90bdeb6 Author: NoneTheWisr <[email protected]> Date: Sun Jan 16 11:46:53 2022 +0400 mob next [ci-skip] [ci skip] [skip ci] commit 7044ed3 Author: Shahar Dawn Or <[email protected]> Date: Sat Jan 15 16:58:27 2022 +0700 mob next [ci-skip] [ci skip] [skip ci] commit 659639e Author: NoneTheWisr <[email protected]> Date: Sat Jan 15 13:54:21 2022 +0400 mob next [ci-skip] [ci skip] [skip ci] commit a305d97 Author: Preet Dua <[email protected]> Date: Sat Jan 15 01:43:33 2022 -0800 mob next [ci-skip] [ci skip] [skip ci] commit f08c2af Author: Roland Fredenhagen <[email protected]> Date: Sat Jan 15 10:33:59 2022 +0100 mob next [ci-skip] [ci skip] [skip ci] commit 48bd032 Author: Shahar Dawn Or <[email protected]> Date: Sat Jan 15 16:22:06 2022 +0700 mob next [ci-skip] [ci skip] [skip ci] commit db02884 Author: NoneTheWisr <[email protected]> Date: Sat Jan 15 13:10:44 2022 +0400 mob next [ci-skip] [ci skip] [skip ci] Co-authored-by: sshah1 <[email protected]> Co-authored-by: Roland Fredenhagen <[email protected]> Co-authored-by: Shahar Dawn Or <[email protected]> Co-authored-by: Preet Dua <[email protected]>
rust-itertools · Jan 16, 2022 · 479b4c4 · 479b4c4
1 parent 6c4fc2f
commit 479b4c4
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 0 deletions.
diff --git a/src/adaptors/mod.rs b/src/adaptors/mod.rs
@@ -839,6 +839,50 @@ impl_tuple_combination!(Tuple10Combination Tuple9Combination; a b c d e f g h i)
 impl_tuple_combination!(Tuple11Combination Tuple10Combination; a b c d e f g h i j);
 impl_tuple_combination!(Tuple12Combination Tuple11Combination; a b c d e f g h i j k);
 
+/// An iterator adapter to enumerate values within a nested `Result::Ok`.
+///
+/// See [`.enumerate_ok()`](crate::Itertools::enumerate_ok) for more information.
+#[derive(Clone)]
+#[must_use = "iterator adaptors are lazy and do nothing unless consumed"]
+pub struct EnumerateOk<I> {
+    iter: I,
+    index: usize
+}
+
+/// Create a new `EnumerateOk` iterator.
+pub fn enumerate_ok<I, T, E>(iter: I) -> EnumerateOk<I>
+where
+    I: Iterator<Item = Result<T, E>>,
+{
+    EnumerateOk {
+        iter,
+        index: 0
+    }
+}
+
+impl<I> fmt::Debug for EnumerateOk<I>
+where
+    I: fmt::Debug,
+{
+    debug_fmt_fields!(EnumerateOk, iter);
+}
+
+impl<I,T,E> Iterator for EnumerateOk<I>
+    where I: Iterator<Item = Result<T,E>>,
+{
+    type Item = Result<(usize,T),E>;
+
+    fn next(&mut self) -> Option<Self::Item> {
+        self.iter.next().map(|item| {
+            item.map(|v| {
+                let index = self.index;
+                self.index +=1;
+                (index,v)
+            })
+        })
+    }
+}
+
 /// An iterator adapter to filter values within a nested `Result::Ok`.
 ///
 /// See [`.filter_ok()`](crate::Itertools::filter_ok) for more information.

diff --git a/src/lib.rs b/src/lib.rs
@@ -99,6 +99,7 @@ pub mod structs {
         Batching,
         MapInto,
         MapOk,
+        EnumerateOk,
         Merge,
         MergeBy,
         TakeWhileRef,
@@ -846,6 +847,23 @@ pub trait Itertools : Iterator {
         self.map_ok(f)
     }
 
+    /// Return an iterator adaptor that adds an index to `Result::Ok`
+    /// values. `Result::Err` values are unchanged. The index is incremented
+    /// only for `Result::Ok` values.
+    ///
+    /// ```
+    /// use itertools::Itertools;
+    ///
+    /// let input = vec![Ok(41), Err(false), Ok(11)];
+    /// let it = input.into_iter().enumerate_ok();
+    /// itertools::assert_equal(it, vec![Ok((0, 41)), Err(false), Ok((1, 11))]);
+    /// ```
+    fn enumerate_ok<T, E>(self) -> EnumerateOk<Self>
+        where Self: Iterator<Item = Result<T, E>> + Sized,
+    {
+        adaptors::enumerate_ok(self)
+    }
+
     /// Return an iterator adaptor that applies the provided closure
     /// to every `Result::Ok` value. `Result::Err` values are
     /// unchanged.