$methods
$methods : array
Compose stream implementations based on a hash of functions.
Allows for easy testing and extension of a provided stream without needing to create a concrete class for a simple extension point.
$methods : array
$slots : array
decorate(\Psr\Http\Message\StreamInterface $stream, array $methods) : \GuzzleHttp\Psr7\FnStream
Adds custom functionality to an underlying stream by intercepting specific method calls.
| \Psr\Http\Message\StreamInterface | $stream | Stream to decorate |
| array | $methods | Hash of method name to a closure |
__toString() : string
Reads all data from the stream into a string, from the beginning to end.
This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.
Warning: This could attempt to load a large amount of data into memory.
This method MUST NOT raise an exception in order to conform with PHP's string casting operations.
seek(mixed $offset, mixed $whence = SEEK_SET) : mixed
Seek to a position in the stream.
| mixed | $offset | Stream offset |
| mixed | $whence | Specifies how the cursor position will be calculated
based on the seek offset. Valid values are identical to the built-in
PHP $whence values for |
read(mixed $length) : string
Read data from the stream.
| mixed | $length | Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes. |
Returns the data read from the stream, or an empty string if no bytes are available.
getMetadata(mixed $key = null) : array|mixed|null
Get stream metadata as an associative array or retrieve a specific key.
The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.
| mixed | $key | Specific metadata to retrieve. |
Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.