D++ (DPP)  10.0.30
C++ Discord API Bot Library
dpp::when_any< Args >::awaiter Struct Reference

Object returned by operator co_await(). More...

#include "when_any.h"

Collaboration diagram for dpp::when_any< Args >::awaiter:

Public Member Functions

bool await_ready () const noexcept
 First function called by the standard library when using co_await. More...
 
result await_resume () const noexcept
 Third and final function called by the standard library when using co_await. More...
 
bool await_suspend (detail::std_coroutine::coroutine_handle<> caller) noexcept
 Second function called by the standard library when using co_await. More...
 

Public Attributes

when_anyself
 Pointer to the when_any object. More...
 

Detailed Description

template<typename... Args>
struct dpp::when_any< Args >::awaiter

Object returned by operator co_await().

Meant to be used by the standard library, not by a user.

See also
result

Member Function Documentation

◆ await_ready()

template<typename... Args>
bool dpp::when_any< Args >::awaiter::await_ready ( ) const
inlinenoexcept

First function called by the standard library when using co_await.

Returns
bool Whether the result is ready

◆ await_resume()

template<typename... Args>
result dpp::when_any< Args >::awaiter::await_resume ( ) const
inlinenoexcept

Third and final function called by the standard library when using co_await.

Returns the result object.

See also
result

◆ await_suspend()

template<typename... Args>
bool dpp::when_any< Args >::awaiter::await_suspend ( detail::std_coroutine::coroutine_handle<>  caller)
inlinenoexcept

Second function called by the standard library when using co_await.

Returns
bool Returns false if we want to resume immediately.

Member Data Documentation

◆ self

template<typename... Args>
when_any* dpp::when_any< Args >::awaiter::self

Pointer to the when_any object.


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