Add step eliminator for iterators

The `step` function allows eager access to the first item in the
iterator, but does not force the rest of the iterator.

Author: drewolson

CHANGELOG.md

@@ -10,7 +10,8 @@
 - The `dynamic` module gains the `option` function.
 - The `uri` module gains the `percent_encode` and `percent_decode` functions.
 - The `os` module gains the `erlang_timestamp` function.
-- The `iterator` module gains the `append`, `flatten` and `flat_map` functions.
+- The `iterator` module gains the `append`, `flatten`, `flat_map` and `step`
+  functions.
 
 ## v0.11.0 - 2020-08-22
 

src/gleam/iterator.gleam

@@ -168,6 +168,34 @@ pub fn to_list(iterator: Iterator(element)) -> List(element) {
   |> list.reverse
 }
 
+/// Eagerly access the first value of an interator, returning a `Next`
+/// that contains the first value and the rest of the iterator.
+///
+/// If called on an empty iterator, `Done` is returned.
+///
+/// ## Examples
+///
+///    > assert Next(head, tail) =
+///    >   [1, 2, 3, 4]
+///    >   |> from_list
+///    >   |> step
+///    > head
+///    1
+///    > tail |> to_list
+///    [2, 3, 4]
+///
+///    > []
+///    > |> from_list
+///    > |> step
+///    Done
+///
+pub fn step(iterator: Iterator(e)) -> Step(e, Iterator(e)) {
+  case iterator.continuation() {
+    Stop -> Done
+    Continue(e, a) -> Next(e, Iterator(a))
+  }
+}
+
 fn do_take(
   continuation: fn() -> Action(e),
   desired: Int,

test/gleam/iterator_test.gleam

@@ -1,5 +1,5 @@
 import gleam/should
-import gleam/iterator
+import gleam/iterator.{Done, Next}
 import gleam/list
 
 // a |> from_list |> to_list == a
@@ -17,6 +17,30 @@ pub fn to_from_list_test() {
   test([1, 2, 4, 8])
 }
 
+pub fn step_test() {
+  let test = fn(subject) {
+    let step =
+      subject
+      |> iterator.from_list
+      |> iterator.step
+
+    case subject {
+      [] ->
+        step
+        |> should.equal(Done)
+
+      [h, ..t] ->
+        step
+        |> should.equal(Next(h, iterator.from_list(t)))
+    }
+  }
+
+  test([])
+  test([1])
+  test([1, 2])
+  test([1, 2, 3])
+}
+
 // a |> from_list |> take(n) == a |> list.take(_, n)
 pub fn take_test() {
   let test = fn(n, subject) {