Base64DecodingWritableStream
in package
implements
WritableStream
uses
ForbidCloning, ForbidSerialization
FinalYes
Table of Contents
Interfaces
- WritableStream
- A `WritableStream` allows writing data in chunks. Writers can wait on the returned promises to feel the backpressure.
Properties
- $buffer : string
- $destination : WritableStream
- $offset : int
Methods
- __construct() : mixed
- __serialize() : never
- __unserialize() : never
- close() : void
- Closes the resource, marking it as unusable.
- end() : void
- Marks the stream as no longer writable.
- isClosed() : bool
- Returns whether this resource has been closed.
- isWritable() : bool
- onClose() : void
- Registers a callback that is invoked when this resource is closed.
- write() : void
- Writes data to the stream.
- __clone() : mixed
Properties
$buffer
private
string
$buffer
= ''
$destination read-only
private
WritableStream
$destination
$offset
private
int
$offset
= 0
Methods
__construct()
public
__construct(WritableStream $destination) : mixed
Parameters
- $destination : WritableStream
__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.
end()
Marks the stream as no longer writable.
public
end() : void
Note that this is not the same as forcefully closing the stream. This method waits for all pending writes to complete before closing the stream. Socket streams implementing this interface should only close the writable side of the stream.
isClosed()
Returns whether this resource has been closed.
public
isClosed() : bool
Return values
bool —true if closed, otherwise false.
isWritable()
public
isWritable() : bool
Return values
bool —A stream may no longer be writable if it is closed or ended using end().
onClose()
Registers a callback that is invoked when this resource is closed.
public
onClose(Closure $onClose) : void
Parameters
- $onClose : Closure
write()
Writes data to the stream.
public
write(string $bytes) : void
Parameters
- $bytes : string
-
Bytes to write.
__clone()
protected
final __clone() : mixed