dpp::detail::coroutine::promise_t< R > Struct Template Reference

Promise type for coroutine. More...

#include "coroutine.h"

Collaboration diagram for dpp::detail::coroutine::promise_t< R >:

Public Member Functions
final_awaiter< R >	final_suspend () const noexcept
	Function called by the standard library when reaching the end of a coroutine. More...
dpp::coroutine< R >	get_return_object ()
	Function called to get the coroutine object. More...
std_coroutine::suspend_always	initial_suspend () const noexcept
	Function called by the standard library when the coroutine start. More...
void	return_value (R &&expr) noexcept(std::is_nothrow_move_constructible_v< R >) requires std
	Function called by the standard library when the coroutine co_returns a value. More...
void	unhandled_exception () noexcept
	Function called when an exception escapes the coroutine. More...

Public Attributes
std::exception_ptr	exception {nullptr}
	Pointer to an uncaught exception thrown by the coroutine. More...
std_coroutine::coroutine_handle	parent {nullptr}
	Handle of the coroutine co_await-ing this coroutine. More...
std::optional< R >	result {}
	Return value of the coroutine. More...

Detailed Description

template<typename R>
struct dpp::detail::coroutine::promise_t< R >

Promise type for coroutine.

Member Function Documentation

final_suspend()

template<typename R >

final_awaiter< R > dpp::detail::coroutine::promise_t< R >::final_suspend

noexcept

Function called by the standard library when reaching the end of a coroutine.

Returns

final_awaiter<R> Resumes any coroutine co_await-ing on this

get_return_object()

template<typename R >

dpp::coroutine<R> dpp::detail::coroutine::promise_t< R >::get_return_object ( )

inline

Function called to get the coroutine object.

initial_suspend()

template<typename R >

std_coroutine::suspend_always dpp::detail::coroutine::promise_t< R >::initial_suspend ( ) const

inlinenoexcept

Function called by the standard library when the coroutine start.

Returns

std::suspend_always Always suspend at the start, for a lazy start

return_value()

template<typename R >

void dpp::detail::coroutine::promise_t< R >::return_value ( R &&  expr )

inlinenoexcept

Function called by the standard library when the coroutine co_returns a value.

Stores the value internally to hand to the caller when it resumes.

Parameters

expr	The value given to co_return

Function called by the standard library when the coroutine co_returns a value.

Stores the value internally to hand to the caller when it resumes.

Parameters

expr	The value given to co_return

Function called by the standard library when the coroutine co_returns a value.

Stores the value internally to hand to the caller when it resumes.

Parameters

expr	The value given to co_return

References dpp::detail::coroutine::promise_t< R >::result.

unhandled_exception()

template<typename R >

void dpp::detail::coroutine::promise_t< R >::unhandled_exception ( )

inlinenoexcept

Function called when an exception escapes the coroutine.

Stores the exception to throw to the co_await-er

Member Data Documentation

exception

template<typename R >

std::exception_ptr dpp::detail::coroutine::promise_t< R >::exception {nullptr}

Pointer to an uncaught exception thrown by the coroutine.

parent

template<typename R >

std_coroutine::coroutine_handle dpp::detail::coroutine::promise_t< R >::parent {nullptr}

Handle of the coroutine co_await-ing this coroutine.

result

template<typename R >

std::optional<R> dpp::detail::coroutine::promise_t< R >::result {}

Return value of the coroutine.

Referenced by dpp::detail::coroutine::promise_t< R >::return_value().

---

The documentation for this struct was generated from the following file:

• coroutine.h