v1::scoped_task< void > Class Reference

#include <hikogui/scoped_task.hpp>

Data Structures
struct	promise_type

Public Types
using	value_type = void
using	notifier_type = notifier<>
using	handle_type = std::coroutine_handle<promise_type>

Public Member Functions
	scoped_task (handle_type coroutine) noexcept
	scoped_task (scoped_task const &)=delete
scoped_task &	operator= (scoped_task const &)=delete
	scoped_task (scoped_task &&other) noexcept
scoped_task &	operator= (scoped_task &&other) noexcept
bool	done () const noexcept
	operator bool () const noexcept
void	value () const
	Get the return value returned from co_return.
notifier_type::token_type	subscribe (callback_flags flags, std::invocable<> auto &&callback) noexcept
notifier_type::token_type	subscribe (std::invocable<> auto &&callback) noexcept

Detailed Description

See also

scoped_task<>

Member Function Documentation

done()

bool v1::scoped_task< void >::done ( ) const

inlinenoexcept

See also

scoped_task<>::completed()

operator bool()

v1::scoped_task< void >::operator bool ( ) const

inlineexplicitnoexcept

See also

scoped_task<>::operator bool()

subscribe() [1/2]

notifier_type::token_type v1::scoped_task< void >::subscribe ( callback_flags flags, std::invocable<> auto && callback )

inlinenoexcept

See also

notifier<>::subscribe()

subscribe() [2/2]

notifier_type::token_type v1::scoped_task< void >::subscribe ( std::invocable<> auto && callback )

inlinenoexcept

See also

notifier<>::subscribe()

value()

void v1::scoped_task< void >::value ( ) const

inline

Get the return value returned from co_return.

Note

It is undefined behavior to call this function if the co-routine is incomplete.

Returns

void

Exceptions

The	exception thrown from the co-routine.

---

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

• hikogui/src/hikogui/scoped_task.hpp