Document the field peek of IntersperseWith

rust-itertools · Nov 13, 2023 · 0dd980b · 0dd980b
1 parent bc9738d
commit 0dd980b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/intersperse.rs b/src/intersperse.rs
@@ -54,6 +54,9 @@ where
 {
     element: ElemF,
     iter: Fuse<I>,
+    /// `peek` is None while no item have been taken out of `iter` (at definition).
+    /// Then `peek` will alternatively be `Some(None)` and `Some(Some(item))`,
+    /// where `None` indicates it's time to generate from `element` (unless `iter` is empty).
     peek: Option<Option<I::Item>>,
 }