Namespaces
Variants

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

From cppreference.net
C++
Standard library headers

Этот заголовок является частью библиотеки поддержки языка .

Содержание

Включения

(C++20)
Поддержка оператора трёхстороннего сравнения

Классы

(C++20)
тип-признак для определения типов promise корутин
(шаблон класса)
(C++20)
используется для обращения к приостановленной или выполняющейся сопрограмме
(шаблон класса)
(C++20)
поддержка хеширования для std::coroutine_handle
(специализация шаблона класса)
No-op Корутины
(C++20)
используется для корутин без наблюдаемых эффектов
(класс)
(C++20)
std:: coroutine_handle < std:: noop_coroutine_promise > , предназначен для ссылки на пустую сопрограмму
(typedef)
Тривиальные Awaitable-объекты
(C++20)
указывает, что await-выражение никогда не должно приостанавливаться
(класс)
(C++20)
указывает, что await-выражение должно всегда приостанавливаться
(класс)

Функции

(C++20)
сравнивает два объекта coroutine_handle
(функция)
No-op Корутины
(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>>;
  // no-op сопрограммы
  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;
  // тривиальные awaitable-объекты
  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 {}
  };
}