- coroutine[meta header]
- std[meta namespace]
- class template[meta id-type]
- cpp20[meta cpp]
namespace std {
template<class Promise = void>
struct coroutine_handle;
template<>
struct coroutine_handle<void> {
// (メンバ宣言は省略)
};
template<class Promise>
struct coroutine_handle : coroutine_handle<> {
// (メンバ宣言は省略)
};
}
- hash[link /reference/functional/hash.md]
コルーチンに対応するコルーチンハンドル。
テンプレートパラメータPromiseには、コルーチンのPromise型を指定する。
コルーチンハンドルはアプリケーションコードからの直接アクセスを想定した機能ではなく、コルーチンライブラリ提供クラス内部に隠蔽される構造が一般的である。
例: 後述サンプルコードではtaskクラス内に隠蔽されており、コルーチンfや関数mainから間接的に利用される。
coroutine_handle<void>または単にcoroutine_handle<>は、Promise型について型消去(Type-erased)されたコルーチンハンドルとして取り扱える。
コルーチンのPromise型を明示したcoroutine_handle<Promise>は型消去されたcoroutine_handle<>から公開派生されており、前者から後者への暗黙変換を行うことが可能となっている。
C++コルーチンとC API（コールバック関数へのポインタとvoid*をとる関数）との組合せ利用を可能とするため、coroutine_handleとポインタ型void*との相互変換がサポートされる。
ユーザプログラムがcoroutine_handleの明示特殊化または部分特殊化を宣言した場合、その動作は未定義とされる。
| 名前 |
説明 |
対応バージョン |
address |
コルーチンハンドルに対応するアドレス値 |
C++20 |
| 名前 |
説明 |
対応バージョン |
promise |
Promiseオブジェクトの参照（coroutine_handle<Promise>のみ） |
C++20 |
| 名前 |
説明 |
対応バージョン |
from_promise |
Promiseオブジェクトから対応するコルーチンハンドルへ変換（coroutine_handle<Promise>のみ） |
C++20 |
from_address |
アドレス値から対応するコルーチンハンドルへ変換 |
C++20 |
| 名前 |
説明 |
対応バージョン |
template<class T> struct hash |
先行宣言(class template) |
C++20 |
template<class P> struct hash<coroutine_handle<P>> |
hashのcoroutine_handle<P>に対する特殊化 |
C++20 |
| 名前 |
説明 |
対応バージョン |
bool operator==(coroutine_handle<>, coroutine_handle<>); |
等値比較 |
C++20 |
bool operator!=(coroutine_handle<>, coroutine_handle<>); |
非等値比較 (==により使用可能) |
C++20 |
strong_ordering operator<=>(coroutine_handle<>, coroutine_handle<>); |
三方比較 |
C++20 |
bool operator<(coroutine_handle<>, coroutine_handle<>); |
左辺が右辺より小さいかを判定する (<=>により使用可能) |
C++20 |
bool operator<=(coroutine_handle<>, coroutine_handle<>); |
左辺が右辺以下を判定する (<=>により使用可能) |
C++20 |
bool operator>(coroutine_handle<>, coroutine_handle<>); |
左辺が右辺より大きいかを判定する (<=>により使用可能) |
C++20 |
bool operator>=(coroutine_handle<>, coroutine_handle<>); |
左辺が右辺以上かを判定する (<=>により使用可能) |
C++20 |
coroutine_handle同士の比較は、addressが返すアドレス値を用いて比較演算が行われる。
#include <coroutine>
#include <iostream>
#include <utility>
struct task {
struct promise_type {
int value_;
auto get_return_object() { return task{*this}; }
auto initial_suspend() { return std::suspend_never{}; }
auto final_suspend() noexcept { return std::suspend_always{}; }
void return_value(int x) { value_ = x; }
void unhandled_exception() { std::terminate(); }
};
~task()
{
if (coro_)
coro_.destroy();
}
task(task const&) = delete;
task(task&& rhs)
: coro_(std::exchange(rhs.coro_, nullptr)) {}
int get()
{
if (!coro_.done()) {
coro_.resume();
}
return coro_.promise().value_;
}
private:
explicit task(promise_type& p)
: coro_(std::coroutine_handle<promise_type>::from_promise(p)) {}
std::coroutine_handle<promise_type> coro_;
};
task f()
{
std::cout << "coroutine" << std::endl;
co_return 42;
}
int main()
{
auto c = f();
std::cout << "main" << std::endl;
int r = c.get();
std::cout << "result=" << r << std::endl;
}
- std::coroutine_handle<promise_type>[color ff0000]
- std::suspend_never[link suspend_never.md]
- std::suspend_always[link suspend_always.md]
- resume()[link coroutine_handle/resume.md]
- done()[link coroutine_handle/done.md]
- from_promise[link coroutine_handle/from_promise.md]
- promise()[link coroutine_handle/promise.md]
- std::exchange[link /reference/utility/exchange.md]