IWriteStreamStorage.php 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. <?php declare(strict_types=1);
  2. /**
  3. * @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
  4. *
  5. * @license GNU AGPL version 3 or any later version
  6. *
  7. * This program is free software: you can redistribute it and/or modify
  8. * it under the terms of the GNU Affero General Public License as
  9. * published by the Free Software Foundation, either version 3 of the
  10. * License, or (at your option) any later version.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU Affero General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Affero General Public License
  18. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  19. *
  20. */
  21. namespace OCP\Files\Storage;
  22. /**
  23. * Interface that adds the ability to write a stream directly to file
  24. *
  25. * @since 15.0.0
  26. */
  27. interface IWriteStreamStorage extends IStorage {
  28. /**
  29. * Write the data from a stream to a file
  30. *
  31. * @param string $path
  32. * @param resource $stream
  33. * @param int|null $size the size of the stream if known in advance
  34. * @return int the number of bytes written
  35. * @since 15.0.0
  36. */
  37. public function writeStream(string $path, $stream, int $size = null): int;
  38. }