IWriteStreamStorage.php 1.5 KB

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