ReadableIterableStream
in package
implements
ReadableStream, IteratorAggregate
uses
ReadableStreamIteratorAggregate, ForbidCloning, ForbidSerialization
Creates a stream from an iterable emitting strings. If the iterable throws an exception, the exception will be thrown from {@see read()} and {@see buffer()}. Consider wrapping any exceptions in {@see StreamException} if you do not wish for another type of exception to be thrown from the stream.
Tags
Table of Contents
Interfaces
- ReadableStream
- A `ReadableStream` allows reading byte streams in chunks.
- IteratorAggregate
Properties
- $exception : Throwable|null
- $iterator : ConcurrentIterator<string|int, string>|null
- $onClose : DeferredFuture
- $pending : bool
Methods
- __construct() : mixed
- __serialize() : never
- __unserialize() : never
- close() : void
- Closes the resource, marking it as unusable.
- getIterator() : Traversable<int, string>
- isClosed() : bool
- Returns whether this resource has been closed.
- isReadable() : bool
- onClose() : void
- Registers a callback that is invoked when this resource is closed.
- read() : string|null
- Reads data from the stream.
- __clone() : mixed
Properties
$exception
private
Throwable|null
$exception
= null
$iterator
private
ConcurrentIterator<string|int, string>|null
$iterator
$onClose read-only
private
DeferredFuture
$onClose
$pending
private
bool
$pending
= false
Methods
__construct()
public
__construct(iterable<mixed, string> $iterable) : mixed
Parameters
- $iterable : iterable<mixed, string>
__serialize()
public
final __serialize() : never
Return values
never__unserialize()
public
final __unserialize(array<string|int, mixed> $data) : never
Parameters
- $data : array<string|int, mixed>
Return values
neverclose()
Closes the resource, marking it as unusable.
public
close() : void
Whether pending operations are aborted or not is implementation dependent.
getIterator()
public
getIterator() : Traversable<int, string>
Return values
Traversable<int, string>isClosed()
Returns whether this resource has been closed.
public
isClosed() : bool
Return values
bool —true if closed, otherwise false.
isReadable()
public
isReadable() : bool
Return values
bool —A stream may become unreadable if the underlying source is closed or lost.
onClose()
Registers a callback that is invoked when this resource is closed.
public
onClose(Closure $onClose) : void
Parameters
- $onClose : Closure
read()
Reads data from the stream.
public
read([Cancellation|null $cancellation = null ]) : string|null
Parameters
- $cancellation : Cancellation|null = null
-
Cancel the read operation. The state in which the stream will be after a cancelled operation is implementation dependent.
Return values
string|null —Returns a string when new data is available or null if the stream has closed.
__clone()
protected
final __clone() : mixed