Details

Reviewers

Commits

rKOTb418fdefd1b0: Introduce Result class with Ok and Err types for status handling
rKERUALD8b2b9129c247: Introduce Result class with Ok and Err types for status handling

Summary

This change adds a Result class to improve error and success handling.

Inspired by Rust generic type Result, this approach allows functions to return
either an Ok type for successful outcomes or an Err type for errors.

In PHP, where generics and enums are not natively available, Result serves
as a base class with two implementations:

Err for exceptions
Ok for successful values

This pattern provides a more structured and readable way to handle
results and errors explicitly compared to traditional exception handling.

Reference:
https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html

Test Plan

Implement in Zed story engine

Diff Detail

Repository

rKERUALD Keruald libraries development repository

Lint

Lint Warnings

Severity	Location	Code	Message
Warning	omnitools/src/DataTypes/Result/Err.php:41	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/src/DataTypes/Result/Ok.php:65	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/src/DataTypes/Result/Ok.php:69	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/tests/DataTypes/Result/ErrTest.php:43	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.Found	Generic.CodeAnalysis.UnusedFunctionParameter.Found
Warning	omnitools/tests/DataTypes/Result/OkTest.php:51	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.Found	Generic.CodeAnalysis.UnusedFunctionParameter.Found

Unit

Tests Passed

Branch

Result

Build Status

Buildable 5698
Build 5980: arc lint + arc unit

Event Timeline

dereckson requested review of this revision.Sep 2 2018, 00:02

dereckson created this revision.

Harbormaster completed remote builds in B2601: Diff 4230.Sep 2 2018, 00:02

Some ideas to make this code more useful:

a constructor to allow new Ok(42)
implement map methods:
- or_else(defaultValue) -> return defaultValue for Err, $this->value for Ok
- map() -> no op for Err, change value allowing type mutability for Value
- map_err() -> no op for Value, change value allowing any Exception for Err

dereckson planned changes to this revision.Jan 21 2020, 12:59

dereckson edited the summary of this revision. (Show Details)Jan 23 2022, 20:40

In PHP 8.1, could be interesting to do this:

Result sample use

use Keruald\OmniTools\DataTypes\Result;
use Keruald\OmniTools\DataTypes\ResultShape;

#[ResultShape(string, string)]
function doSomething() : Result {
    return ...;
}

$result = match (doSomething()) {
    $result->isOk() => $result->getValue(),
    default => throw new RuntimeException($result->getError()),
};

For this to work, we need two things:

Declare getError() in Result too
A ResultShape attribute to be able to typehint the Result

dereckson edited the summary of this revision. (Show Details)Mon, Nov 11, 13:02

Moved to keruald monorepo and rebased.

Harbormaster completed remote builds in B5692: Diff 9236.Mon, Nov 11, 13:58

dereckson retitled this revision from Implement a similar datatype than Rust result to Introduce Result class with Ok and Err types for status handling.Mon, Nov 11, 13:59