feat(io-stream): add getStream() method to access underlying stream

Signed-off-by: azjezz <azjezz@protonmail.com>
azjezz · Nov 13, 2021 · 6155ac3 · 6155ac3
1 parent 3f2bde0
commit 6155ac3
Show file tree

Hide file tree

Showing 45 changed files with 469 additions and 84 deletions.
diff --git a/docs/component/io-stream.md b/docs/component/io-stream.md
@@ -12,17 +12,17 @@
 
 #### `Classes`
 
-- [CloseHandle](./../../src/Psl/IO/Stream/CloseHandle.php#L13)
+- [CloseHandle](./../../src/Psl/IO/Stream/CloseHandle.php#L12)
 - [CloseReadHandle](./../../src/Psl/IO/Stream/CloseReadHandle.php#L13)
 - [CloseReadWriteHandle](./../../src/Psl/IO/Stream/CloseReadWriteHandle.php#L13)
-- [CloseSeekHandle](./../../src/Psl/IO/Stream/CloseSeekHandle.php#L13)
+- [CloseSeekHandle](./../../src/Psl/IO/Stream/CloseSeekHandle.php#L12)
 - [CloseSeekReadHandle](./../../src/Psl/IO/Stream/CloseSeekReadHandle.php#L13)
 - [CloseSeekReadWriteHandle](./../../src/Psl/IO/Stream/CloseSeekReadWriteHandle.php#L13)
 - [CloseSeekWriteHandle](./../../src/Psl/IO/Stream/CloseSeekWriteHandle.php#L13)
 - [CloseWriteHandle](./../../src/Psl/IO/Stream/CloseWriteHandle.php#L13)
 - [ReadHandle](./../../src/Psl/IO/Stream/ReadHandle.php#L13)
 - [ReadWriteHandle](./../../src/Psl/IO/Stream/ReadWriteHandle.php#L13)
-- [SeekHandle](./../../src/Psl/IO/Stream/SeekHandle.php#L13)
+- [SeekHandle](./../../src/Psl/IO/Stream/SeekHandle.php#L12)
 - [SeekReadHandle](./../../src/Psl/IO/Stream/SeekReadHandle.php#L13)
 - [SeekReadWriteHandle](./../../src/Psl/IO/Stream/SeekReadWriteHandle.php#L13)
 - [SeekWriteHandle](./../../src/Psl/IO/Stream/SeekWriteHandle.php#L13)

diff --git a/docs/component/io.md b/docs/component/io.md
@@ -12,9 +12,9 @@
 
 #### `Functions`
 
-- [error_handle](./../../src/Psl/IO/error_handle.php#L17)
-- [input_handle](./../../src/Psl/IO/input_handle.php#L17)
-- [output_handle](./../../src/Psl/IO/output_handle.php#L17)
+- [error_handle](./../../src/Psl/IO/error_handle.php#L20)
+- [input_handle](./../../src/Psl/IO/input_handle.php#L20)
+- [output_handle](./../../src/Psl/IO/output_handle.php#L20)
 - [pipe](./../../src/Psl/IO/pipe.php#L24)
 
 #### `Interfaces`

diff --git a/src/Psl/File/HandleInterface.php b/src/Psl/File/HandleInterface.php
@@ -6,7 +6,7 @@
 
 use Psl\IO;
 
-interface HandleInterface extends IO\CloseSeekHandleInterface
+interface HandleInterface extends IO\Stream\CloseSeekHandleInterface
 {
     /**
      * Gets the path to the file.

diff --git a/src/Psl/File/Internal/AbstractHandleWrapper.php b/src/Psl/File/Internal/AbstractHandleWrapper.php
@@ -69,4 +69,12 @@ public function close(): void
     {
         $this->handle->close();
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getStream(): mixed
+    {
+        $this->handle->getStream();
+    }
 }
diff --git a/src/Psl/File/ReadHandleInterface.php b/src/Psl/File/ReadHandleInterface.php
@@ -6,6 +6,6 @@
 
 use Psl\IO;
 
-interface ReadHandleInterface extends HandleInterface, IO\CloseSeekReadHandleInterface
+interface ReadHandleInterface extends HandleInterface, IO\Stream\CloseSeekReadHandleInterface
 {
 }
diff --git a/src/Psl/File/ReadWriteHandleInterface.php b/src/Psl/File/ReadWriteHandleInterface.php
@@ -7,7 +7,7 @@
 use Psl\IO;
 
 interface ReadWriteHandleInterface extends
-    IO\CloseSeekReadWriteHandleInterface,
+    IO\Stream\CloseSeekReadWriteHandleInterface,
     ReadHandleInterface,
     WriteHandleInterface
 {

diff --git a/src/Psl/File/WriteHandleInterface.php b/src/Psl/File/WriteHandleInterface.php
@@ -6,6 +6,6 @@
 
 use Psl\IO;
 
-interface WriteHandleInterface extends HandleInterface, IO\CloseSeekWriteHandleInterface
+interface WriteHandleInterface extends HandleInterface, IO\Stream\CloseSeekWriteHandleInterface
 {
 }
diff --git a/src/Psl/IO/Internal/ResourceHandle.php b/src/Psl/IO/Internal/ResourceHandle.php
@@ -33,7 +33,7 @@
  *
  * @codeCoverageIgnore
  */
-class ResourceHandle implements IO\CloseSeekReadWriteHandleInterface
+class ResourceHandle implements IO\Stream\CloseSeekReadWriteHandleInterface
 {
     use IO\ReadHandleConvenienceMethodsTrait;
     use IO\WriteHandleConvenienceMethodsTrait;
@@ -338,4 +338,12 @@ public function close(): void
         $this->readSuspension?->throw(throw new Exception\AlreadyClosedException('Handle has already been closed.'));
         $this->writeSuspension?->throw(throw new Exception\AlreadyClosedException('Handle has already been closed.'));
     }
+
+    /**
+     * @return object|resource|null
+     */
+    public function getStream(): mixed
+    {
+        return $this->resource;
+    }
 }
diff --git a/src/Psl/IO/Stream/CloseHandle.php b/src/Psl/IO/Stream/CloseHandle.php
@@ -4,15 +4,14 @@
 
 namespace Psl\IO\Stream;
 
-use Psl\IO;
 use Psl\IO\Internal;
 
 /**
  * @codeCoverageIgnore
  */
-final class CloseHandle implements IO\CloseHandleInterface
+final class CloseHandle implements CloseHandleInterface
 {
-    private IO\CloseHandleInterface $handle;
+    private CloseHandleInterface $handle;
 
     /**
      * @param resource|object $stream
@@ -29,4 +28,12 @@ public function close(): void
     {
         $this->handle->close();
     }
+
+    /**
+     * @return object|resource|null
+     */
+    public function getStream(): mixed
+    {
+        return $this->handle->getStream();
+    }
 }
diff --git a/src/Psl/IO/Stream/CloseHandleInterface.php b/src/Psl/IO/Stream/CloseHandleInterface.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psl\IO\Stream;
+
+use Psl\IO;
+
+interface CloseHandleInterface extends HandleInterface, IO\CloseHandleInterface
+{
+}
diff --git a/src/Psl/IO/Stream/CloseReadHandle.php b/src/Psl/IO/Stream/CloseReadHandle.php
@@ -10,11 +10,11 @@
 /**
  * @codeCoverageIgnore
  */
-final class CloseReadHandle implements IO\CloseReadHandleInterface
+final class CloseReadHandle implements CloseReadHandleInterface
 {
     use IO\ReadHandleConvenienceMethodsTrait;
 
-    private IO\CloseReadHandleInterface $handle;
+    private CloseReadHandleInterface $handle;
 
     /**
      * @param resource|object $stream
@@ -47,4 +47,12 @@ public function close(): void
     {
         $this->handle->close();
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getStream(): mixed
+    {
+        return $this->handle->getStream();
+    }
 }
diff --git a/src/Psl/IO/Stream/CloseReadHandleInterface.php b/src/Psl/IO/Stream/CloseReadHandleInterface.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psl\IO\Stream;
+
+use Psl\IO;
+
+interface CloseReadHandleInterface extends CloseHandleInterface, IO\CloseReadHandleInterface, ReadHandleInterface
+{
+}
diff --git a/src/Psl/IO/Stream/CloseReadWriteHandle.php b/src/Psl/IO/Stream/CloseReadWriteHandle.php
@@ -10,12 +10,12 @@
 /**
  * @codeCoverageIgnore
  */
-final class CloseReadWriteHandle implements IO\CloseReadWriteHandleInterface
+final class CloseReadWriteHandle implements CloseReadWriteHandleInterface
 {
     use IO\ReadHandleConvenienceMethodsTrait;
     use IO\WriteHandleConvenienceMethodsTrait;
 
-    private IO\CloseReadWriteHandleInterface $handle;
+    private CloseReadWriteHandleInterface $handle;
 
     /**
      * @param resource|object $stream
@@ -64,4 +64,12 @@ public function close(): void
     {
         $this->handle->close();
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getStream(): mixed
+    {
+        return $this->handle->getStream();
+    }
 }
diff --git a/src/Psl/IO/Stream/CloseReadWriteHandleInterface.php b/src/Psl/IO/Stream/CloseReadWriteHandleInterface.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psl\IO\Stream;
+
+use Psl\IO;
+
+interface CloseReadWriteHandleInterface extends
+    CloseReadHandleInterface,
+    CloseWriteHandleInterface,
+    IO\CloseReadWriteHandleInterface,
+    ReadWriteHandleInterface
+{
+}
diff --git a/src/Psl/IO/Stream/CloseSeekHandle.php b/src/Psl/IO/Stream/CloseSeekHandle.php
@@ -4,15 +4,14 @@
 
 namespace Psl\IO\Stream;
 
-use Psl\IO;
 use Psl\IO\Internal;
 
 /**
  * @codeCoverageIgnore
  */
-final class CloseSeekHandle implements IO\CloseSeekHandleInterface
+final class CloseSeekHandle implements CloseSeekHandleInterface
 {
-    private IO\CloseSeekHandleInterface $handle;
+    private CloseSeekHandleInterface $handle;
 
     /**
      * @param resource|object $stream
@@ -45,4 +44,12 @@ public function close(): void
     {
         $this->handle->close();
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getStream(): mixed
+    {
+        return $this->handle->getStream();
+    }
 }
diff --git a/src/Psl/IO/Stream/CloseSeekHandleInterface.php b/src/Psl/IO/Stream/CloseSeekHandleInterface.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psl\IO\Stream;
+
+use Psl\IO;
+
+interface CloseSeekHandleInterface extends
+    CloseHandleInterface,
+    IO\CloseSeekHandleInterface,
+    SeekHandleInterface
+{
+}
diff --git a/src/Psl/IO/Stream/CloseSeekReadHandle.php b/src/Psl/IO/Stream/CloseSeekReadHandle.php
@@ -10,11 +10,11 @@
 /**
  * @codeCoverageIgnore
  */
-final class CloseSeekReadHandle implements IO\CloseSeekReadHandleInterface
+final class CloseSeekReadHandle implements CloseSeekReadHandleInterface
 {
     use IO\ReadHandleConvenienceMethodsTrait;
 
-    private IO\CloseSeekReadHandleInterface $handle;
+    private CloseSeekReadHandleInterface $handle;
 
     /**
      * @param resource|object $stream
@@ -63,4 +63,12 @@ public function close(): void
     {
         $this->handle->close();
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getStream(): mixed
+    {
+        return $this->handle->getStream();
+    }
 }
diff --git a/src/Psl/IO/Stream/CloseSeekReadHandleInterface.php b/src/Psl/IO/Stream/CloseSeekReadHandleInterface.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psl\IO\Stream;
+
+use Psl\IO;
+
+interface CloseSeekReadHandleInterface extends
+    CloseReadHandleInterface,
+    CloseSeekHandleInterface,
+    IO\CloseSeekReadHandleInterface,
+    SeekReadHandleInterface
+{
+}
diff --git a/src/Psl/IO/Stream/CloseSeekReadWriteHandle.php b/src/Psl/IO/Stream/CloseSeekReadWriteHandle.php
@@ -10,12 +10,12 @@
 /**
  * @codeCoverageIgnore
  */
-final class CloseSeekReadWriteHandle implements IO\CloseSeekReadWriteHandleInterface
+final class CloseSeekReadWriteHandle implements CloseSeekReadWriteHandleInterface
 {
     use IO\ReadHandleConvenienceMethodsTrait;
     use IO\WriteHandleConvenienceMethodsTrait;
 
-    private IO\CloseSeekReadWriteHandleInterface $handle;
+    private CloseSeekReadWriteHandleInterface $handle;
 
     /**
      * @param resource|object $stream
@@ -80,4 +80,12 @@ public function close(): void
     {
         $this->handle->close();
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getStream(): mixed
+    {
+        return $this->handle->getStream();
+    }
 }
diff --git a/src/Psl/IO/Stream/CloseSeekReadWriteHandleInterface.php b/src/Psl/IO/Stream/CloseSeekReadWriteHandleInterface.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psl\IO\Stream;
+
+use Psl\IO;
+
+interface CloseSeekReadWriteHandleInterface extends
+    CloseReadWriteHandleInterface,
+    CloseSeekReadHandleInterface,
+    CloseSeekWriteHandleInterface,
+    IO\CloseSeekReadWriteHandleInterface,
+    SeekReadWriteHandleInterface
+{
+}
diff --git a/src/Psl/IO/Stream/CloseSeekWriteHandle.php b/src/Psl/IO/Stream/CloseSeekWriteHandle.php
@@ -10,11 +10,11 @@
 /**
  * @codeCoverageIgnore
  */
-final class CloseSeekWriteHandle implements IO\CloseSeekWriteHandleInterface
+final class CloseSeekWriteHandle implements CloseSeekWriteHandleInterface
 {
     use IO\WriteHandleConvenienceMethodsTrait;
 
-    private IO\CloseSeekReadWriteHandleInterface $handle;
+    private CloseSeekWriteHandleInterface $handle;
 
     /**
      * @param resource|object $stream
@@ -63,4 +63,12 @@ public function close(): void
     {
         $this->handle->close();
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getStream(): mixed
+    {
+        return $this->handle->getStream();
+    }
 }