navigation

Outcome 2.0 library

Outcome is a set of tools for reporting and handling function failures in contexts where using C++ exception handling is unsuitable. Such contexts include:

  • programs, or parts thereof, that are compiled with exceptions disabled;

  • parts of program that have a lot of branches depending on types of failures, where if-statements are cleaner than try-catch blocks;

  • requirement that failure path of execution should not cost more than the successful path of execution;

  • situations, like in filesystem library, where the decision whether the failure should be handled remotely (use exceptions) or locally cannot be made inside the function and needs to be moved onto the caller, and in the latter case launching stack unwinding is not desireable for the aforementioned reasons;

  • parts of the programs/frameworks that themselves implement exception handling and prefer to not use exceptions to propagate failure reports across thread, tasks, fibers;

  • propagating exceptions trough layers that do not implement exception throw safety;

  • external requirement (such as company-wide policy) that failure handling paths are explicitly indicated in the code.

Outcome addresses failure handling through returning a special type form functions, which is able to store either a succesfully computed value (or void) or the information about failure. Outcome also comes with a set of idioms for dealing with such types.

Sample usage

One of the tools in the Outcome library is result<T>: it represents either a succesfully computed value of type T or an std::error_code representing the reason for failure. You use it in the function’s return type:


auto read_data_from_file(string_view path) noexcept
  -> outcome::result<string>;
View this code on Github

It is possible to inspect the state manualy:


if (auto rslt = read_data_from_file("config.cfg"))
  use_string(rslt.value());                   // returns string
else
  throw LibError{rslt.error(), "config.cfg"}; // returns error_code
View this code on Github

Or, if this function is called in anoter function that also returns result<T> you can use a dedicated control statement:


auto process(const string& content) noexcept
  -> outcome::result<int>;

auto get_int_from_file(string_view path) noexcept
  -> outcome::result<int>
{
  OUTCOME_TRY(str, (read_data_from_file(path)));
  // if control gets here read_data_from_file() has succeeded
  return process(str);  // decltype(str) == string
}
View this code on Github

OUTCOME_TRY is a control statement. If the returned result<T> contains an error information, the enclosing function is immediatelly returned with result<U> containing the same failure information; otherwise object of type T is move-constructed on the stack.

This is the v2 Outcome designed in response to feedback from a Boost peer review held in May 2017. This library has successfully passed the second Boost peer review, and is currently expected to become part of the Boost official release distribution before the 1.69 release.