Merge 3a0a6eb into ee13c72

azjezz · Dec 12, 2021 · 6c0326d · 6c0326d
2 parents ee13c72 + 3a0a6eb
commit 6c0326d
Show file tree

Hide file tree

Showing 30 changed files with 92 additions and 81 deletions.
diff --git a/src/Psl/File/ReadHandle.php b/src/Psl/File/ReadHandle.php
@@ -32,9 +32,9 @@ public function __construct(string $path)
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->readHandle->readImmediately($max_bytes);
+        return $this->readHandle->tryRead($max_bytes);
     }
 
     /**

diff --git a/src/Psl/File/ReadWriteHandle.php b/src/Psl/File/ReadWriteHandle.php
@@ -57,9 +57,9 @@ public function __construct(string $path, WriteMode $write_mode = WriteMode::OPE
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->readWriteHandle->readImmediately($max_bytes);
+        return $this->readWriteHandle->tryRead($max_bytes);
     }
 
     /**
@@ -73,9 +73,9 @@ public function read(?int $max_bytes = null, ?float $timeout = null): string
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->readWriteHandle->writeImmediately($bytes);
+        return $this->readWriteHandle->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/File/WriteHandle.php b/src/Psl/File/WriteHandle.php
@@ -52,9 +52,9 @@ public function __construct(string $path, WriteMode $write_mode = WriteMode::OPE
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->writeHandle->writeImmediately($bytes);
+        return $this->writeHandle->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Internal/ResourceHandle.php b/src/Psl/IO/Internal/ResourceHandle.php
@@ -135,7 +135,7 @@ public function __construct(mixed $stream, bool $read, bool $write, bool $seek,
      */
     public function write(string $bytes, ?float $timeout = null): int
     {
-        $written = $this->writeImmediately($bytes);
+        $written = $this->tryWrite($bytes);
         if ($this->blocks || $written === strlen($bytes)) {
             return $written;
         }
@@ -176,13 +176,13 @@ static function () use (&$deferred) {
             }
         }
 
-        return $written + $this->writeImmediately($bytes);
+        return $written + $this->tryWrite($bytes);
     }
 
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
         // there's a pending write operation, wait for it first.
         $this->writeDeferred?->getAwaitable()->then(static fn() => null, static fn() => null)->await();
@@ -246,7 +246,7 @@ public function tell(): int
      */
     public function read(?int $max_bytes = null, ?float $timeout = null): string
     {
-        $chunk = $this->readImmediately($max_bytes);
+        $chunk = $this->tryRead($max_bytes);
         if ('' !== $chunk || $this->blocks) {
             return $chunk;
         }
@@ -287,13 +287,13 @@ static function () use (&$deferred, $read_watcher) {
             }
         }
 
-        return $this->readImmediately($max_bytes);
+        return $this->tryRead($max_bytes);
     }
 
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
         // there's a pending read operation, wait for it.
         $this->readDeferred?->getAwaitable()->then(static fn() => null, static fn() => null)->await();

diff --git a/src/Psl/IO/MemoryHandle.php b/src/Psl/IO/MemoryHandle.php
@@ -37,7 +37,7 @@ public function __construct(string $buffer = '')
      *
      * @return string the read data on success, or an empty string if the end of file is reached.
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
         $this->assertHandleIsOpen();
 
