Заголовочный файл стандартной библиотеки <coroutine> (C++20)
Материал из cppreference.com
Этот заголовок является частью библиотеки поддержки сопрограмм.
Включает | ||
(C++20) |
Поддержка оператора трёхстороннего сравнения | |
Классы | ||
(C++20) |
свойства типа для обнаружения типов обещаний сопрограммы (шаблон класса) | |
(C++20) |
используется чтобы сослаться на приостановленную или выполняющуюся сопрограмму (шаблон класса) | |
поддержка хэширования для std::coroutine_handle (специализация шаблона класса) | ||
Неактивные сопрограммы | ||
(C++20) |
используется для сопрограмм без видимых эффектов (класс) | |
(C++20) |
std::coroutine_handle<std::noop_coroutine_promise>, предназначенный для ссылки на сопрограмму без операций (определение типа) | |
Тривиальные Ожидания | ||
(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(/* не указано */); 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 {} }; }