prewk/option

Option object for PHP inspired by Rust

Maintainers

Details

github.com/prewk/option

Source

Issues

Installs: 495 672

Dependents: 2

Suggesters: 0

Security: 0

Stars: 42

Watchers: 4

Forks: 8

Open Issues: 7

4.0.0 2024-05-08 09:35 UTC

Requires

Requires (Dev)

(MIT or Apache-2.0) 98dffc5aea1975b718e77da9ec940e465bf2e20f

  • Oskar Thornblad <oskar.thornblad.woop@gmail.com>

This package is auto-updated.

Last update: 2024-11-02 08:08:33 UTC

README

A PHP implementation of Rust's Option type with roughly the same API.

Version information

Version 4.x.x requires PHP 8.1+. Make sure you match the versions for this and the Result library if you use both.

Installation

composer require prewk/option

Usage

use Prewk\Option;
use Prewk\Option\{Some, None};

function findSomething(): Option {
    // ...
    if ($foundSomething) {
        return new Some($thing);
    } else {
        return new None;
    }
}

function findSomethingElse(): Result {
    // ...
    if ($foundSomething) {
        return new Some($thing);
    } else {
        return new None;
    }
}

// Fallback to value
$value = findSomething()->unwrapOr(null);

// Fallback to option and throw an exception if both fail
$value = findSomething()->or(findSomethingElse())->unwrap();

// Throw custom exception on missing thing (None)
$value = findSomething()->expect(new Exception("Oh noes!"));

License

MIT & Apache 2.0