Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/coroutine/coroutine handle/operator cmp"

From cppreference.com
(header read "std::operator==, ...")
m (fmt)
Line 2: Line 2:
 
{{cpp/coroutine/coroutine_handle/navbar}}
 
{{cpp/coroutine/coroutine_handle/navbar}}
 
{{dcl begin}}
 
{{dcl begin}}
{{dcl header | coroutine}}
+
{{dcl header|coroutine}}
{{dcl | num=1 | since=c++20 | 1=
+
{{dcl|num=1|since=c++20|1=
 
constexpr bool
 
constexpr bool
     operator==(std::coroutine_handle<> x, std::coroutine_handle<> y) noexcept;
+
     operator==( std::coroutine_handle<> x, std::coroutine_handle<> y ) noexcept;
 
}}
 
}}
{{dcl | num=2 | since=c++20 | 1=
+
{{dcl|num=2|since=c++20|1=
 
constexpr std::strong_ordering
 
constexpr std::strong_ordering
     operator<=>(std::coroutine_handle<> x, std::coroutine_handle<> y) noexcept;
+
     operator<=>( std::coroutine_handle<> x, std::coroutine_handle<> y ) noexcept;
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
Line 19: Line 19:
 
===Parameters===
 
===Parameters===
 
{{par begin}}
 
{{par begin}}
{{par | x, y | {{c|std::coroutine_handle<>}} values to compare}}
+
{{par|x, y|{{c|std::coroutine_handle<>}} values to compare}}
 
{{par end}}
 
{{par end}}
  

Revision as of 02:13, 24 October 2022

 
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Coroutine support
Coroutine traits
Coroutine handle
No-op coroutines
Trivial awaitables
Range generators
(C++23)
 
 
Defined in header <coroutine>
constexpr bool
    operator==( std::coroutine_handle<> x, std::coroutine_handle<> y ) noexcept;
(1) (since C++20)
constexpr std::strong_ordering
    operator<=>( std::coroutine_handle<> x, std::coroutine_handle<> y ) noexcept;
(2) (since C++20)

Compares two std::coroutine_handle<> values x and y according to their underlying addresses.

The <, <=, >, >=, and != operators are synthesized from operator<=> and operator== respectively.

Contents

Parameters

x, y - std::coroutine_handle<> values to compare

Return value

1) x.address() == y.address().
2) std::compare_three_way{}(x.address(), y.address()).

Notes

Although these operators are only overloaded for std::coroutine_handle<>, other specializations of std::coroutine_handle are also equality comparable and three-way comparable, because they are implicitly convertible to std::coroutine_handle<>.

Example