std::coroutine_handle, std::noop_coroutine_handle

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

类模板 coroutine_handle 可以用于引用一个挂起或正在执行的协程。coroutine_handle 的每个特化都是一个 LiteralType。

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

2) 特化 std::coroutine_handle<void> 擦除 promise 类型。它可以从其他特化转换而来。

3) 特化 std::coroutine_handle<std::noop_coroutine_promise> 指的是空操作协程。它不能从 promise 对象创建。

在典型的实现中，std::coroutine_handle 的每个特化都是 TriviallyCopyable。

如果程序为 std::coroutine_handle 添加特化，则行为是未定义的。

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

[编辑] 非成员函数

operator==operator<=>

(C++20)

比较两个 coroutine_handle 对象
(函数) [编辑]

[编辑] 辅助类

std::hash<std::coroutine_handle>

(C++20)

对 std::coroutine_handle 的 hash 支持
(类模板特化) [编辑]

[编辑] 注释

coroutine_handle 可能会悬空，在这种情况下，必须谨慎使用 coroutine_handle 以避免未定义行为。

[编辑] 示例

运行此代码

#include <coroutine>
#include <iostream>
#include <optional>
 
template<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 {};
        }
        // Disallow co_await in generator coroutines.
        void await_transform() = delete;
        [[noreturn]]
        static void unhandled_exception() { throw; }
 
        std::optional<T> current_value;
    };
 
    using Handle = std::coroutine_handle<promise_type>;
 
    explicit Generator(const 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)
        {
            if (m_coroutine)
                m_coroutine.destroy();
            m_coroutine = other.m_coroutine;
            other.m_coroutine = {};
        }
        return *this;
    }
 
    // Range-based for loop support.
    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(const 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, const T last)
{
    while (first < last)
        co_yield first++;
}
 
int main()
{
    for (const char i : range(65, 91))
        std::cout << i << ' ';
    std::cout << '\n';
}

输出

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

[编辑] 缺陷报告

以下行为变更缺陷报告被追溯应用于先前发布的 C++ 标准。

DR	应用于	发布时的行为	正确行为
LWG 3460	C++20	`coroutine_handle` 的公共基类可能使其处于不期望的状态	移除继承

[编辑] 参见

generator

(C++23)

表示同步协程生成器的 view
(类模板) [编辑]

编译器支持
独立式和宿主式
语言
标准库
标准库头文件
命名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
诊断库
内存管理库
元编程库 (C++11)
通用工具库
容器库
迭代器库
范围库 (C++20)
算法库
字符串库
文本处理库
数值库
日期和时间库
输入/输出库
文件系统库 (C++17)
并发支持库 (C++11)
执行控制库 (C++26)
技术规范
符号索引
外部库

协程 traits
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)
范围生成器
generator (C++23)

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

成员名称	定义
`ptr` (私有)	指向协程状态的 void* 指针。 (仅用于说明的成员对象*)

cppreference.cn

命名空间

变体

视图

操作

std::coroutine_handle, std::noop_coroutine_handle

目录

[编辑] 数据成员

[编辑] 成员函数

转换

观察器

控制

Promise 访问

导出/导入