expected.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2022 Kitsune Ral <Kitsune-Ral@users.sf.net>
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <variant>
#include "util.h"
 
namespace Quotient {
 
//! \brief A minimal subset of std::expected from C++23
template <typename T, typename E>
    requires (!std::is_same_v<T, E>)
class Expected {
private:
    template <typename X>
    static constexpr auto is_constructible_v =
        std::is_constructible_v<T, X> || std::is_constructible_v<E, X>;
 
public:
    using value_type = T;
    using error_type = E;
 
    Expected() = default;
    Expected(const Expected&) = default;
    Expected(Expected&&) noexcept = default;
    ~Expected() = default;
 
    template <typename X>
        requires is_constructible_v<X>
    QUO_IMPLICIT Expected(X&& x) // NOLINT(google-explicit-constructor)
        : data(std::forward<X>(x))
    {}
 
    Expected& operator=(const Expected&) = default;
    Expected& operator=(Expected&&) noexcept = default;
 
    template <typename X>
        requires is_constructible_v<X>
    Expected& operator=(X&& x)
    {
        data = std::forward<X>(x);
        return *this;
    }
 
    bool has_value() const { return std::holds_alternative<T>(data); }
    explicit operator bool() const { return has_value(); }
 
    const value_type& value() const& { return std::get<T>(data); }
    value_type& value() & { return std::get<T>(data); }
    value_type value() && { return std::get<T>(std::move(data)); }
 
    const value_type& operator*() const& { return value(); }
    value_type& operator*() & { return value(); }
 
    const value_type* operator->() const& { return std::get_if<T>(&data); }
    value_type* operator->() & { return std::get_if<T>(&data); }
 
    template <class U>
    const T& value_or(const U& fallback) const&
    {
        if (has_value())
            return value();
        return fallback;
    }
    template <class U>
    T&& value_or(U&& fallback) &&
    {
        if (has_value())
            return std::move(value());
        return std::forward<U>(fallback);
    }
 
    T&& move_value_or(T&& fallback)
    {
        if (has_value())
            return std::move(value());
        return std::move(fallback);
    }
 
    const E& error() const& { return std::get<E>(data); }
    E& error() & { return std::get<E>(data); }
 
private:
    std::variant<T, E> data;
};
 
} // namespace Quotient