std::coroutine_handle

在标头 `<coroutine>` 定义
template< class Promise = void > struct coroutine_handle;	(1)	(C++20 起)
template<> struct coroutine_handle<void>;	(2)	(C++20 起)
template<> struct coroutine_handle<std::noop_coroutine_promise>;	(3)	(C++20 起)
using noop_coroutine_handle = std::coroutine_handle<std::noop_coroutine_promise>;	(4)	(C++20 起)

类模板 coroutine_handle 能用于指代暂停或执行的协程。 coroutine_handle 的每个特化均为字面类型 (LiteralType) 。

1) 主模板，可从 Promise 类型的承诺对象创建。

2) 特化 std::coroutine_handle<void> 擦除承诺类型。它可从其他特化转换。

3) 特化 std::coroutine_handle<std::noop_coroutine_promise> 指代无操作协程。不能从承诺对象创建它。

典型实现上， std::coroutine_handle 的每个特化均为可平凡复制 (TriviallyCopyable) ，并保有一个指向协程状态的指针作为其仅有的非静态成员。

添加 std::coroutine_handle 的特化的程序行为未定义。

成员函数

(构造函数) (C++20)	构造 `coroutine_handle` 对象 (公开成员函数)
operator= (C++20)	赋值 `coroutine_handle` 对象 (公开成员函数)
from_promise [静态] (C++20)	从协程的承诺对象创建 `coroutine_handle` (公开静态成员函数)
转换
operator coroutine_handle<> (C++20)	获得擦除类型的 `coroutine_handle` (公开成员函数)
观察器
done (C++20)	检查协程是否已完成 (公开成员函数)
operator bool (C++20)	检查柄是否表示协程 (公开成员函数)
控制
operator()resume (C++20)	恢复协程执行 (公开成员函数)
destroy (C++20)	销毁协程 (公开成员函数)
承诺访问
promise (C++20)	访问协程的承诺对象 (公开成员函数)
导出/导入
address (C++20)	导出底层地址，即支撑协程的指针 (公开成员函数)
from_address [静态] (C++20)	从指针导入协程 (公开静态成员函数)

非成员函数

operator==operator<=>

(C++20)

比较二个 coroutine_handle 对象
(函数)

辅助类

std::hash<std::coroutine_handle>

(C++20)

std::coroutine_handle 的散列支持
(类模板特化)

注解

coroutine_handle 可能悬垂，该情况下必须谨慎使用该 coroutine_handle 以避免未定义行为。

示例

运行此代码

#include <coroutine>
#include <iostream>
#include <optional>
#include <ranges>
 
template<typename T> requires std::movable<T>
class Generator {
public:
    struct promise_type {
        Generator<T> get_return_object() {
            return Generator{Handle::from_promise(*this)};
        }
        static std::suspend_always initial_suspend() noexcept {
            return {}; 
        }
        static std::suspend_always final_suspend() noexcept { 
            return {}; 
        }
        std::suspend_always yield_value(T value) noexcept {
            current_value = std::move(value);
            return {};
        }
        // 生成器协程中不允许 co_await 。
        void await_transform() = delete;
        static void unhandled_exception() {
            throw;
        }
 
        std::optional<T> current_value;
    };
 
    using Handle = std::coroutine_handle<promise_type>;
 
    explicit Generator(Handle coroutine) : 
        m_coroutine{coroutine}
    {}
 
    Generator() = default;
    ~Generator() { 
        if (m_coroutine) {
            m_coroutine.destroy(); 
        }
    }
 
    Generator(const Generator&) = delete;
    Generator& operator=(const Generator&) = delete;
 
    Generator(Generator&& other) noexcept : 
        m_coroutine{other.m_coroutine}
    { 
        other.m_coroutine = {}; 
    }
 
    Generator& operator=(Generator&& other) noexcept {
        if (this != &other) {
            m_coroutine = other.m_coroutine;
            other.m_coroutine = {};
        }
        return *this;
    }
 
    // 基于范围的 for 循环支持。
    class Iter {
    public:
        void operator++() { 
            m_coroutine.resume(); 
        }
        const T& operator*() const { 
            return *m_coroutine.promise().current_value; 
        }        
        bool operator==(std::default_sentinel_t) const { 
            return !m_coroutine || m_coroutine.done(); 
        }
 
        explicit Iter(Handle coroutine) : 
            m_coroutine{coroutine}
        {}
 
    private:
        Handle m_coroutine;
    };
 
    Iter begin() {
        if (m_coroutine) {
            m_coroutine.resume();
        } 
        return Iter{m_coroutine};
    }
    std::default_sentinel_t end() { 
        return {}; 
    }
 
private:
    Handle m_coroutine;
};
 
template<std::integral T>
Generator<T> range(T first, T last) {
    while (first < last) {
        co_yield first++;
    }
}
 
int main() {
    for (int i : range(-4, 8)) {
        std::cout << i << ' ';
    }
    std::cout << '\n';
}

输出：

-4 -3 -2 -1 0 1 2 3 4 5 6 7

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
LWG 3460	C++20	`coroutine_handle` 的公开基类能将它置于不想要的状态	移除继承

编译器支持
自立实现与有宿主实现
语言
标准库
标准库标头
具名要求
功能特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
技术规范
符号索引
外部库

协程特征
coroutine_traits (C++20)
协程柄
coroutine_handle (C++20)
无操作协程
noop_coroutine_promise (C++20)
noop_coroutine (C++20)
平凡可等待体
suspend_never (C++20)
suspend_always (C++20)

成员函数
coroutine_handle::coroutine_handle (C++20)
coroutine_handle::operator= (C++20)
coroutine_handle::from_promise (C++20)
转换
coroutine_handle::operator coroutine_handle<> (C++20)
观察器
coroutine_handle::done (C++20)
coroutine_handle::operator bool (C++20)
控制
coroutine_handle::operator()coroutine_handle::resume (C++20)(C++20)
coroutine_handle::destroy (C++20)
承诺访问
coroutine_handle::promise (C++20)
导出/导入
coroutine_handle::address (C++20)
coroutine_handle::from_address (C++20)
非成员函数
operator==operator<=> (C++20)(C++20)
辅助类
std::hash<std::coroutine_handle> (C++20)

std::coroutine_handle

成员函数

转换

观察器

控制

承诺访问

导出/导入

非成员函数

辅助类

注解

示例

缺陷报告

导航