Namespaces
Variants

Standard library header <coroutine> (C++20)

From cppreference.net
C++
Standard library headers

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

目录

包含文件

(C++20)
三路比较运算符 支持

类

(C++20)
用于发现协程承诺类型的特征类型
(类模板)
(C++20)
用于引用暂停或执行中的协程
(类模板)
(C++20)
std::coroutine_handle 的哈希支持
(类模板特化)
空操作协程
(C++20)
用于无可见效果的协程
(类)
(C++20)
std:: coroutine_handle < std:: noop_coroutine_promise > ，用于引用空操作协程
(类型定义)
简单可等待对象
(C++20)
指示等待表达式不应暂停
(类)
(C++20)
指示等待表达式应始终暂停
(类)

函数

(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& 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;
    // promise访问
    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 {}
  };
}