mirror of
https://github.com/danog/amp.git
synced 2024-12-04 18:38:17 +01:00
31 lines
777 B
PHP
31 lines
777 B
PHP
<?php
|
|
|
|
namespace Amp;
|
|
|
|
/**
|
|
* A stream is an asynchronous set of ordered values.
|
|
*
|
|
* @template-covariant TValue
|
|
*/
|
|
interface Stream
|
|
{
|
|
/**
|
|
* Succeeds with the yielded value if the stream has yielded a value or null if the stream has completed.
|
|
* If the stream fails, the returned promise will fail with the same exception.
|
|
*
|
|
* @return Promise<mixed|null> Resolves with null if the stream has completed.
|
|
*
|
|
* @psalm-return Promise<TValue|null>
|
|
*
|
|
* @throws \Throwable The exception used to fail the stream.
|
|
*/
|
|
public function continue(): Promise;
|
|
|
|
/**
|
|
* Disposes of the stream, indicating the consumer is no longer interested in the stream output.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function dispose();
|
|
}
|