1
0
mirror of https://github.com/danog/amp.git synced 2024-12-11 17:09:40 +01:00
amp/lib/AsyncGenerator.php

122 lines
3.3 KiB
PHP
Raw Normal View History

2020-05-13 17:15:21 +02:00
<?php
namespace Amp;
/**
* @template TValue
* @template TSend
* @template TReturn
*/
final class AsyncGenerator implements Stream
{
/** @var Internal\GeneratorStream */
private $generator;
/** @var Promise<TReturn> */
private $coroutine;
/**
* @param callable(callable(TValue):Promise<TSend>):\Generator $callable
*
* @throws \TypeError Thrown if the callable does not return a Generator.
2020-05-13 17:15:21 +02:00
*/
public function __construct(callable $callable)
{
$source = new class implements Internal\GeneratorStream {
use Internal\Yielder {
2020-05-13 23:48:38 +02:00
createGenerator as public;
2020-05-13 17:15:21 +02:00
}
};
if (\PHP_VERSION_ID < 70100) {
$yield = static function ($value) use ($source): Promise {
return $source->yield($value);
};
} else {
$yield = \Closure::fromCallable([$source, "yield"]);
}
$result = $callable($yield);
if (!$result instanceof \Generator) {
throw new \TypeError("The callable did not return a Generator");
}
$this->coroutine = new Coroutine($result);
$this->coroutine->onResolve(static function ($exception) use ($source) {
if ($exception) {
$source->fail($exception);
return;
}
$source->complete();
});
2020-05-13 23:48:38 +02:00
$this->generator = $source->createGenerator();
}
2020-05-13 17:15:21 +02:00
/**
* @inheritDoc
2020-05-13 17:15:21 +02:00
*/
public function continue(): Promise
{
return $this->generator->continue();
}
/**
* Sends a value to the async generator, resolving the back-pressure promise with the given value.
* The first yielded value must be retrieved using {@see continue()}.
2020-05-13 17:15:21 +02:00
*
* @param mixed $value Value to send to the async generator.
*
* @psalm-param TSend $value
*
* @return Promise<YieldedValue|null> Resolves with null if the stream has completed.
2020-05-18 20:49:56 +02:00
*
* @psalm-return Promise<YieldedValue<TValue>|null>
*
* @throws \Error If the first yielded value has not been retrieved using {@see continue()}.
2020-05-13 17:15:21 +02:00
*/
public function send($value): Promise
{
return $this->generator->send($value);
}
/**
* Throws an exception into the async generator, failing the back-pressure promise with the given exception.
* The first yielded value must be retrieved using {@see continue()}.
2020-05-13 17:15:21 +02:00
*
* @param \Throwable $exception Exception to throw into the async generator.
*
* @return Promise<YieldedValue|null> Resolves with null if the stream has completed.
*
* @psalm-return Promise<YieldedValue<TValue>|null>
2020-05-18 20:49:56 +02:00
*
* @throws \Error If the first yielded value has not been retrieved using {@see continue()}.
2020-05-13 17:15:21 +02:00
*/
public function throw(\Throwable $exception): Promise
{
return $this->generator->throw($exception);
}
/**
* Notifies the generator that the consumer is no longer interested in the generator output.
*
* @return void
*/
public function dispose()
{
$this->generator->dispose();
}
2020-05-13 17:15:21 +02:00
/**
* @return Promise<mixed>
*
* @psalm-return Promise<TReturn>
2020-05-13 17:15:21 +02:00
*/
public function getReturn(): Promise
{
return $this->coroutine;
}
}