Restore Pipeline\toIterator()

Useful for implementing IteratorAggregate in classes implementing Pipeline but not using either AsyncGenerator or PipelineSource.
amphp · Nov 10, 2020 · e99a7f3 · e99a7f3
1 parent fa31b4b
commit e99a7f3
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 6 deletions.
diff --git a/lib/AsyncGenerator.php b/lib/AsyncGenerator.php
@@ -138,8 +138,6 @@ public function getReturn(): mixed
      */
     public function getIterator(): \Iterator
     {
-        while (null !== $value = $this->continue()) {
-            yield $value;
-        }
+        return Pipeline\toIterator($this);
     }
 }
diff --git a/lib/Internal/AutoDisposingPipeline.php b/lib/Internal/AutoDisposingPipeline.php
@@ -49,8 +49,6 @@ public function dispose(): void
      */
     public function getIterator(): \Iterator
     {
-        while (null !== $value = $this->continue()) {
-            yield $value;
-        }
+        return Pipeline\toIterator($this);
     }
 }
diff --git a/lib/functions.php b/lib/functions.php
@@ -1038,4 +1038,24 @@ function toArray(Pipeline $pipeline): array
 
         return $array;
     }
+
+    /**
+     * Converts the given pipeline to an object implementing \Iterator.
+     *
+     * @template TValue
+     *
+     * @param Pipeline $pipeline
+     *
+     * @psalm-param Pipeline<TValue> $pipeline
+     *
+     * @return \Iterator
+     *
+     * @psalm-return \Iterator<TValue>
+     */
+    function toIterator(Pipeline $pipeline): \Iterator
+    {
+        while (null !== $value = $pipeline->continue()) {
+            yield $value;
+        }
+    }
 }