std::coroutine_handle, std::noop_coroutine_handle

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、RTTI） 库功能特性测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (C++26) 三路比较 three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)    is_eqis_ltis_lteq (C++20)(C++20)(C++20) is_neqis_gtis_gteq (C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 格式化库 (C++20) bitset hash (C++11) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator>     rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)    cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) 交换与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

协程支持

协程特征

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)

 

std::coroutine_handle

成员函数

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

承诺访问

coroutine_handle::promise

导出/导入

coroutine_handle::address

coroutine_handle::from_address

非成员函数

operator==operator<=>

辅助类

hash<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 的特化，那么行为未定义。

数据成员

成员名	定义
ptr (private)	指向协程状态的 void* 指针。 (仅用于阐述的成员对象*)

成员函数

(构造函数) (C++20)	构造 coroutine_handle 对象 (公开成员函数)
operator= (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)	访问协程的承诺对象 (公开成员函数)
from_promise [静态] (C++20)	从协程的承诺对象创建 coroutine_handle (公开静态成员函数)
导出/导入
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>
 
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 {};
        }
        // 生成器协程中不允许 co_await。
        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;
    }
 
    // 基于范围的 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(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++ 标准。

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

参阅

generator (C++23)

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