GuzzleHttp\Psr7\NoSeekStream Class Reference

Stream decorator that prevents a stream from being seeked. More...

Inheritance diagram for GuzzleHttp\Psr7\NoSeekStream:

Collaboration diagram for GuzzleHttp\Psr7\NoSeekStream:

Public Member Functions
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...
	isSeekable ()
	Returns whether or not the stream is seekable. More...
Public Member Functions inherited from Psr\Http\Message\StreamInterface
	__toString ()
	Reads all data from the stream into a string, from the beginning to end. More...
	close ()
	Closes the stream and any underlying resources. More...
	detach ()
	Separates any underlying resources from the stream. More...
	getSize ()
	Get the size of the stream if known. More...
	tell ()
	Returns the current position of the file read/write pointer. More...
	eof ()
	Returns true if the stream is at the end of the stream. More...
	isSeekable ()
	Returns whether or not the stream is seekable. More...
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...
	rewind ()
	Seek to the beginning of the stream. More...
	isWritable ()
	Returns whether or not the stream is writable. More...
	write ($string)
	Write data to the stream. More...
	isReadable ()
	Returns whether or not the stream is readable. More...
	read ($length)
	Read data from the stream. More...
	getContents ()
	Returns the remaining contents in a string. More...
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...

Detailed Description

Stream decorator that prevents a stream from being seeked.

Definition at line 9 of file NoSeekStream.php.

Member Function Documentation

isSeekable()

GuzzleHttp\Psr7\NoSeekStream::isSeekable

(

)

Returns whether or not the stream is seekable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 18 of file NoSeekStream.php.

    {
        return false;
    }

seek()

GuzzleHttp\Psr7\NoSeekStream::seek	(		$offset,
			$whence = SEEK_SET
	)

Seek to a position in the stream.

int $offset Stream offset int $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 fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset. on failure.

Implements Psr\Http\Message\StreamInterface.

Definition at line 13 of file NoSeekStream.php.

    {
        throw new \RuntimeException('Cannot seek a NoSeekStream');
    }

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/guzzlehttp/psr7/src/NoSeekStream.php