Amphp之Iterators（迭代器）

Amphp之Iterators（迭代器）

迭代器是 Promise 之后的下一个层次。虽然 promise 使用一个值解决一次，但迭代器允许使用一组项目。

Iterator Consumption //消费

Amp 中的每个迭代器都遵循 Amp\Iterator接口。

<?php
namespace Amp;

interface Iterator
{
    public function advance(): Promise;
    public function getCurrent();
}

Advance() 返回一个 Promise，它的分辨率值告诉我们是否有一个元素可以消费。如果它解析为 true，则可以使用 getCurrent() 来消费当前位置的元素，否则迭代器结束并且没有更多的值可以消费。如果发生异常，Advance() 返回一个失败的 Promise，而 getCurrent() 在调用时抛出失败原因。

Simple Consumption Example //简单的消费示例

<?php
$iterator = foobar();

while (yield $iterator->advance()) {
    $element = $iterator->getCurrent();
    // do something with $element
}

Iterator Creation //创建

Emitter //发射器

Deferred用于 Promise，Emitter 用于迭代器。返回 Iterator 以异步使用可迭代结果的库会创建 Amp\Emitter并使用 iterate()返回 Iterator。这确保消费者只能使用迭代器，但不能发出值或完成迭代器。

emit()

emit() 向迭代器发出一个新值，消费者可以使用该值。发出的值作为第一个参数传递给 emit()。emit() 返回一个可以在发出新值之前等待的 Promise。这允许发出值与消费者消费它们的速度一样快。

complete()

complete() 将发射器/链接的迭代器标记为完成。完成发射器/迭代器后，不允许再发射。

Producer

Producer 是 Emitter 的简化形式，可以在单个协程可以发出所有值时使用。
Producer 接受一个 callable 作为第一个构造函数参数，该参数作为协程运行，并传递了一个 $emit callable，它可以用来发出值，就像 Emitter 中的 emit() 方法一样。

示例

$iterator = new Producer(function (callable $emit) {
    yield $emit(1);
    yield $emit(new Delayed(500, 2));
    yield $emit(3);
    yield $emit(4);
});

fromIterable

迭代器也可以从普通的 PHP 数组或 Traversable 实例创建，这主要用于测试，但也可能出于与 Success 和 Failure 相同的原因使用。

function fromIterable($iterable, int $delay = 0) { ... }

$delay允许在每次发射之间添加延迟。