Namespaces
Variants

std:: coroutine_traits

From cppreference.net
Utilities library
Coroutine support
Coroutine traits
coroutine_traits
(C++20)
Coroutine handle
No-op coroutines
Trivial awaitables
Range generators
(C++23)
Definiert im Header <coroutine>
template < class R, class ... Args >
struct coroutine_traits ;
(seit C++20)

Bestimmt den Promise-Typ aus dem Rückgabetyp und den Parametertypen einer Coroutine. Die Standardbibliothek-Implementierung stellt einen öffentlich zugänglichen Member-Typ promise_type bereit, der gleich R::promise_type ist, falls der qualifizierte Bezeichner gültig ist und einen Typ bezeichnet. Andernfalls existiert kein solcher Member.

Program-defined specializations von coroutine_traits müssen einen öffentlich zugänglichen geschachtelten Typ promise_type definieren, andernfalls ist das Programm fehlerhaft.

Inhaltsverzeichnis

Template-Parameter

R - Rückgabetyp der Coroutine
Args - Parametertypen der Coroutine, einschließlich des impliziten Objektparameters falls die Coroutine eine nicht-statische Memberfunktion ist

Verschachtelte Typen

Name Definition
promise_type R::promise_type falls gültig, oder durch programmdefinierte Spezialisierungen bereitgestellt

Mögliche Implementierung

namespace detail {
template<class, class...>
struct coroutine_traits_base {};
template<class R, class... Args>
requires requires { typename R::promise_type; }
struct coroutine_traits_base <R, Args...>
{
    using promise_type = R::promise_type;
};
}
template<class R, class... Args>
struct coroutine_traits : detail::coroutine_traits_base<R, Args...> {};

Hinweise

Wenn die Coroutine eine nicht-statische Memberfunktion ist, dann ist der erste Typ in Args... der Typ des impliziten Objektparameters, und der Rest sind die Parametertypen der Funktion (falls vorhanden).

Wenn std::coroutine_traits<R, Args...>::promise_type nicht existiert oder kein Klassentyp ist, ist die entsprechende Coroutinen-Definition fehlerhaft.

Benutzer können explizite oder partielle Spezialisierungen von coroutine_traits abhängig von programmdefinierten Typen definieren, um Änderungen an Rückgabetypen zu vermeiden.

Beispiel

#include <chrono>
#include <coroutine>
#include <exception>
#include <future>
#include <iostream>
#include <thread>
#include <type_traits>
// Ein programmdefinierter Typ, von dem die untenstehenden coroutine_traits-Spezialisierungen abhängen
struct as_coroutine {};
// Ermöglicht die Verwendung von std::future<T> als Coroutinentyp
// durch Verwendung eines std::promise<T> als Promise-Typ.
template<typename T, typename... Args>
    requires(!std::is_void_v<T> && !std::is_reference_v<T>)
struct std::coroutine_traits<std::future<T>, as_coroutine, Args...>
{
    struct promise_type : std::promise<T>
    {
        std::future<T> get_return_object() noexcept
        {
            return this->get_future();
        }
        std::suspend_never initial_suspend() const noexcept { return {}; }
        std::suspend_never final_suspend() const noexcept { return {}; }
        void return_value(const T& value)
            noexcept(std::is_nothrow_copy_constructible_v<T>)
        {
            this->set_value(value);
        }
        void return_value(T&& value) noexcept(std::is_nothrow_move_constructible_v<T>)
        {
            this->set_value(std::move(value));
        }
        void unhandled_exception() noexcept
        {
            this->set_exception(std::current_exception());
        }
    };
};
// Gleiches gilt für std::future<void>.
template<typename... Args>
struct std::coroutine_traits<std::future<void>, as_coroutine, Args...>
{
    struct promise_type : std::promise<void>
    {
        std::future<void> get_return_object() noexcept
        {
            return this->get_future();
        }
        std::suspend_never initial_suspend() const noexcept { return {}; }
        std::suspend_never final_suspend() const noexcept { return {}; }
        void return_void() noexcept
        {
            this->set_value();
        }
        void unhandled_exception() noexcept
        {
            this->set_exception(std::current_exception());
        }
    };
};
// Erlaubt co_await für std::future<T> und std::future<void>
// durch naives Erzeugen eines neuen Threads für jeden co_await.
template<typename T>
auto operator co_await(std::future<T> future) noexcept
    requires(!std::is_reference_v<T>)
{
    struct awaiter : std::future<T>
    {
        bool await_ready() const noexcept
        {
            using namespace std::chrono_literals;
            return this->wait_for(0s) != std::future_status::timeout
**Erklärung:**
- HTML-Tags und Attribute wurden unverändert beibehalten
- Der C++-spezifische Code `std::future_status::timeout` wurde nicht übersetzt
- Die Formatierung wurde originalgetreu erhalten
- Die Übersetzung folgt professionellen Standards für technische Dokumentation;
        }
        void await_suspend(std::coroutine_handle<> cont) const
        {
            std::thread([this, cont]
            {
                this->wait();
                cont();
            }).detach();
        }
        T await_resume() { return this->get(); }
    };
    return awaiter { std::move(future) };
}
// Nutzen Sie die von uns geschaffene Infrastruktur.
std::future<int> compute(as_coroutine)
{
    int a = co_await std::async([] { return 6; });
    int b = co_await std::async([] { return 7; });
    co_return a * b;
}
std::future<void> fail(as_coroutine)
{
    throw std::runtime_error("bleah");
    co_return;
}
int main()
{
    std::cout << compute({}).get() << '\n';
    try
    {
        fail({}).get();
    }
    catch (const std::runtime_error& e)
    {
        std::cout << "error: " << e.was() << '\n';
    }
}

Ausgabe:

42
error: bleah