std::coroutine_traits
来自 cppreference.com
在头文件 <coroutine> 中定义 |
||
template< class R, class... Args > struct coroutine_traits; |
(自 C++20 起) | |
从协程的返回类型和参数类型确定 promise 类型。标准库实现提供了一个公开可访问的成员类型 promise_type
,与 R::promise_type
相同,如果限定 ID 有效并且表示一个类型。否则,它没有这样的成员。
程序定义的专业化 coroutine_traits
必须定义一个公开可访问的嵌套类型 promise_type
,否则程序格式错误。
内容 |
[编辑] 模板参数
R | - | 协程的返回类型 |
Args | - | 协程的参数类型,包括 隐式对象参数,如果协程是非静态成员函数 |
[编辑] 嵌套类型
名称 | 定义 |
promise_type
|
R::promise_type 如果它有效,或由程序定义的专业化提供 |
[编辑] 可能的实现
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...> {}; |
[编辑] 备注
如果协程是非静态成员函数,则 Args...
中的第一个类型是隐式对象参数的类型,其余是函数的参数类型(如果有)。
如果 std::coroutine_traits<R, Args...>::promise_type
不存在或不是类类型,则相应的协程定义格式错误。
用户可以根据程序定义的类型定义 coroutine_traits
的显式或部分专业化,以避免对返回类型进行修改。
[编辑] 示例
运行此代码
#include <chrono> #include <coroutine> #include <exception> #include <future> #include <iostream> #include <thread> #include <type_traits> // A program-defined type on which the coroutine_traits specializations below depend struct as_coroutine {}; // Enable the use of std::future<T> as a coroutine type // by using a std::promise<T> as the promise type. 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()); } }; }; // Same for 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()); } }; }; // Allow co_await'ing std::future<T> and std::future<void> // by naively spawning a new thread for each 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; } 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) }; } // Utilize the infrastructure we have established. 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.what() << '\n'; } }
输出
42 error: bleah