MediaWiki\Rest\CopyableStreamInterface Interface Reference

An interface for a stream with a copyToStream() function. More...

Inherits Psr\Http\Message\StreamInterface.

Inherited by MediaWiki\Rest\Stream, and MediaWiki\Rest\StringStream.

Collaboration diagram for MediaWiki\Rest\CopyableStreamInterface:

Public Member Functions
	copyToStream ( $stream)
	Copy this stream to a specified stream resource.

Detailed Description

An interface for a stream with a copyToStream() function.

Definition at line 8 of file CopyableStreamInterface.php.

Member Function Documentation

copyToStream()

MediaWiki\Rest\CopyableStreamInterface::copyToStream

(

$stream

)

Copy this stream to a specified stream resource.

For some streams, this can be implemented without a tight loop in PHP code.

Equivalent to reading from the object until EOF and writing the resulting data to $stream. The position will be advanced to the end.

Note that $stream is not a StreamInterface object.

Parameters

resource

$stream

Destination

Implemented in MediaWiki\Rest\StringStream, and MediaWiki\Rest\Stream.

---

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

• includes/Rest/CopyableStreamInterface.php