标准库标头 <coroutine> (C++20)

来自cppreference.com
See More


 
C++
 
标准库头
通用工具
<any> (C++17)
<bitset>
<bit> (C++20)
<charconv> (C++17)
<expected> (C++23)
<format> (C++20)
<functional>
<optional> (C++17)
<stdbit.h> (C++26)
<tuple> (C++11)
<typeindex> (C++11)
<utility>
<variant> (C++17)
容器
<array> (C++11)
<deque>
<flat_map> (C++23)
<flat_set> (C++23)
<forward_list> (C++11)
<hive> (C++26)
<inplace_vector> (C++26)   
<list>
<map>
<mdspan> (C++23)
<queue>
<set>
<span> (C++20)
<stack>
<unordered_map> (C++11)
<unordered_set> (C++11)
<vector>
迭代器
<iterator>
范围
<generator> (C++23)
<ranges> (C++20)
 

此头文件是语言支持库的一部分。

包含

(C++20)
 三路比较运算符支持[编辑]

类

(C++20)
 用于发现协程承诺类型的特征类型
(类模板) [编辑]
(C++20)
 用于指代暂停或执行中的协程
(类模板) [编辑]
(C++20)
 std::coroutine_handle 的散列支持
(类模板特化) [编辑]
无操作协程
(C++20)
 用于无可观察作用的协程
(类) [编辑]
(C++20)
 std::coroutine_handle<std::noop_coroutine_promise>，有意用于指代无操作协程
(typedef) [编辑]
平凡可等待体
(C++20)
 指示 await 表达式应该决不暂停
(类) [编辑]
(C++20)
 指示 await 表达式应该始终暂停
(类) [编辑]

函数

(C++20)
 比较两个 coroutine_handle 对象
(函数) [编辑]
无操作协程
(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(/* unspecified */);
    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 {}
  };
}