Стандартная библиотека заголовок <coroutine> (C++20)
Этот заголовок является частью библиотеки поддержки корутин.
Включаемые заголовки |
|
|
(C++20) | Поддержка оператора трехстороннего сравнения для сравнения |
Классы |
|
|
(C++20) | тип-признак для обнаружения типов обещаний корутины (шаблон класса) |
|
(C++20) | используется для ссылки на приостановленную или выполняющуюся корутину (шаблон класса) |
|
(C++20) | поддержка хеширования для std::coroutine_handle (специализация шаблона класса) |
Корутины без действий |
|
|
(C++20) | используется для корутин без наблюдаемых эффектов (класс) |
|
(C++20) | тип, предназначенный для ссылки на корутину без действий (псевдоним типа) |
Тривиальные объекты ожидания |
|
|
(C++20) | указывает, что выражение ожидания никогда не должно приостанавливаться (класс) |
|
(C++20) | указывает, что выражение ожидания всегда должно приостанавливаться (класс) |
Функции |
|
|
(C++20) | сравнивает два объекта coroutine_handle (функция) |
Корутины без действий |
|
|
(C++20) | создаёт дескриптор корутины, у которой нет наблюдаемых эффектов при возобновлении или уничтожении (функция) |
Синопсис
#include <compare>
namespace std {
// coroutine traits
template<class R, class... ArgTypes>
struct coroutine_traits;
// coroutine handle
template<class Promise = void>
struct coroutine_handle;
// comparison operators
constexpr bool operator==(coroutine_handle<> x, coroutine_handle<> y) noexcept;
constexpr strong_ordering operator<=>(coroutine_handle<> x, coroutine_handle<> y) noexcept;
// hash support
template<class T> struct hash;
template<class P> struct hash<coroutine_handle<P>>;
// no-op coroutines
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;
// trivial awaitables
struct suspend_never;
struct suspend_always;
} Шаблон класса std::coroutine_handle
namespace std {
template<>
struct coroutine_handle<void>
{
// construct/reset
constexpr coroutine_handle() noexcept;
constexpr coroutine_handle(nullptr_t) noexcept;
coroutine_handle& operator=(nullptr_t) noexcept;
// export/import
constexpr void* address() const noexcept;
static constexpr coroutine_handle from_address(void* addr);
// observers
constexpr explicit operator bool() const noexcept;
bool done() const;
// resumption
void operator()() const;
void resume() const;
void destroy() const;
private:
void* ptr; // exposition only
};
template<class Promise>
struct coroutine_handle
{
// construct/reset
constexpr coroutine_handle() noexcept;
constexpr coroutine_handle(nullptr_t) noexcept;
static coroutine_handle from_promise(Promise&);
coroutine_handle& operator=(nullptr_t) noexcept;
// export/import
constexpr void* address() const noexcept;
static constexpr coroutine_handle from_address(void* addr);
// conversion
constexpr operator coroutine_handle<>() const noexcept;
// observers
constexpr explicit operator bool() const noexcept;
bool done() const;
// resumption
void operator()() const;
void resume() const;
void destroy() const;
// promise access
Promise& promise() const;
private:
void* ptr; // exposition only
};
} Класс 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>
{
// conversion
constexpr operator coroutine_handle<>() const noexcept;
// observers
constexpr explicit operator bool() const noexcept;
constexpr bool done() const noexcept;
// resumption
constexpr void operator()() const noexcept;
constexpr void resume() const noexcept;
constexpr void destroy() const noexcept;
// promise access
noop_coroutine_promise& promise() const noexcept;
// address
constexpr void* address() const noexcept;
private:
coroutine_handle(/* unspecified */);
void* ptr; // exposition only
};
} Класс 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 {}
};
}
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/header/coroutine
