Class BufferStream
- GuzzleHttp\Psr7\BufferStream implements Psr\Http\Message\StreamInterface
- Namespace: GuzzleHttp\Psr7
- Located at BufferStream.php
Provides a buffer stream that can be written to to fill a buffer, and read from to remove bytes from the buffer.
This stream returns a "hwm" metadata value that tells upstream consumers what the configured high water mark of the stream is, or the maximum preferred size of the buffer.
Methods Summary
- __construct ( int $hwm = 16384 )
-
__toString ( )
Reads all data from the stream into a string, from the beginning to end.
-
getContents ( )
Returns the remaining contents in a string
-
close ( )
Closes the stream and any underlying resources.
-
detach ( )
Separates any underlying resources from the stream.
-
getSize ( )
Get the size of the stream if known.
-
isReadable ( )
Returns whether or not the stream is readable.
-
isWritable ( )
Returns whether or not the stream is writable.
-
isSeekable ( )
Returns whether or not the stream is seekable.
-
rewind ( )
Seek to the beginning of the stream.
-
seek ( int $offset, int $whence = SEEK_SET )
Seek to a position in the stream.
-
eof ( )
Returns true if the stream is at the end of the stream.
-
tell ( )
Returns the current position of the file read/write pointer
-
read ( int $length )
Reads data from the buffer.
-
write ( string $string )
Writes data to the buffer.
-
getMetadata ( string $key = null )
Get stream metadata as an associative array or retrieve a specific key.
Methods Details
__construct ( integer $hwm = 16384 )
Parameters
| integer | $hwm = 16384 | High water mark, representing the preferred maximum buffer size. If the size of the buffer exceeds the high water mark, then calls to write will continue to succeed but will return false to inform writers to slow down until the buffer has been drained by reading from it. |
string __toString ( )
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.
Returns
| string |
See
Implementation of
string getContents ( )
Returns the remaining contents in a string
Returns
| string |
Exceptions
| RuntimeException if unable to read or an error occurs while reading. |
Implementation of
close ( )
Closes the stream and any underlying resources.
Implementation of
resource|null detach ( )
Separates any underlying resources from the stream.
After the stream has been detached, the stream is in an unusable state.
Returns
| resource|null Underlying PHP stream, if any |
Implementation of
integer|null getSize ( )
Get the size of the stream if known.
Returns
| integer|null Returns the size in bytes if known, or null if unknown. |
Implementation of
boolean isReadable ( )
Returns whether or not the stream is readable.
Returns
| boolean |
Implementation of
boolean isWritable ( )
Returns whether or not the stream is writable.
Returns
| boolean |
Implementation of
boolean isSeekable ( )
Returns whether or not the stream is seekable.
Returns
| boolean |
Implementation of
rewind ( )
Seek to the beginning of the stream.
If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).
Exceptions
| RuntimeException on failure. |
See
Link
Implementation of
seek ( integer $offset, integer $whence = SEEK_SET )
Seek to a position in the stream.
Parameters
| integer | $offset | Stream offset |
| integer | $whence = SEEK_SET | 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 |
Exceptions
| RuntimeException on failure. |
Link
Implementation of
boolean eof ( )
Returns true if the stream is at the end of the stream.
Returns
| boolean |
Implementation of
integer tell ( )
Returns the current position of the file read/write pointer
Returns
| integer Position of the file pointer |
Exceptions
| RuntimeException on error. |
Implementation of
string read ( integer $length )
Reads data from the buffer.
Parameters
| integer | $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
| string Returns the data read from the stream, or an empty string if no bytes are available. |
Exceptions
| RuntimeException if an error occurs. |
Implementation of
integer write ( string $string )
Writes data to the buffer.
Parameters
| string | $string | The string that is to be written. |
Returns
| integer Returns the number of bytes written to the stream. |
Exceptions
| RuntimeException on failure. |
Implementation of
array|mixed|null getMetadata ( string $key = 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.
Parameters
| string | $key = null | Specific metadata to retrieve. |
Returns
| array|mixed|null 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. |
