D++ (DPP)
C++ Discord API Bot Library
|
Base implementation of task::promise_t, without the logic that would depend on the return type. Meant to be inherited from. More...
Classes | |
struct | proxy_awaiter |
Proxy awaitable that wraps any co_await inside the task and checks for cancellation on resumption. More... | |
Public Member Functions | |
std_coroutine::suspend_never | initial_suspend () const noexcept |
Function called by the standard library when the coroutine is created. More... | |
void | unhandled_exception () |
Function called by the standard library when an exception is thrown and not caught in the coroutine. More... | |
template<awaitable_type T> | |
auto | await_transform (T &&expr) const noexcept(noexcept(co_await_resolve(std::forward< T >(expr)))) |
Function called whenever co_await is used inside of the task. More... | |
requires (std::constructible_from< R, Args... >) void emplace_value(Args &&... args) | |
Construct the result in place by forwarding the arguments, and by default resume any awaiter. More... | |
requires (std::convertible_to< U &&, R >) void set_value(U &&v) | |
Construct the result by forwarding reference, and resume any awaiter. More... | |
requires (std::is_void_v< R >) void set_value() | |
Construct a void result, and resume any awaiter. More... | |
template<bool Notify = true> | |
void | set_exception (std::exception_ptr ptr) |
Set this promise to an exception and resume any awaiter. More... | |
void | notify_awaiter () |
Notify a currently awaiting coroutine that the result is ready. More... | |
awaitable< T > | get_awaitable () |
Get an awaitable object for this promise. More... | |
Public Attributes | |
std::atomic< bool > | cancelled = false |
Whether the task is cancelled or not. More... | |
Protected Types | |
using | storage_type = result_t< T > |
Variant representing one of either 3 states of the result value : empty, result, exception. More... | |
Protected Member Functions | |
void | throw_if_not_empty () |
Check if the result is empty, throws otherwise. More... | |
std_coroutine::coroutine_handle | release_awaiter () |
Unlinks this promise from its currently linked awaiter and returns it. More... | |
Protected Attributes | |
storage_type | value = std::monostate{} |
State of the result value. More... | |
std::atomic< uint8_t > | state = sf_none |
State of the awaitable tied to this promise. More... | |
std_coroutine::coroutine_handle | awaiter = nullptr |
Coroutine handle currently awaiting the completion of this promise. More... | |
Base implementation of task::promise_t, without the logic that would depend on the return type. Meant to be inherited from.
|
protectedinherited |
Variant representing one of either 3 states of the result value : empty, result, exception.
|
inlinenoexcept |
Function called whenever co_await is used inside of the task.
dpp::task_cancelled_exception | On resumption if the task was cancelled |
|
inlineinherited |
Get an awaitable object for this promise.
dpp::logic_exception | if get_awaitable has already been called on this object. |
|
inlinenoexcept |
Function called by the standard library when the coroutine is created.
|
inlineinherited |
Notify a currently awaiting coroutine that the result is ready.
? | Any exception thrown by the coroutine if resumed will propagate |
|
inlineprotectedinherited |
Unlinks this promise from its currently linked awaiter and returns it.
At the time of writing this is only used in the case of a serious internal error in dpp::task. Avoid using this as this will crash if the promise is used after this.
|
inlineinherited |
Construct the result in place by forwarding the arguments, and by default resume any awaiter.
Notify | Whether to resume any awaiter or not. |
dpp::logic_exception | if the promise is not empty. |
|
inlineinherited |
Construct the result by forwarding reference, and resume any awaiter.
Notify | Whether to resume any awaiter or not. |
dpp::logic_exception | if the promise is not empty. |
|
inlineinherited |
Construct a void result, and resume any awaiter.
Notify | Whether to resume any awaiter or not. |
dpp::logic_exception | if the promise is not empty. |
|
inlineinherited |
Set this promise to an exception and resume any awaiter.
Notify | Whether to resume any awaiter or not. |
dpp::logic_exception | if the promise is not empty. |
? | Any exception thrown by the coroutine if resumed will propagate |
|
inlineprotectedinherited |
Check if the result is empty, throws otherwise.
dpp::logic_exception | if the result isn't empty. |
|
inline |
Function called by the standard library when an exception is thrown and not caught in the coroutine.
Stores the exception pointer to rethrow on co_await. If the task object is destroyed and was not cancelled, throw instead
|
protectedinherited |
Coroutine handle currently awaiting the completion of this promise.
std::atomic<bool> dpp::detail::task::promise_base< R >::cancelled = false |
Whether the task is cancelled or not.
|
protectedinherited |
State of the awaitable tied to this promise.
|
protectedinherited |
State of the result value.