{"id":110516,"date":"2024-11-13T07:00:00","date_gmt":"2024-11-13T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=110516"},"modified":"2024-11-13T14:23:42","modified_gmt":"2024-11-13T22:23:42","slug":"20241113-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20241113-00\/?p=110516","title":{"rendered":"The puzzle of trying to put an object into a std::optional<\/CODE>"},"content":{"rendered":"

The C++ standard library template type std::optional<T><\/code> has one of two states. It could be empty (not contain anything), or it could contain a T<\/code>.<\/p>\n

Suppose you start with an empty std::optional<T><\/code>. How do you put a T<\/code> into it?<\/p>\n

One of my colleagues tried to do it in what seemed to be the most natural way: Use the assignment operator.<\/p>\n

struct Doodad\r\n{\r\n    Doodad();\r\n    ~Doodad();\r\n    std::unique_ptr<DoodadStuff> m_stuff;\r\n};\r\n\r\nstruct Widget\r\n{\r\n    std::optional<Doodad> m_doodad;\r\n\r\n    Widget()\r\n    {\r\n        if (doodads_enabled()) {\r\n            \/\/ I guess we need a Doodad too.\r\n            Doodad d;\r\n            m_doodad = d;\r\n        }\r\n    }\r\n};\r\n<\/pre>\n
Unfortunately, the assignment failed to compile:<\/p>\n
Widget.cpp: error C2679: binary '=': no operator found which takes a right-hand operand of type 'Doodad' (or there is no acceptable conversion)\r\n<\/pre>\n
I asked for the rest of the error message, because the details will explain what the compiler tried to do (and why it couldn’t). It’s long, but we’ll walk through it.<\/p>\n
    optional(617,1):\r\n    could be 'std::optional<Doodad> &std::optional<Doodad>::operator =(const std::optional<Doodad> &)'\r\n        Widget.cpp(100,9):\r\n        'std::optional<Doodad> &std::optional<Doodad>::operator =(const std::optional<Doodad> &)': cannot convert argument 2 from 'Doodad' to 'const std::optional<Doodad> &'\r\n            Widget.cpp(100,27):\r\n            Reason: cannot convert from 'Doodad' to 'const std::optional<Doodad>'\r\n            Widget.cpp(100,27):\r\n            No user-defined-conversion operator available that can perform this conversion, or the operator cannot be called\r\n    optional(283,28):\r\n    or       'std::optional<Doodad> &std::optional<Doodad>::operator =(std::nullopt_t) noexcept'\r\n        Widget.cpp(100,9):\r\n        'std::optional<Doodad> &std::optional<Doodad>::operator =(std::nullopt_t) noexcept': cannot convert argument 2 from 'Doodad' to 'std::nullopt_t'\r\n            Widget.cpp(100,27):\r\n            No user-defined-conversion operator available that can perform this conversion, or the operator cannot be called\r\n    optional(321,28):\r\n    or       'std::optional<Doodad> &std::optional<Doodad>::operator =(std::optional<_Ty2> &&) noexcept(<expr>)'\r\n        Widget.cpp(100,9):\r\n        'std::optional<Doodad> &std::optional<Doodad>::operator =(std::optional<_Ty2> &&) noexcept(<expr>)': could not deduce template argument for 'std::optional<_Ty2> &&' from 'Doodad'\r\n    optional(307,28):\r\n    or       'std::optional<Doodad> &std::optional<Doodad>::operator =(const std::optional<_Ty2> &) noexcept(<expr>)'\r\n        Widget.cpp(100,9):\r\n        'std::optional<Doodad> &std::optional<Doodad>::operator =(const std::optional<_Ty2> &) noexcept(<expr>)': could not deduce template argument for 'const std::optional<_Ty2> &' from 'Doodad'\r\n    optional(292,28):\r\n    or       'std::optional<Doodad> &std::optional<Doodad>::operator =(_Ty2 &&) noexcept(<expr>)'\r\n        Widget.cpp(100,9):\r\n        'std::optional<Doodad> &std::optional<Doodad>::operator =(_Ty2 &&) noexcept(<expr>)': could not deduce template argument for '__formal'\r\n            optional(288,33):\r\n            'std::enable_if_t<false,int>' : Failed to specialize alias template\r\n    Widget.cpp(100,9):\r\n    while trying to match the argument list '(std::optional<Doodad>, Doodad)'\r\n<\/pre>\n
The compiler is showing its work. It’s showing you all the possible overloaded assignment operators and explained why each one failed. The way to understand what went wrong is to look for the overload you intended to use and see why the compiler rejected it. Let’s take them one at a time.<\/p>\n
could be 'std::optional<Doodad> &std::optional<Doodad>::operator =(const std::optional<Doodad> &)'\r\n    cannot convert argument 2 from 'Doodad' to 'const std::optional<Doodad> &'\r\n    Reason: cannot convert from 'Doodad' to 'const std::optional<Doodad>'\r\n    No user-defined-conversion operator available that can perform this conversion, or the operator cannot be called\r\n<\/pre>\n
The first assignment operator available is the one where you assign a std::optional<Doodad><\/code> to another std::optional<Doodad><\/code>. This one failed because you passed a Doodad<\/code>, not a std::optional<Doodad><\/code>, and there was no eligible conversion.<\/p>\n
Okay, what’s next?<\/p>\n
or 'std::optional<Doodad> &std::optional<Doodad>::operator =(std::nullopt_t) noexcept'\r\n    'std::optional<Doodad> &std::optional<Doodad>::operator =(std::nullopt_t) noexcept': cannot convert argument 2 from 'Doodad' to 'std::nullopt_t'\r\n    No user-defined-conversion operator available that can perform this conversion, or the operator cannot be called\r\n<\/pre>\n
This is the emptying assignment, where you can assign a std::nullopt<\/code> to the optional to return it to the empty state. This is not what we wanted either, so we’re not surprised that it failed.<\/p>\n
Onward.<\/p>\n
or 'std::optional<Doodad> &std::optional<Doodad>::operator =(std::optional<_Ty2> &&) noexcept(<expr>)'\r\n    'std::optional<Doodad> &std::optional<Doodad>::operator =(std::optional<_Ty2> &&) noexcept(<expr>)': could not deduce template argument for 'std::optional<_Ty2> &&' from 'Doodad'\r\n<\/pre>\n
This is the case of move-assigning a std::optional<T2><\/code> to a std::optional<T1><\/code>. This is also not what we were trying to do, so the fact that it failed is expected.<\/p>\n
Keep going.<\/p>\n
or 'std::optional<Doodad> &std::optional<Doodad>::operator =(const std::optional<_Ty2> &) noexcept(<expr>)'\r\n    'std::optional<Doodad> &std::optional<Doodad>::operator =(const std::optional<_Ty2> &) noexcept(<expr>)': could not deduce template argument for 'const std::optional<_Ty2> &' from 'Doodad'\r\n<\/pre>\n
This is the copy-assignment version of the above, so we can skip this one, too.<\/p>\n
or 'std::optional<Doodad> &std::optional<Doodad>::operator =(_Ty2 &&) noexcept(<expr>)'\r\n    'std::optional<Doodad> &std::optional<Doodad>::operator =(_Ty2 &&) noexcept(<expr>)': could not deduce template argument for '__formal'\r\n        'std::enable_if_t<false,int>' : Failed to specialize alias template\r\n    while trying to match the argument list '(std::optional<Doodad>, Doodad)'\r\n<\/pre>\n
This is the final catch-all case of assigning an arbitrary object to an optional. This is the one we were hoping to use, but somehow it failed because of a “could not deduce template argument” from std::enable_if_t<false, int><\/code>, and that leading false<\/code> tells us that an enable_if<\/code> precondition failed.  Let’s look at the precondition<\/a>.<\/p>\n
template <class _Ty2 = _Ty,\r\n        enable_if_t<\r\n            conjunction_v<\r\n                negation<\r\n                    is_same<optional, _Remove_cvref_t<_Ty2>>\r\n                >,\r\n                negation<\r\n                    conjunction<is_scalar<_Ty>, is_same<_Ty, decay_t<_Ty2>>>\r\n                >,\r\n                is_constructible<_Ty, _Ty2>,\r\n                is_assignable<_Ty&, _Ty2>\r\n            >,\r\n            int> = 0>\r\n    _CONSTEXPR20 optional& operator=(_Ty2&& _Right) noexcept(\u27e6...\u27e7)\r\n<\/pre>\n
Let’s work on simplifying this template metaprogramming. In our case, _Ty2<\/code> is Doodad&<\/code>, so std::decay_t<_Ty2><\/code> is std::decay_t<Doodad&><\/code>, which is Doodad<\/code>. From its name, it’s highly likely that the internal template _Remove_cvref_t<\/code> is std::remove_cv_t<\/code>+std::remove_reference_t<\/code>, but if you don’t trust your intuition, you can  look it up for yourself<\/a>:<\/p>\n
template<class _Ty>\r\nusing _Remove_Cvref_t _MSVC_KNOWN_SEMANTICS = remove_cv_t<remove_reference_t<_Ty>>;\r\n<\/pre>\n
Applying it to the case where _Ty2<\/code> is Doodad&<\/code> results in remove_cv_t<remove_reference_t<Doodad&>><\/code> which is remove_cv_t<Doodad><\/code> which is just Doodad<\/code>. Plugging all that back into the enable_if<\/code>, as well as _Ty = Doodad<\/code> (since _Ty<\/code> is the template parameter to optional<\/code> itself) gives us this:<\/p>\n
        enable_if_t<\r\n            conjunction_v<\r\n                negation<\r\n                    is_same<optional, Doodad>\r\n                >,\r\n                negation<\r\n                    conjunction<is_scalar<Doodad>, is_same<Doodad, Doodad>>\r\n                >,\r\n                is_constructible<Doodad, Doodad&>,\r\n                is_assignable<Doodad&, Doodad&>\r\n            >,\r\n            int> = 0>\r\n    _CONSTEXPR20 optional& operator=(Doodad;& _Right) noexcept(\u27e6...\u27e7)\r\n<\/pre>\n
Now we can interpret the expression. The operator is enabled if…<\/p>\n
    !is_same<optional, Doodad> &&\r\n    !(is_scalar<Doodad> && is_same<Doodad, Doodad>) &&\r\n    is_constructible<Doodad, Doodad&> &&\r\n    is_assignable<Doodad&, Doodad&>\r\n<\/pre>\n
(It so happens that  these are precisely the conditions spelled out in the C++ language specification<\/a>. I doubt this is a coincidence.)<\/p>\n
The first clause says “you are not assigning from a std::optional<Doodad><\/code>“, which is true. We are assigning from a Doodad<\/code>. The purpose of this clause is to remove this overload from consideration in favor of the other overload that specifically is for optional-to-optional assignment.<\/p>\n
The second clause says “you are not trying to assign a scalar that is the same type of the optional.” I think this is to remove this overload from consideration in favor of converting the source scalar to an optional<_Ty><\/code> and assigning that. Regardless, it doesn’t apply here, so we pass that test too.<\/p>\n
The next test is to see whether a Doodad<\/code> can be constructed from a Doodad&<\/code>, and in the case of a Doodad<\/code>, it turns out that this is not true because the Doodad<\/code> contains a unique_ptr<\/code>, which makes it non-copyable.<\/p>\n
Okay, so we can fix that by using std::move<\/code> to move the Doodad<\/code> on the stack into the optional, right?<\/p>\n
            Doodad d;\r\n            m_doodad = std::move(d);\r\n            \/\/ or even\r\n            m_doodad = Doodad();\r\n<\/pre>\n
Unfortunately, this fails in basically the same way. But how can that be?<\/p>\n
It’s because Doodad<\/code> is not move-assignable, even though all of its members are movable!<\/p>\n
The requirements for an implicitly-defined move-assignment operator are that the type have no user-declared copy constructors, move constructors, copy assignment operators, or destructors. Our Doodad<\/code> has a destructor, so that removes the implicitly-defined move-assignment operator.<\/p>\n
Bonus reading<\/b>:  Implicit Move Must Go<\/a>.<\/p>\n
So our Doodad<\/code> is not movable, not copyable.<\/p>\n
One solution is to make our Doodad<\/code> movable. This means investigating the class invariants and verifying that memberwise std::move<\/code> preserves them. This can get tricky if, for example, the Doodad<\/code> allowed pointers to itself to escape. If you’ve done the analysis and confirmed that memberwise std::move<\/code> is correct behavior, you can add<\/p>\n
    Doodad(Doodad&&) = default;\r\n    Doodad& operator=(Doodad&&) = default;\r\n<\/pre>\n
to ask for the compiler to generate a default move constructor and default move assignment operator.<\/p>\n
But maybe you study the Doodad<\/code> and conclude that it is not movable for whatever reason. What else can you do?<\/p>\n
We’ll look at our options next time.<\/p>\n","protected":false},"excerpt":{"rendered":"
The C++ standard library template type std::optional<T> has one of two states. It could be empty (not contain anything), or it could contain a T. Suppose you start with an empty std::optional<T>. How do you put a T into it? One of my colleagues tried to do it in what seemed to be the most […]<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-110516","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
The C++ standard library template type std::optional<T> has one of two states. It could be empty (not contain anything), or it could contain a T. Suppose you start with an empty std::optional<T>. How do you put a T into it? One of my colleagues tried to do it in what seemed to be the most […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110516","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=110516"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110516\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=110516"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=110516"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=110516"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}