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

A task's promise_t type, with special logic for handling nested tasks. More...

#include "task.h"

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

Public Member Functions
	~promise_t ()
	Destructor. More...
final_awaiter< R >	final_suspend () const noexcept
	Function called by the standard library when the coroutine reaches its last suspension point. More...
dpp::task< R >	get_return_object () noexcept
	Function called by the standard library when the coroutine is created. 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...

Public Attributes
std::array< std::byte, sizeof(R)>	result_storage
	Stored return value of the coroutine. More...

Detailed Description

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

A task's promise_t type, with special logic for handling nested tasks.

Implementation of task::promise_t for non-void return type.

Template Parameters

R	Return type of the task

Constructor & Destructor Documentation

~promise_t()

template<typename R >

dpp::detail::task::promise_t< R >::~promise_t ( )

inline

Destructor.

Destroys the value if it was constructed.

References dpp::detail::task::done, and dpp::detail::task::promise_t< R >::result_storage.

Member Function Documentation

final_suspend()

template<typename R >

final_awaiter<R> dpp::detail::task::promise_t< R >::final_suspend ( ) const

inlinenoexcept

Function called by the standard library when the coroutine reaches its last suspension point.

Returns

final_awaiter Special object containing the chain resolution and clean-up logic.

get_return_object()

template<typename R >

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

inlinenoexcept

Function called by the standard library when the coroutine is created.

Returns

dpp::task The coroutine object

return_value()

template<typename R >

void dpp::detail::task::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::task::promise_t< R >::result_storage.

Member Data Documentation

result_storage

template<typename R >

std::array<std::byte, sizeof(R)> dpp::detail::task::promise_t< R >::result_storage

Stored return value of the coroutine.

Referenced by dpp::detail::task::promise_t< R >::return_value(), and dpp::detail::task::promise_t< R >::~promise_t().

---

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

• task.h