Merge pull request #20 from Innmind/no-discard

Add `NoDiscard` attributes

Author: Baptouuuu

psalm.xml

@@ -14,4 +14,7 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+    <issueHandlers>
+        <UndefinedAttributeClass errorLevel="suppress" />
+    </issueHandlers>
 </psalm>

src/EnvironmentPath.php

@@ -16,11 +16,13 @@ private function __construct(
     /**
      * @psalm-pure
      */
+    #[\NoDiscard]
     public static function of(string $value): self
     {
         return new self($value);
     }
 
+    #[\NoDiscard]
     public function toString(): string
     {
         return $this->value;

src/Server.php

@@ -27,6 +27,7 @@ private function __construct(
     ) {
     }
 
+    #[\NoDiscard]
     public static function osx(
         Clock $clock,
         Control $control,
@@ -35,13 +36,15 @@ public static function osx(
         return new self(OSX::of($clock, $control, $path));
     }
 
+    #[\NoDiscard]
     public static function linux(
         Clock $clock,
         Control $control,
     ): self {
         return new self(Linux::of($clock, $control));
     }
 
+    #[\NoDiscard]
     public static function logger(self $server, LoggerInterface $logger): self
     {
         return new self(Logger::of(
@@ -53,6 +56,7 @@ public static function logger(self $server, LoggerInterface $logger): self
     /**
      * @return Attempt<Cpu>
      */
+    #[\NoDiscard]
     public function cpu(): Attempt
     {
         return $this->implementation->cpu();
@@ -61,11 +65,13 @@ public function cpu(): Attempt
     /**
      * @return Attempt<Memory>
      */
+    #[\NoDiscard]
     public function memory(): Attempt
     {
         return $this->implementation->memory();
     }
 
+    #[\NoDiscard]
     public function processes(): Processes
     {
         return $this->implementation->processes();
@@ -74,16 +80,19 @@ public function processes(): Processes
     /**
      * @return Attempt<LoadAverage>
      */
+    #[\NoDiscard]
     public function loadAverage(): Attempt
     {
         return $this->implementation->loadAverage();
     }
 
+    #[\NoDiscard]
     public function disk(): Disk
     {
         return $this->implementation->disk();
     }
 
+    #[\NoDiscard]
     public function tmp(): Path
     {
         return Path::of(\rtrim(\sys_get_temp_dir(), '/').'/');

src/Server/Cpu.php

@@ -34,26 +34,31 @@ public static function of(
         return new self($user, $system, $idle, $cores);
     }
 
+    #[\NoDiscard]
     public function user(): Percentage
     {
         return $this->user;
     }
 
+    #[\NoDiscard]
     public function system(): Percentage
     {
         return $this->system;
     }
 
+    #[\NoDiscard]
     public function idle(): Percentage
     {
         return $this->idle;
     }
 
+    #[\NoDiscard]
     public function cores(): Cores
     {
         return $this->cores;
     }
 
+    #[\NoDiscard]
     public function toString(): string
     {
         return \sprintf(

src/Server/Cpu/Cores.php

@@ -30,11 +30,13 @@ public static function of(int $value): self
     /**
      * @return int<1, max>
      */
+    #[\NoDiscard]
     public function toInt(): int
     {
         return $this->value;
     }
 
+    #[\NoDiscard]
     public function toString(): string
     {
         return (string) $this->value;

src/Server/Cpu/Percentage.php

@@ -31,11 +31,13 @@ public static function maybe(float $value): Maybe
         return Maybe::just(new self($value));
     }
 
+    #[\NoDiscard]
     public function toFloat(): float
     {
         return $this->value;
     }
 
+    #[\NoDiscard]
     public function toString(): string
     {
         return \sprintf(

src/Server/Disk.php

@@ -46,6 +46,7 @@ public static function logger(self $disk, LoggerInterface $logger): self
     /**
      * @return Sequence<Volume>
      */
+    #[\NoDiscard]
     public function volumes(): Sequence
     {
         return $this->implementation->volumes();
@@ -54,6 +55,7 @@ public function volumes(): Sequence
     /**
      * @return Maybe<Volume>
      */
+    #[\NoDiscard]
     public function get(MountPoint $point): Maybe
     {
         return $this->implementation->get($point);

src/Server/Disk/Volume.php

@@ -37,26 +37,31 @@ public static function of(
         return new self($mountPoint, $size, $available, $used, $usage);
     }
 
+    #[\NoDiscard]
     public function mountPoint(): MountPoint
     {
         return $this->mountPoint;
     }
 
+    #[\NoDiscard]
     public function size(): Bytes
     {
         return $this->size;
     }
 
+    #[\NoDiscard]
     public function available(): Bytes
     {
         return $this->available;
     }
 
+    #[\NoDiscard]
     public function used(): Bytes
     {
         return $this->used;
     }
 
+    #[\NoDiscard]
     public function usage(): Usage
     {
         return $this->usage;

src/Server/Disk/Volume/MountPoint.php

@@ -27,11 +27,13 @@ public static function of(string $value): self
         return new self($value);
     }
 
+    #[\NoDiscard]
     public function equals(self $point): bool
     {
         return $point->is($this->value);
     }
 
+    #[\NoDiscard]
     public function is(string $point): bool
     {
         return $this->value === $point;
@@ -40,6 +42,7 @@ public function is(string $point): bool
     /**
      * @return non-empty-string
      */
+    #[\NoDiscard]
     public function toString(): string
     {
         return $this->value;

src/Server/Disk/Volume/Usage.php

@@ -31,11 +31,13 @@ public static function maybe(float $value): Maybe
         return Maybe::just(new self($value));
     }
 
+    #[\NoDiscard]
     public function toFloat(): float
     {
         return $this->value;
     }
 
+    #[\NoDiscard]
     public function toString(): string
     {
         return \sprintf(