std::coroutine_handle, std::noop_coroutine_handle

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Стандартная библиотека

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов (C++20)

Библиотека метапрограммирования (C++11)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов (C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения (C++11)

Атомарные операции (C++11)

Библиотека поддержки конкуренции (C++11)

Библиотека файловой системы (C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Библиотека утилит

Языковая поддержка Поддержка типов (базовые типы, RTTI) Макросы тестирования функциональности библиотеки (C++20)     Управление динамической памятью Программные утилиты Поддержка сопрограмм (C++20) Вариативные функции is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) Трёхстороннее сравнение (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)     is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

Общие утилиты Дата и время Функциональные объекты Библиотека форматирования (C++20) bitset hash (C++11) Операторы отношения (устарело в C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Целочисленные функции сравнения cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)     cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Операции обмена и типа swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Общие лексические типы pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) Элементарные преобразования строк to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

Поддержка сопрограмм

Свойства сопрограмм

coroutine_traits (C++20)

Дескриптор сопрограммы

coroutine_handle (C++20)

Сопрограммы без операций

noop_coroutine_promise (C++20)

noop_coroutine (C++20)

Тривиальные ожидания

suspend_never (C++20)

suspend_always (C++20)

Генераторы диапазонов

generator (C++23)

 

std::coroutine_handle

Функции-лементы

coroutine_handle::coroutine_handle (C++20)

coroutine_handle::operator= (C++20)

coroutine_handle::from_promise (C++20)

Преобразование

coroutine_handle::operator coroutine_handle<> (C++20)

Наблюдатели

coroutine_handle::done (C++20)

coroutine_handle::operator bool (C++20)

Контроль

coroutine_handle::operator()coroutine_handle::resume (C++20)(C++20)

coroutine_handle::destroy (C++20)

Доступ к обещанию

coroutine_handle::promise (C++20)

Экспорт/импорт

coroutine_handle::address (C++20)

coroutine_handle::from_address (C++20)

Функции, не являющиеся элементами

operator==operator<=> (C++20)(C++20)

Вспомогательные классы

std::hash<std::coroutine_handle> (C++20)

 

<tbody> </tbody>

Определено в заголовочном файле <coroutine>
template< class Promise = void > struct coroutine_handle;	(1)	(начиная с C++20)
template<> struct coroutine_handle<void>;	(2)	(начиная с C++20)
template<> struct coroutine_handle<std::noop_coroutine_promise>;	(3)	(начиная с C++20)
using noop_coroutine_handle = std::coroutine_handle<std::noop_coroutine_promise>;	(4)	(начиная с C++20)

Шаблон класса coroutine_handle можно использовать для ссылки на приостановленную или выполняющуюся сопрограмму. Каждая специализация coroutine_handle представляет собой LiteralType.

1) Первичный шаблон может быть создан из объекта обещания типа Promise.

2) Специализация std::coroutine_handle<void> стирает тип обещания. Он конвертируется из других специализаций.

3) Специализация std::coroutine_handle<std::noop_coroutine_promise> относится к неактивным сопрограммам. Её нельзя создать из объекта обещания.

В типичных реализациях каждая специализация std::coroutine_handle является TriviallyCopyable.

Поведение программы, добавляющей специализации для std::coroutine_handle не определено.

Элементы данных

Имя элемента	Определение
ptr (private)	Указатель void* на состояние сопрограммы. (только для пояснения объект элемент*)

Функции-элементы

(конструктор) (C++20)	создаёт объект coroutine_handle (public функция-элемент)
operator= (C++20)	присваивает объект coroutine_handle (public функция-элемент)
Преобразование
operator coroutine_handle<> (C++20)	получает стёртый тип coroutine_handle (public функция-элемент)
Наблюдатели
done (C++20)	проверяет, завершилась ли сопрограмма (public функция-элемент)
operator bool (C++20)	проверяет, представляет ли дескриптор сопрограмму (public функция-элемент)
Контроль
operator()resume (C++20)	возобновляет выполнение сопрограммы (public функция-элемент)
destroy (C++20)	уничтожает сопрограмму (public функция-элемент)
Доступ к обещанию
promise (C++20)	предоставляет доступ к обещанию сопрограммы (public функция-элемент)
from_promise [static] (C++20)	создаёт coroutine_handle из объекта обещания сопрограммы (public static функция-элемент)
Экспорт/Импорт
address (C++20)	экспортирует базовый адрес, то есть указатель, поддерживающий сопрограмму (public функция-элемент)
from_address [static] (C++20)	импортирует сопрограмму из указателя (public static функция-элемент)

