includes/Rest/CopyableStreamInterface.php

   1 <?php
   2
   3 namespace MediaWiki\Rest;
   4
   5 /**
   6  * An interface for a stream with a copyToStream() function.
   7  */
   8 interface CopyableStreamInterface extends \Psr\Http\Message\StreamInterface {
   9         /**
  10          * Copy this stream to a specified stream resource. For some streams,
  11          * this can be implemented without a tight loop in PHP code.
  12          *
  13          * Equivalent to reading from the object until EOF and writing the
  14          * resulting data to $stream. The position will be advanced to the end.
  15          *
  16          * Note that $stream is not a StreamInterface object.
  17          *
  18          * @param resource $stream Destination
  19          */
  20         function copyToStream( $stream );
  21 }