@@ -72,7 +72,7 @@ public function readImmediately(?int $max_bytes = null): string
      */
     public function read(?int $max_bytes = null, ?float $timeout = null): string
     {
-        return $this->readImmediately($max_bytes);
+        return $this->tryRead($max_bytes);
     }
 
     /**
@@ -100,7 +100,7 @@ public function tell(): int
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes, ?float $timeout = null): int
+    public function tryWrite(string $bytes, ?float $timeout = null): int
     {
         $this->assertHandleIsOpen();
         $length = strlen($this->buffer);
@@ -127,7 +127,7 @@ public function writeImmediately(string $bytes, ?float $timeout = null): int
      */
     public function write(string $bytes, ?float $timeout = null): int
     {
-        return $this->writeImmediately($bytes);
+        return $this->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/IO/ReadHandleInterface.php b/src/Psl/IO/ReadHandleInterface.php
@@ -10,7 +10,7 @@
 interface ReadHandleInterface extends HandleInterface
 {
     /**
-     * An immediate, unordered read.
+     * Try to read from the handle immediately, without waiting.
      *
      * Up to `$max_bytes` may be allocated in a buffer; large values may lead to
      * unnecessarily hitting the request memory limit.
@@ -20,12 +20,12 @@ interface ReadHandleInterface extends HandleInterface
      * @throws Exception\AlreadyClosedException If the handle has been already closed.
      * @throws Exception\RuntimeException If an error occurred during the operation.
      *
-     * @return string the read data on success, or an empty string if the end of file is reached.
+     * @return string the read data on success, or an empty string if the handle is not ready for read, or the end of file is reached.
      *
      * @see ReadHandleInterface::read()
      * @see ReadHandleInterface::readAll()
      */
-    public function readImmediately(?int $max_bytes = null): string;
+    public function tryRead(?int $max_bytes = null): string;
 
     /**
      * Read from the handle, waiting for data if necessary.

diff --git a/src/Psl/IO/Reader.php b/src/Psl/IO/Reader.php
@@ -203,13 +203,13 @@ public function read(?int $max_bytes = null, ?float $timeout = null): string
 
         // We either have a buffer, or reached EOF; either way, behavior matches
         // read, so just delegate
-        return $this->readImmediately($max_bytes);
+        return $this->tryRead($max_bytes);
     }
 
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
         if (null !== $max_bytes) {
             /** @psalm-suppress MissingThrowsDocblock */
@@ -220,15 +220,13 @@ public function readImmediately(?int $max_bytes = null): string
             return '';
         }
 
-        // @codeCoverageIgnoreStart
         if ($this->buffer === '') {
-            $this->buffer = $this->getHandle()->readImmediately();
+            $this->buffer = $this->getHandle()->tryRead();
             if ($this->buffer === '') {
                 $this->eof = true;
                 return '';
             }
         }
-        // @codeCoverageIgnoreEnd
 
         $buffer = $this->buffer;
         if ($max_bytes === null || $max_bytes >= strlen($buffer)) {

diff --git a/src/Psl/IO/Stream/CloseReadHandle.php b/src/Psl/IO/Stream/CloseReadHandle.php
@@ -27,9 +27,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->handle->readImmediately($max_bytes);
+        return $this->handle->tryRead($max_bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/CloseReadWriteHandle.php b/src/Psl/IO/Stream/CloseReadWriteHandle.php
@@ -28,9 +28,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->handle->readImmediately($max_bytes);
+        return $this->handle->tryRead($max_bytes);
     }
 
     /**
@@ -44,9 +44,9 @@ public function read(?int $max_bytes = null, ?float $timeout = null): string
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->handle->writeImmediately($bytes);
+        return $this->handle->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/CloseSeekReadHandle.php b/src/Psl/IO/Stream/CloseSeekReadHandle.php
@@ -27,9 +27,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->handle->readImmediately($max_bytes);
+        return $this->handle->tryRead($max_bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/CloseSeekReadWriteHandle.php b/src/Psl/IO/Stream/CloseSeekReadWriteHandle.php
@@ -28,9 +28,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->handle->readImmediately($max_bytes);
+        return $this->handle->tryRead($max_bytes);
     }
 
     /**
@@ -44,9 +44,9 @@ public function read(?int $max_bytes = null, ?float $timeout = null): string
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->handle->writeImmediately($bytes);
+        return $this->handle->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/CloseSeekWriteHandle.php b/src/Psl/IO/Stream/CloseSeekWriteHandle.php
@@ -27,9 +27,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->handle->writeImmediately($bytes);
+        return $this->handle->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/CloseWriteHandle.php b/src/Psl/IO/Stream/CloseWriteHandle.php
@@ -27,9 +27,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->handle->writeImmediately($bytes);
+        return $this->handle->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/ReadHandle.php b/src/Psl/IO/Stream/ReadHandle.php
@@ -27,9 +27,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->handle->readImmediately($max_bytes);
+        return $this->handle->tryRead($max_bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/ReadWriteHandle.php b/src/Psl/IO/Stream/ReadWriteHandle.php
@@ -28,9 +28,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->handle->readImmediately($max_bytes);
+        return $this->handle->tryRead($max_bytes);
     }
 
     /**
@@ -44,9 +44,9 @@ public function read(?int $max_bytes = null, ?float $timeout = null): string
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->handle->writeImmediately($bytes);
+        return $this->handle->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/SeekReadHandle.php b/src/Psl/IO/Stream/SeekReadHandle.php
@@ -27,9 +27,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->handle->readImmediately($max_bytes);
+        return $this->handle->tryRead($max_bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/SeekReadWriteHandle.php b/src/Psl/IO/Stream/SeekReadWriteHandle.php
@@ -28,9 +28,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function readImmediately(?int $max_bytes = null): string
+    public function tryRead(?int $max_bytes = null): string
     {
-        return $this->handle->readImmediately($max_bytes);
+        return $this->handle->tryRead($max_bytes);
     }
 
     /**
@@ -44,9 +44,9 @@ public function read(?int $max_bytes = null, ?float $timeout = null): string
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->handle->writeImmediately($bytes);
+        return $this->handle->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/SeekWriteHandle.php b/src/Psl/IO/Stream/SeekWriteHandle.php
@@ -27,9 +27,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->handle->writeImmediately($bytes);
+        return $this->handle->tryWrite($bytes);
     }
 
     /**

diff --git a/src/Psl/IO/Stream/WriteHandle.php b/src/Psl/IO/Stream/WriteHandle.php
@@ -27,9 +27,9 @@ public function __construct(mixed $stream)
     /**
      * {@inheritDoc}
      */
-    public function writeImmediately(string $bytes): int
+    public function tryWrite(string $bytes): int
     {
-        return $this->handle->writeImmediately($bytes);
+        return $this->handle->tryWrite($bytes);
     }
 
     /**