{"id":31951,"date":"2023-04-18T18:53:41","date_gmt":"2023-04-18T18:53:41","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/cppblog\/?p=31951"},"modified":"2023-04-18T18:53:41","modified_gmt":"2023-04-18T18:53:41","slug":"cpp23s-optional-and-expected","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/cppblog\/cpp23s-optional-and-expected\/","title":{"rendered":"Functional exception-less error handling with C++23’s optional and expected"},"content":{"rendered":"

This post is an updated version of one I made over five years ago<\/a>, now that everything I talked about is in the standard and implemented in Visual Studio.<\/em><\/p>\n

In software things can go wrong. Sometimes we might expect them to go wrong. Sometimes it’s a surprise. In most cases we want to build in some way of handling these misfortunes. Let’s call them disappointments<\/a>.<\/p>\n

std::optional<\/code> was added in C++17<\/a> to provide a new standard way of expressing disappointments and more, and it has been extended in C++23 with a new interface inspired by functional programming<\/a>.<\/p>\n

std::optional<T><\/code> expresses “either a T<\/code> or nothing”. C++23 comes with a new type, std::expected<T,E><\/code><\/a> which expresses “either the expected T<\/code>, or some E<\/code> telling you what went wrong”. This type also comes with that special new functional interface<\/a>. As of Visual Studio 2022 version 17.6 Preview 3<\/a>, all of these features are available in our standard library. Armed with an STL implementation you can try yourself, I’m going to exhibit how to use std::optional<\/code>‘s new interface, and the new std::expected<\/code> to handle disappointments.<\/p>\n

One way to express and handle disappointments is exceptions:<\/p>\n

void pet_cat() {\r\n    try {\r\n        auto cat = find_cat();\r\n        scratch_behind_ears(cat);\r\n    }\r\n    catch (const no_cat_found& err) {\r\n        \/\/oh no\r\n        be_sad();\r\n    }\r\n}<\/code><\/pre>\n
There are a myriad of discussions, resources, rants, tirades, and debates about the value of exceptions1<\/a>2<\/a>3<\/a>4<\/a>5<\/a>6<\/a><\/sup>, and I will not repeat them here. Suffice to say that there are cases in which exceptions are not the best tool for the job. For the sake of being uncontroversial, I’ll take the example of disappointments which are expected within reasonable use of an API.<\/p>\n
The Internet loves cats. Suppose that you and I are involved in the business of producing the cutest images of cats the world has ever seen. We have produced a high-quality C++ library geared towards this sole aim, and we want it to be at the bleeding edge of modern C++.<\/p>\n
A common operation in feline cutification programs is to locate cats in a given image. How should we express this in our API? One option is exceptions:<\/p>\n
\/\/ Throws no_cat_found if a cat is not found.\r\nimage_view find_cat (image_view img);<\/code><\/pre>\n
This function takes a view of an image and returns a smaller view which contains the first cat it finds. If it does not find a cat, then it throws an exception. If we’re going to be giving this function a million images, half of which do not contain cats, then that’s a lot<\/em> of exceptions being thrown. In fact, we’re pretty much using exceptions for control flow at that point, which is A Bad Thing<\/a>\u2122.<\/p>\n
What we really want to express is a function which either returns a cat if it finds one, or it returns nothing. Enter std::optional<\/code>.<\/p>\n
std::optional<image_view> find_cat (image_view img);<\/code><\/pre>\n
std::optional<\/code><\/a> was introduced in C++17 for representing a value which may or may not be present. It is intended to be a vocabulary type — i.e. the canonical choice for expressing some concept in your code. The difference between this signature and the previous one is powerful; we’ve moved the description of what happens on an error from the documentation into the type system. Now it’s impossible for the user to forget to read the docs, because the compiler is reading them for us, and you can be sure that it’ll shout at you if you use the type incorrectly.<\/p>\n
Now we’re ready to use our find_cat<\/code> function along with some other friends from our library to make embarrassingly adorable pictures of cats:<\/p>\n
std::optional<image_view> get_cute_cat (image_view img) {\r\n    auto cropped = find_cat(img);\r\n    if (!cropped) {\r\n      return std::nullopt;\r\n    }\r\n\r\n    auto with_tie = add_bow_tie(*cropped);\r\n    if (!with_tie) {\r\n      return std::nullopt;\r\n    }\r\n\r\n    auto with_sparkles = make_eyes_sparkle(*with_tie);\r\n    if (!with_sparkles) {\r\n      return std::nullopt;\r\n    }\r\n\r\n    return add_rainbow(make_smaller(*with_sparkles));\r\n}<\/code><\/pre>\n
Well this is… okay. The user is made to explicitly handle what happens in case of an error, so they can’t forget about it, which is good. But there are two issues with this:<\/p>\n
    \n
  1. There’s no information about why<\/em> the operations failed.<\/li>\n
  2. There’s too much noise; error handling dominates the logic of the code.<\/li>\n<\/ol>\n
    I’ll address these two points in turn.<\/p>\n
    Why did something fail?<\/h3>\n
    std::optional<\/code> is great for expressing that some operation produced no value, but it gives us no information to help us understand why this occurred; we’re left to use whatever context we have available, or (please, no) output parameters. What we want is a type which either contains a value, or contains some information about why the value isn’t there. This is called std::expected<\/code>.<\/p>\n
    With std::expected<\/code> our code might look like this:<\/p>\n
    std::expected<image_view, error_code> get_cute_cat (image_view img) {\r\n    auto cropped = find_cat(img);\r\n    if (!cropped) {\r\n      return no_cat_found;\r\n    }\r\n\r\n    auto with_tie = add_bow_tie(*cropped);\r\n    if (!with_tie) {\r\n      return cannot_see_neck;\r\n    }\r\n\r\n    auto with_sparkles = make_eyes_sparkle(*with_tie);\r\n    if (!with_sparkles) {\r\n      return cat_has_eyes_shut;\r\n    }\r\n\r\n    return add_rainbow(make_smaller(*with_sparkles));\r\n}<\/code><\/pre>\n
    Now when we call get_cute_cat<\/code> and don’t get a lovely image back, we have some useful information to report to the user as to why we got into this situation.<\/p>\n
    Noisy error handling<\/h3>\n
    Unfortunately, with both the std::optional<\/code> and std::expected<\/code> versions, there’s still a lot of noise. This is a disappointing solution to handling disappointments.<\/p>\n
    What we really want is a way to express the operations we want to carry out while pushing the disappointment handling off to the side. As is becoming increasingly trendy in the world of C++, we’ll look to the world of functional programming for help. In this case, the help comes in the form of transform<\/code> and and_then<\/code>.<\/p>\n
    If we have some std::optional<\/code> and we want to carry out some operation on it if and only if there’s a value stored, then we can use transform<\/code>:<\/p>\n
    cat make_cuter(cat);\r\n\r\nstd::optional<cat> result = maybe_get_cat().transform(make_cuter);\r\n\/\/use result<\/code><\/pre>\n
    This code is roughly equivalent to:<\/p>\n
    cat make_cuter(cat);\r\n\r\nauto opt_cat = maybe_get_cat();\r\nif (opt_cat) {\r\n   cat result = make_cuter(*opt_cat);\r\n   \/\/use result\r\n}<\/code><\/pre>\n
    If we want to carry out some operation which could itself fail<\/em> then we can use and_then<\/code>:<\/p>\n
    std::optional<cat> maybe_make_cuter (cat);\r\n\r\nstd::optional<cat> result = maybe_get_cat().and_then(maybe_make_cuter);\r\n\/\/use result<\/code><\/pre>\n
    This code is roughly equivalent to:<\/p>\n
    std::optional<cat> maybe_make_cuter (const cat&);\r\n\r\nauto opt_cat = maybe_get_cat();\r\nif (opt_cat) {\r\n   std::optional<cat> result = maybe_make_cuter(*opt_cat);\r\n   \/\/use result\r\n}<\/code><\/pre>\n
    and_then<\/code> and transform<\/code> for expected<\/code> act in much the same way as for optional<\/code>: if there is an expected value then the given function will be called with that value, otherwise the stored unexpected value will be returned. Additionally, there is a transform_error<\/code> function which allows mapping functions over unexpected values.<\/p>\n
    The real power of these functions comes when we begin to chain operations together. Let’s look at that original get_cute_cat<\/code> implementation again:<\/p>\n
    std::optional<image_view> get_cute_cat (image_view img) {\r\n    auto cropped = find_cat(img);\r\n    if (!cropped) {\r\n      return std::nullopt;\r\n    }\r\n\r\n    auto with_tie = add_bow_tie(*cropped);\r\n    if (!with_tie) {\r\n      return std::nullopt;\r\n    }\r\n\r\n    auto with_sparkles = make_eyes_sparkle(*with_tie);\r\n    if (!with_sparkles) {\r\n      return std::nullopt;\r\n    }\r\n\r\n    return add_rainbow(make_smaller(*with_sparkles));\r\n}<\/code><\/pre>\n
    With transform<\/code> and and_then<\/code>, our code transforms into this:<\/p>\n
    std::optional<image_view> get_cute_cat (image_view img) {\r\n    return find_cat(img)\r\n           .and_then(add_bow_tie)\r\n           .and_then(make_eyes_sparkle)\r\n           .transform(make_smaller)\r\n           .transform(add_rainbow);\r\n}<\/code><\/pre>\n
    With these two functions we’ve successfully pushed the error handling off to the side, allowing us to express a series of operations which may fail without interrupting the flow of logic to test an optional<\/code>. For more discussion about this code and the equivalent exception-based code, I’d recommend reading Vittorio Romeo<\/a>‘s Why choose sum types over exceptions?<\/a> article.<\/p>\n
    A theoretical aside<\/h3>\n
    I didn’t make up transform<\/code> and and_then<\/code> off the top of my head; other languages have had equivalent features for a long time, and the theoretical concepts are common subjects in Category Theory<\/a>.<\/p>\n
    I won’t attempt to explain all the relevant concepts in this post, as others have done it far better than I could. The basic idea is that transform<\/code> comes from the concept of a functor<\/em>, and and_then<\/code> comes from monads<\/em>. These two functions are called fmap<\/code> and >>=<\/code> (bind) in Haskell. The best description of these concepts which I have read is Functors, Applicatives, And Monads In Pictures<\/a> by Aditya Bhargava. Give it a read if you’d like to learn more about these ideas.<\/p>\n
    A note on overload sets<\/h3>\n
    One use-case which is annoyingly verbose is passing overloaded functions to transform<\/code> or and_then<\/code>. For example:<\/p>\n
    cat make_cuter(cat);\r\n\r\nstd::optional<cat> c;\r\nauto cute_cat = c.transform(make_cuter);<\/code><\/pre>\n
    The above code works fine. But as soon as we add another overload to make_cuter<\/code>:<\/p>\n
    cat make_cuter(cat);\r\ndog make_cuter(dog);\r\n\r\nstd::optional<cat> c;\r\nauto cute_cat = c.transform(make_cuter);<\/code><\/pre>\n
    then it fails to compile, because it’s not clear which overload we want to pass to transform.<\/p>\n
    One solution for this is to use a generic lambda:<\/p>\n
    std::optional<cat> c;\r\nauto cute_cat = c.transform([](auto x) { return make_cuter(x); });<\/code><\/pre>\n
    Another is a LIFT<\/code> macro:<\/p>\n
    #define FWD(...) std::forward<decltype(__VA_ARGS__)>(__VA_ARGS__)\r\n#define LIFT(f) \\\r\n    [](auto&&... xs) noexcept(noexcept(f(FWD(xs)...))) -> decltype(f(FWD(xs)...)) \\\r\n    { return f(FWD(xs)...); }\r\n\r\nstd::optional<cat> c;\r\nauto cute_cat = c.transform(LIFT(make_cuter));<\/code><\/pre>\n
    Personally I hope to see overload set lifting<\/a> in some form get into the standard so that we don’t need to bother with the above solutions.<\/p>\n
    If you want to read more about specifically this problem, I have a whole blog post<\/a> on it.<\/p>\n
    Try them out<\/h3>\n
    The functional extensions to std::expected<\/code> and std::optional<\/code> are available in Visual Studio 2022 version 17.6 Preview 3<\/a>. Please try them out and let us know what you think! If you have any questions, comments, or issues with the features, you can comment below, or reach us via email at visualcpp@microsoft.com<\/a> or via Twitter at @VisualC<\/a>.<\/p>\n
    If you’re stuck on old versions of C++, I have written implementations of optional<\/code> and expected<\/code> with the functional interfaces as single-header libraries, released under the CC0<\/a> license. You can find them at tl::optional<\/code><\/a> and tl::expected<\/code><\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
    C++23’s new facilities for handling disappointments without exceptions.<\/p>\n","protected":false},"author":706,"featured_media":35994,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-31951","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-cplusplus"],"acf":[],"blog_post_summary":"
    C++23’s new facilities for handling disappointments without exceptions.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/31951","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/users\/706"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/comments?post=31951"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/31951\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media\/35994"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media?parent=31951"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/categories?post=31951"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/tags?post=31951"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}