Функции, не являющиеся элементами

operator==operator<=> (C++20)

сравнивает два объекта coroutine_handle (функция)

Вспомогательные классы

std::hash<std::coroutine_handle> (C++20)

поддержка хэширования для std::coroutine_handle (специализация шаблона класса)

Примечание

A coroutine_handle может быть зависшим, и в этом случае coroutine_handle следует использовать осторожно, чтобы избежать неопределённого поведения.

Пример

Запустить этот код

#include <coroutine>
#include <iostream>
#include <optional>

template<std::movable T>
class Generator {
public:
    struct promise_type
    {
        Generator<T> get_return_object()
        {
            return Generator{Handle::from_promise(*this)};
        }
        static std::suspend_always initial_suspend() noexcept
        {
            return {}; 
        }
        static std::suspend_always final_suspend() noexcept
        {
            return {}; 
        }
        std::suspend_always yield_value(T value) noexcept
        {
            current_value = std::move(value);
            return {};
        }
        // Запретить co_await в сопрограммах генератора.
        void await_transform() = delete;
        [[noreturn]]
        static void unhandled_exception()
        {
            throw;
        }

        std::optional<T> current_value;
    };

    using Handle = std::coroutine_handle<promise_type>;

    explicit Generator(const Handle coroutine) : 
        m_coroutine{coroutine}
    {}

    Generator() = default;
    ~Generator()
    {
        if (m_coroutine)
        {
            m_coroutine.destroy(); 
        }
    }

    Generator(const Generator&) = delete;
    Generator& operator=(const Generator&) = delete;

    Generator(Generator&& other) noexcept : 
        m_coroutine{other.m_coroutine}
    { 
        other.m_coroutine = {}; 
    }
    Generator& operator=(Generator&& other) noexcept
    {
        if (this != &other)
        {
            if (m_coroutine)
            {
                m_coroutine.destroy();
            }
            m_coroutine = other.m_coroutine;
            other.m_coroutine = {};
        }
        return *this;
    }

    // На основе диапазона для поддержки циклов.
    class Iter
    {
    public:
        void operator++()
        {
            m_coroutine.resume(); 
        }
        const T& operator*() const
        {
            return *m_coroutine.promise().current_value; 
        }        
        bool operator==(std::default_sentinel_t) const
        {
            return !m_coroutine || m_coroutine.done(); 
        }

        explicit Iter(const Handle coroutine) : 
            m_coroutine{coroutine}
        {}

    private:
        Handle m_coroutine;
    };

    Iter begin()
    {
        if (m_coroutine)
        {
            m_coroutine.resume();
        } 
        return Iter{m_coroutine};
    }
    std::default_sentinel_t end()
    {
        return {}; 
    }

private:
    Handle m_coroutine;
};

template<std::integral T>
Generator<T> range(T first, const T last)
{
    while (first < last)
    {
        co_yield first++;
    }
}

int main()
{
    for (const char i : range(65, 91))
    {
        std::cout << i << ' ';
    }
    std::cout << '\n';
}

Вывод:

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Отчёты о дефектах

Следующие изменения поведения были применены с обратной силой к ранее опубликованным стандартам C++:

Номер	Применён	Поведение в стандарте	Корректное поведение
LWG 3460	C++20	общедоступный базовый класс для coroutine_handle может оставить его в нежелательном состоянии	наследование удалено

Смотрите также

generator (C++23)

view, представляющий синхронный генератор сопрограмм (шаблон класса)