Skip to content

Commit aa88619

Browse files
Document the field peek of IntersperseWith
1 parent 8286788 commit aa88619

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/intersperse.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ where
5454
{
5555
element: ElemF,
5656
iter: Fuse<I>,
57+
/// `peek` is None while no item have been taken out of `iter` (at definition).
58+
/// Then `peek` will alternatively be `Some(None)` and `Some(Some(item))`,
59+
/// where `None` indicates it's time to generate from `element` (unless `iter` is empty).
5760
peek: Option<Option<I::Item>>,
5861
}
5962

0 commit comments

Comments
 (0)