1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
|
#ifndef RFL_RESULT_HPP_
#define RFL_RESULT_HPP_
#ifdef REFLECTCPP_USE_STD_EXPECTED
#include <expected>
#endif
#include <algorithm>
#include <array>
#include <functional>
#include <iostream>
#include <new>
#include <optional>
#include <stdexcept>
#include <string>
#include <type_traits>
namespace rfl {
/// Defines the error class to be returned when something went wrong
class Error {
public:
Error(const std::string& _what) : what_(_what) {}
Error(const Error& e) = default;
Error& operator=(const Error&) = default;
/// Returns the error message, equivalent to .what() in std::exception.
const std::string& what() const { return what_; }
private:
/// Documents what went wrong
std::string what_;
};
/// To be returned when there is nothing to return, but there might be an error.
struct Nothing {};
/// This implementation is for cases where std::expected is defined
#ifdef REFLECTCPP_USE_STD_EXPECTED
template <class E>
using Unexpected = std::unexpected<E>;
template <class T>
using Result = std::expected<T, rfl::Error>;
/// This implementation is for cases where std::expected is not defined
#else // REFLECTCPP_USE_STD_EXPECTED
template <class E>
struct Unexpected {
Unexpected(E&& _err) : err_{std::forward<E>(_err)} {}
Unexpected(const E& _err) : err_{_err} {}
Unexpected(Unexpected&&) = default;
Unexpected(const Unexpected&) = default;
Unexpected& operator=(Unexpected&&) = default;
Unexpected& operator=(const Unexpected&) = default;
const E& error() const& { return err_; }
E&& error() && { return std::move(err_); }
E& error() & { return err_; }
private:
E err_;
};
/// The Result class is used for monadic error handling.
template <class T>
class Result {
static_assert(!std::is_same<T, Error>(), "The result type cannot be Error.");
using TOrErr = std::array<unsigned char, std::max(sizeof(T), sizeof(Error))>;
public:
// using Type = T;
using value_type = T;
using error_type = rfl::Error;
Result(const T& _val) : success_(true) { new (&get_t()) T(_val); }
Result(T&& _val) noexcept : success_(true) {
new (&get_t()) T(std::move(_val));
}
Result(const Unexpected<Error>& _err) : success_(false) {
new (&get_err()) Error(_err.error());
}
Result(Unexpected<Error>&& _err) : success_(false) {
new (&get_err()) Error(std::move(_err.error()));
}
// Result(Error&& _err) noexcept : success_(false) {
// new (&get_err()) Error(std::move(_err));
// }
Result(Result<T>&& _other) noexcept : success_(_other.success_) {
move_from_other(_other);
}
Result(const Result<T>& _other) : success_(_other.success_) {
copy_from_other(_other);
}
template <class U, typename std::enable_if<std::is_convertible_v<U, T>,
bool>::type = true>
Result(Result<U>&& _other) : success_(_other && true) {
auto temp = std::forward<Result<U> >(_other).transform(
[](U&& _u) { return T(std::forward<U>(_u)); });
move_from_other(temp);
}
template <class U, typename std::enable_if<std::is_convertible_v<U, T>,
bool>::type = true>
Result(const Result<U>& _other) : success_(_other && true) {
auto temp = _other.transform([](const U& _u) { return T(_u); });
move_from_other(temp);
}
~Result() { destroy(); }
/// Monadic operation - F must be a function of type T -> Result<U>.
template <class F>
auto and_then(const F& _f) {
/// Result_U is expected to be of type Result<U>.
using Result_U = typename std::invoke_result<F, T>::type;
if (success_) {
return Result_U(_f(std::forward<T>(get_t())));
} else {
return Result_U(std::forward<Error>(get_err()));
}
}
/// Monadic operation - F must be a function of type T -> Result<U>.
template <class F>
auto and_then(const F& _f) const {
/// Result_U is expected to be of type Result<U>.
using Result_U = typename std::invoke_result<F, T>::type;
if (success_) {
return Result_U(_f(get_t()));
} else {
return Result_U(get_err());
}
}
/// Returns true if the result contains a value, false otherwise.
operator bool() const noexcept { return success_; }
/// Allows access to the underlying value. Careful: Will result in undefined
/// behavior, if the result contains an error.
T& operator*() noexcept { return get_t(); }
/// Allows read access to the underlying value. Careful: Will result in
/// undefined behavior, if the result contains an error.
const T& operator*() const noexcept { return get_t(); }
/// Assigns the underlying object.
Result<T>& operator=(const Result<T>& _other) {
if (this == &_other) {
return *this;
}
destroy();
success_ = _other.success_;
copy_from_other(_other);
return *this;
}
/// Assigns the underlying object.
Result<T>& operator=(Result<T>&& _other) noexcept {
if (this == &_other) {
return *this;
}
destroy();
success_ = _other.success_;
move_from_other(_other);
return *this;
}
Result<T>& operator=(Unexpected<Error>&& _err) noexcept {
destroy();
success_ = false;
new (&get_err()) Error(_err.error());
return *this;
}
Result<T>& operator=(const Unexpected<Error>& _err) noexcept {
destroy();
success_ = false;
new (&get_err()) Error(_err.error());
return *this;
}
/// Assigns the underlying object.
template <class U, typename std::enable_if<std::is_convertible_v<U, T>,
bool>::type = true>
auto& operator=(const Result<U>& _other) {
const auto to_t = [](const U& _u) -> T { return _u; };
t_or_err_ = _other.transform(to_t).t_or_err_;
return *this;
}
/// Expects a function that takes of type Error -> Result<T> and returns
/// Result<T>.
template <class F>
Result<T> or_else(const F& _f) {
if (success_) {
return std::forward<T>(get_t());
} else {
return _f(std::forward<Error>(get_err()));
}
}
/// Expects a function that takes of type Error -> Result<T> and returns
/// Result<T>.
template <class F>
Result<T> or_else(const F& _f) const {
if (success_) {
return get_t();
} else {
return _f(get_err());
}
}
/// Functor operation - F must be a function of type T -> U.
template <class F>
auto transform(const F& _f) {
/// Result_U is expected to be of type Result<U>.
using U = typename std::invoke_result<F, T>::type;
if (success_) {
return rfl::Result<U>(_f(std::forward<T>(get_t())));
} else {
return rfl::Result<U>(rfl::Unexpected(std::forward<Error>(get_err())));
}
}
/// Functor operation - F must be a function of type T -> U.
template <class F>
auto transform(const F& _f) const {
/// Result_U is expected to be of type Result<U>.
using U = typename std::invoke_result<F, T>::type;
if (success_) {
return rfl::Result<U>(_f(get_t()));
} else {
return rfl::Result<U>(get_err());
}
}
/// Returns the value if the result does not contain an error, throws an
/// exceptions if not. Similar to .unwrap() in Rust.
T& value() {
if (success_) {
return get_t();
} else {
throw std::runtime_error(get_err().what());
}
}
/// Returns the value if the result does not contain an error, throws an
/// exceptions if not. Similar to .unwrap() in Rust.
const T& value() const {
if (success_) {
return get_t();
} else {
throw std::runtime_error(get_err().what());
}
}
/// Returns the value or a default.
T value_or(T&& _default) noexcept {
if (success_) {
return std::forward<T>(get_t());
} else {
return std::forward<T>(_default);
}
}
/// Returns the value or a default.
T value_or(const T& _default) const noexcept {
if (success_) {
return get_t();
} else {
return _default;
}
}
// As specified by the standard :
// https://en.cppreference.com/w/cpp/utility/expected
// Observers
template <class G = rfl::Error>
rfl::Error error_or(G&& _default) const& {
if (success_) {
return _default;
} else {
return get_err();
}
}
template <class G = rfl::Error>
rfl::Error error_or(G&& _default) && {
if (success_) {
return _default;
} else {
return get_err();
}
}
bool has_value() const noexcept { return success_; }
const Error& error() const& {
if (success_) throw std::runtime_error("Expected does not contain value");
return get_err();
}
Error& error() & {
if (success_) throw std::runtime_error("Expected does not contain value");
return get_err();
}
T* operator->() noexcept { return &get_t(); }
const T* operator->() const noexcept { return &get_t(); }
template <class F>
rfl::Result<T> transform_error(F&& f) && {
static_assert(
std::is_same<std::invoke_result_t<F, rfl::Error>, rfl::Error>(),
"A function passed to transform_error must return an error.");
if (!has_value()) {
return rfl::Result<T>{std::invoke(f, std::move(get_err()))};
} else {
return rfl::Result<T>{std::move(value())};
}
}
template <class F>
rfl::Result<T> transform_error(F&& f) const& {
static_assert(
std::is_same<std::invoke_result_t<F, rfl::Error>, rfl::Error>(),
"A function passed to transform_error must return an error.");
if (!has_value()) {
return rfl::Result<T>{std::invoke(f, get_err())};
} else {
return rfl::Result<T>{value()};
}
}
private:
void copy_from_other(const Result<T>& _other) {
if (success_) {
new (&get_t()) T(_other.get_t());
} else {
new (&get_err()) Error(_other.get_err());
}
}
void destroy() {
if (success_) {
if constexpr (std::is_destructible_v<std::remove_cv_t<T> >) {
get_t().~T();
}
} else {
get_err().~Error();
}
}
T& get_t() noexcept {
return *std::launder(reinterpret_cast<T*>(t_or_err_.data()));
}
const T& get_t() const noexcept {
return *std::launder(reinterpret_cast<const T*>(t_or_err_.data()));
}
Error& get_err() noexcept {
return *std::launder(reinterpret_cast<Error*>(t_or_err_.data()));
}
const Error& get_err() const noexcept {
return *std::launder(reinterpret_cast<const Error*>(t_or_err_.data()));
}
void move_from_other(Result<T>& _other) noexcept {
if (success_) {
new (&get_t()) T(std::move(_other.get_t()));
} else {
new (&get_err()) Error(std::move(_other.get_err()));
}
}
/// Signifies whether this was a success.
bool success_;
/// The underlying data, can either be T or Error.
alignas(std::max(alignof(T), alignof(Error))) TOrErr t_or_err_;
};
#endif
/// Shorthand for unexpected error.
inline Unexpected<Error> error(const std::string& _what) {
return Unexpected<Error>(Error(_what));
}
/// Shorthand for unexpected error.
inline Unexpected<Error> error(const Error& _err) {
return Unexpected<Error>(_err);
}
} // namespace rfl
#endif
|