Пространства имён
Варианты
Действия

Заголовочный файл стандартной библиотеки <coroutine> (C++20)

Материал из cppreference.com
< cpp‎ | header
 
 
Заголовочные файлы стандартной библиотеки
Языковая поддержка
<coroutine> (C++20)
<csignal>
<csetjmp>
<cstdarg>

Концепты
<concepts> (C++20)
Диагностика
<system_error> (C++11)

Управление памятью
<memory_resource> (C++17)  
Метапрограммирование
<type_traits> (C++11)
<ratio> (C++11)
Общие утилиты
<utility>
<tuple> (C++11)
<optional> (C++17)
<variant> (C++17)
<any> (C++17)
<expected> (C++23)
<bitset>

<charconv> (C++17)
<format> (C++20)
<bit> (C++20)

Строки
<cuchar> (C++11)

Контейнеры
<flat_set> (C++23)
<span> (C++20)
<mdspan> (C++23)

Итераторы
<iterator>
Диапазоны
<ranges> (C++20)
<generator> (C++23)
Алгоритмы
Числа
<cfenv> (C++11)
<complex>
<numbers> (C++20)

Время
<chrono> (C++11)
Локализация
<codecvt> (C++11/17*)
Ввод/вывод
<filesystem> (C++17)
<cstdio>
<cinttypes> (C++11)
<strstream> (C++98*)
Регулярные выражения
<regex> (C++11)
Поддержка конкуренции
<stop_token> (C++20)
<thread> (C++11)
<atomic> (C++11)
<stdatomic.h> (C++23)
<mutex> (C++11)
<shared_mutex> (C++14)
<condition_variable> (C++11)  
<semaphore> (C++20)
<latch> (C++20)
<barrier> (C++20)
<future> (C++11)

Совместимость с C
<cstdbool> (C++11/17/20*)  
<ccomplex> (C++11/17/20*)
<ctgmath> (C++11/17/20*)

<cstdalign> (C++11/17/20*)

<ciso646> (до C++20)

 

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

Содержание

Включает

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

Классы

свойства типа для обнаружения типов обещаний сопрограммы
(шаблон класса) [править]
используется чтобы сослаться на приостановленную или выполняющуюся сопрограмму
(шаблон класса) [править]
поддержка хэширования для std::coroutine_handle
(специализация шаблона класса) [править]
Неактивные сопрограммы
используется для сопрограмм без видимых эффектов
(класс) [править]
std::coroutine_handle<std::noop_coroutine_promise>, предназначенный для ссылки на сопрограмму без операций
(определение типа) [править]
Тривиальные Ожидания
указывает, что выражение await никогда не должно приостанавливаться
(класс) [править]
указывает, что выражение await всегда должно приостанавливаться
(класс) [править]

Функции

сравнивает два объекта coroutine_handle
(функция) [править]
Неактивные сопрограммы
создаёт дескриптор сопрограммы, который не имеет видимых эффектов при возобновлении или уничтожении
(функция) [править]

[править] Краткий обзор

#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 {}
  };
}