标准库头文件 <coroutine>

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

标准库头文件

语言支持
<cstddef> <cstdlib> <version> <limits> <climits>	<cfloat> <cstdint> <new> <typeinfo>	<source_location> <exception> <initializer_list>     <compare>	<coroutine> <csignal> <csetjmp> <cstdarg>
概念
<concepts>
诊断
<stdexcept>	<cassert>	<cerrno>	<system_error>
通用工具
<utility> <memory> <memory_resource> <scoped_allocator>	<bitset> <tuple> <optional> <any>	<variant> <type_traits> <ratio> <chrono>	<typeindex> <functional> <stacktrace> <ctime>
字符串
<string> <string_view> <cstring>	<charconv> <format>	<cctype> <cwctype>	<cwchar> <cuchar>
本地化
<locale>	<codecvt>	<clocale>
容器
<span> <array> <vector>	<deque> <forward_list> <list>	<map> <set> <queue>	<unordered_map> <unordered_set> <stack>
迭代器
<iterator>
范围
<ranges>
算法
<algorithm>	<execution>
数值
<complex> <random>	<valarray> <numeric>	<bit> <numbers>	<cfenv> <cmath>
输入/输出
<iosfwd> <ios> <iomanip> <streambuf>	<istream> <ostream> <iostream>	<sstream> <spanstream> <fstream> <syncstream>	<cstdio> <cinttypes> <strstream>
正则表达式
<regex>
文件系统
<filesystem>
线程支持
<thread> <atomic> <mutex>	<shared_mutex> <condition_variable>     <future>	<stop_token> <semaphore>	<latch> <barrier>
C 兼容
<ciso646> <cstdalign>	<cstdbool> <ccomplex>	<ctgmath> <stdatomic.h>

 

此头文件是协程支持库的一部分。

包含
<compare> (C++20)	三路比较运算符支持
类
coroutine_traits (C++20)	用于发现协程承诺类型的特征类型 (类模板)
coroutine_handle (C++20)	用于指代暂停或执行的协程 (类模板)
std::hash<std::coroutine_handle> (C++20)	std::coroutine_handle 的散列支持 (类模板特化)
无操作协程
noop_coroutine_promise (C++20)	用于无可观察作用的协程 (类)
noop_coroutine_handle (C++20)	std::coroutine_handle<std::noop_coroutine_promise> ，有意用于指代无操作协程 (typedef)
平凡可等待体
suspend_never (C++20)	指示 await 表达式应该决不暂停 (类)
suspend_always (C++20)	指示 await 表达式应该始终暂停 (类)
函数
operator==operator<=> (C++20)	比较二个 coroutine_handle 对象 (函数)
无操作协程
noop_coroutine (C++20)	创建在等待或销毁时无可观察作用的协程柄 (函数)

概要

#include <compare>
 
namespace std {
  // 协程表征
  template<class R, class... ArgTypes>
    struct coroutine_traits;
 
  // 协程柄
  template<class Promise = void>
    struct coroutine_handle;
 
  // 比较运算符
  constexpr bool operator==(coroutine_handle<> x, coroutine_handle<> y) noexcept;
  constexpr strong_ordering operator<=>(coroutine_handle<> x, coroutine_handle<> y) noexcept;
 
  // 散列支持
  template<class T> struct hash;
  template<class P> struct hash<coroutine_handle<P>>;
 
  // 无操作协程
  struct noop_coroutine_promise;
 
  template<> struct coroutine_handle<noop_coroutine_promise>;
  using noop_coroutine_handle = coroutine_handle<noop_coroutine_promise>;
 
  noop_coroutine_handle noop_coroutine() noexcept;
 
  // 平凡可等待体
  struct suspend_never;
  struct suspend_always;
}

类模板 std::coroutine_handle

namespace std {
  template<>
  struct coroutine_handle<void>
  {
    // 构造/重置
    constexpr coroutine_handle() noexcept;
    constexpr coroutine_handle(nullptr_t) noexcept;
    coroutine_handle& operator=(nullptr_t) noexcept;
 
    // 导入/导出
    constexpr void* address() const noexcept;
    static constexpr coroutine_handle from_address(void* addr);
 
    // 观察器
    constexpr explicit operator bool() const noexcept;
    bool done() const;
 
    // 恢复
    void operator()() const;
    void resume() const;
    void destroy() const;
 
  private:
    void* ptr;  // 仅用于阐释
  };
 
  template<class Promise>
  struct coroutine_handle
  {
    // 构造/重置
    constexpr coroutine_handle() noexcept;
    constexpr coroutine_handle(nullptr_t) noexcept;
    static coroutine_handle from_promise(Promise&);
    coroutine_handle& operator=(nullptr_t) noexcept;
 
    // 导出/导入
    constexpr void* address() const noexcept;
    static constexpr coroutine_handle from_address(void* addr);
 
    // 转换
    constexpr operator coroutine_handle<>() const noexcept;
 
    // 观察器
    constexpr explicit operator bool() const noexcept;
    bool done() const;
 
    // 恢复
    void operator()() const;
    void resume() const;
    void destroy() const;
 
    // 承诺访问
    Promise& promise() const;
 
  private:
    void* ptr;  // 仅用于阐释
  };
}

类 std::noop_coroutine_promise

namespace std {
  struct noop_coroutine_promise {};
}

类 std::coroutine_handle<std::noop_coroutine_promise>

namespace std {
  template<>
  struct coroutine_handle<noop_coroutine_promise>
  {
    // 转换
    constexpr operator coroutine_handle<>() const noexcept;
 
    // 观察器
    constexpr explicit operator bool() const noexcept;
    constexpr bool done() const noexcept;
 
    // 恢复
    constexpr void operator()() const noexcept;
    constexpr void resume() const noexcept;
    constexpr void destroy() const noexcept;
 
    // 承诺访问
    noop_coroutine_promise& promise() const noexcept;
 
    // 地址
    constexpr void* address() const noexcept;
  private:
    coroutine_handle(/* 未指明 */);
    void* ptr;  // 仅用于阐释
  };
}

类 std::suspend_never

namespace std {
  struct suspend_never {
    constexpr bool await_ready() const noexcept { return true; }
    constexpr void await_suspend(coroutine_handle<>) const noexcept {}
    constexpr void await_resume() const noexcept {}
  };
}

类 std::suspend_always

namespace std {
  struct suspend_always {
    constexpr bool await_ready() const noexcept { return false; }
    constexpr void await_suspend(coroutine_handle<>) const noexcept {}
    constexpr void await_resume() const noexcept {}
  };
}