Add NoDiscard attributes

psalm.xml

@@ -17,4 +17,7 @@
     <disableExtensions>
         <extension name="random" />
     </disableExtensions>
+    <issueHandlers>
+        <UndefinedAttributeClass errorLevel="suppress" />
+    </issueHandlers>
 </psalm>

src/Files.php

@@ -31,16 +31,19 @@ private function __construct(
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function of(Capabilities $capabilities): self
     {
         return new self($capabilities);
     }
 
+    #[\NoDiscard]
     public function read(Path $path): Read
     {
         return Read::of($this->capabilities, $path);
     }
 
+    #[\NoDiscard]
     public function write(Path $path): Write
     {
         return Write::of($this->capabilities, $path);
@@ -49,6 +52,7 @@ public function write(Path $path): Write
     /**
      * @return Maybe<mixed>
      */
+    #[\NoDiscard]
     public function require(Path $path): Maybe
     {
         return $this->capabilities->files()->require($path);
@@ -59,6 +63,7 @@ public function require(Path $path): Maybe
      *
      * @return Attempt<Temporary>
      */
+    #[\NoDiscard]
     public function temporary(Sequence $chunks): Attempt
     {
         $capabilities = $this->capabilities;
@@ -77,6 +82,7 @@ public function temporary(Sequence $chunks): Attempt
     /**
      * @return Attempt<File|Directory|Link>
      */
+    #[\NoDiscard]
     public function access(Path $path): Attempt
     {
         return $this
@@ -93,6 +99,7 @@ public function access(Path $path): Attempt
     /**
      * @return Attempt<File|Directory>
      */
+    #[\NoDiscard]
     public function create(Path $path): Attempt
     {
         return $this
@@ -105,6 +112,7 @@ public function create(Path $path): Attempt
             });
     }
 
+    #[\NoDiscard]
     public function exists(Path $path): bool
     {
         return $this->capabilities->files()->exists($path);

src/Files/Directory.php

@@ -22,6 +22,7 @@ private function __construct(
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function of(
         Capabilities $capabilities,
         Path $path,
@@ -36,6 +37,7 @@ public static function of(
     /**
      * @return Sequence<Name>
      */
+    #[\NoDiscard]
     public function list(): Sequence
     {
         return $this
@@ -47,6 +49,7 @@ public function list(): Sequence
     /**
      * @return Attempt<SideEffect>
      */
+    #[\NoDiscard]
     public function remove(): Attempt
     {
         return $this

src/Files/File.php

@@ -21,18 +21,21 @@ private function __construct(
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function of(
         Capabilities $capabilities,
         Path $path,
     ): self {
         return new self($capabilities, $path);
     }
 
+    #[\NoDiscard]
     public function read(): Read
     {
         return Read::of($this->capabilities, $this->path);
     }
 
+    #[\NoDiscard]
     public function write(): Write
     {
         return Write::of($this->capabilities, $this->path);
@@ -41,6 +44,7 @@ public function write(): Write
     /**
      * @return Attempt<SideEffect>
      */
+    #[\NoDiscard]
     public function remove(): Attempt
     {
         return $this
@@ -52,6 +56,7 @@ public function remove(): Attempt
     /**
      * @return Attempt<string>
      */
+    #[\NoDiscard]
     public function mediaType(): Attempt
     {
         return $this

src/Files/Name.php

@@ -22,11 +22,13 @@ private function __construct(
      *
      * @param non-empty-string $name
      */
+    #[\NoDiscard]
     public static function of(string $name, Kind $kind): self
     {
         return new self($name, $kind);
     }
 
+    #[\NoDiscard]
     public function kind(): Kind
     {
         return $this->kind;
@@ -35,6 +37,7 @@ public function kind(): Kind
     /**
      * @return non-empty-string
      */
+    #[\NoDiscard]
     public function toString(): string
     {
         return $this->name;

src/Files/Read.php

@@ -34,6 +34,7 @@ private function __construct(
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function of(
         Capabilities $capabilities,
         Path $path,
@@ -55,6 +56,7 @@ public static function of(
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function temporary(
         Capabilities $capabilities,
         Internal\Stream $stream,
@@ -73,6 +75,7 @@ public static function temporary(
     /**
      * @psalm-mutation-free
      */
+    #[\NoDiscard]
     public function toEncoding(Str\Encoding $encoding): self
     {
         return new self(
@@ -91,6 +94,7 @@ public function toEncoding(Str\Encoding $encoding): self
      *
      * @psalm-mutation-free
      */
+    #[\NoDiscard]
     public function watch(): self
     {
         return new self(
@@ -104,6 +108,7 @@ public function watch(): self
     /**
      * @return Maybe<Size>
      */
+    #[\NoDiscard]
     public function size(): Maybe
     {
         return ($this->load)()->size();
@@ -114,6 +119,7 @@ public function size(): Maybe
      *
      * @return Sequence<Str>
      */
+    #[\NoDiscard]
     public function chunks(int $size): Sequence
     {
         $load = $this->load;
@@ -167,6 +173,7 @@ public function chunks(int $size): Sequence
     /**
      * @return Sequence<Str>
      */
+    #[\NoDiscard]
     public function lines(): Sequence
     {
         $load = $this->load;

src/Files/Temporary.php

@@ -25,6 +25,7 @@ private function __construct(
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function of(
         Capabilities $capabilities,
         Internal\Stream $stream,
@@ -38,11 +39,13 @@ public static function of(
      *
      * @internal
      */
+    #[\NoDiscard]
     public function internal(): Internal\Stream
     {
         return $this->stream;
     }
 
+    #[\NoDiscard]
     public function read(): Read
     {
         return Read::temporary($this->capabilities, $this->stream);
@@ -51,13 +54,15 @@ public function read(): Read
     /**
      * @return Attempt<Pull>
      */
+    #[\NoDiscard]
     public function pull(): Attempt
     {
         return $this->stream->rewind()->map(
             fn() => Pull::of($this->capabilities, $this->stream),
         );
     }
 
+    #[\NoDiscard]
     public function push(): Push
     {
         return Push::of($this->capabilities, $this->stream);
@@ -66,6 +71,7 @@ public function push(): Push
     /**
      * @return Attempt<SideEffect>
      */
+    #[\NoDiscard]
     public function close(): Attempt
     {
         return $this->stream->close();

src/Files/Temporary/Pull.php

@@ -30,6 +30,7 @@ private function __construct(
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function of(
         Capabilities $capabilities,
         Internal\Stream $stream,
@@ -47,6 +48,7 @@ public static function of(
     /**
      * @psalm-mutation-free
      */
+    #[\NoDiscard]
     public function toEncoding(Str\Encoding $encoding): self
     {
         return new self(
@@ -64,6 +66,7 @@ public function toEncoding(Str\Encoding $encoding): self
      *
      * @psalm-mutation-free
      */
+    #[\NoDiscard]
     public function watch(): self
     {
         return new self(
@@ -76,6 +79,7 @@ public function watch(): self
     /**
      * @return Maybe<Size>
      */
+    #[\NoDiscard]
     public function size(): Maybe
     {
         return $this->stream->size();
@@ -86,6 +90,7 @@ public function size(): Maybe
      *
      * @return Attempt<Str>
      */
+    #[\NoDiscard]
     public function chunk(int $size): Attempt
     {
         $stream = $this->stream;

src/Files/Temporary/Push.php

@@ -25,6 +25,7 @@ private function __construct(
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function of(
         Capabilities $capabilities,
         Internal\Stream $stream,
@@ -43,6 +44,7 @@ public static function of(
      *
      * @psalm-mutation-free
      */
+    #[\NoDiscard]
     public function watch(): self
     {
         return new self(
@@ -54,6 +56,7 @@ public function watch(): self
     /**
      * @return Attempt<SideEffect>
      */
+    #[\NoDiscard]
     public function chunk(Str $chunk): Attempt
     {
         $stream = $this->stream;

src/Files/Write.php

@@ -35,6 +35,7 @@ private function __construct(
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function of(Capabilities $capabilities, Path $path): self
     {
         return new self(
@@ -51,6 +52,7 @@ public static function of(Capabilities $capabilities, Path $path): self
     /**
      * @internal
      */
+    #[\NoDiscard]
     public static function temporary(
         Capabilities $capabilities,
         Internal\Stream $stream,
@@ -71,6 +73,7 @@ public static function temporary(
      *
      * @psalm-mutation-free
      */
+    #[\NoDiscard]
     public function watch(): self
     {
         return new self(
@@ -86,6 +89,7 @@ public function watch(): self
      *
      * @return Attempt<SideEffect>
      */
+    #[\NoDiscard]
     public function sink(Sequence $chunks): Attempt
     {
         $stream = ($this->load)();