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	callback_token = notifier_type::callback_token
using	callback_proto = notifier_type::callback_proto
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.
callback_token	subscribe (forward_of< callback_proto > auto &&callback, callback_flags flags=callback_flags::synchronous) noexcept
value_type const &	operator* () const
	Get the return value returned from co_return.

Detailed Description

See also

scoped_task<>

Member Function Documentation

done()

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

inlinenodiscardnoexcept

See also

scoped_task<>::completed()

operator bool()

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

inlineexplicitnoexcept

See also

scoped_task<>::operator bool()

operator*()

value_type const & v1::scoped_task< void >::operator* ( ) const

inlinenodiscard

Get the return value returned from co_return.

Note

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

Exceptions

The	exception thrown from the co-routine.

subscribe()

callback_token v1::scoped_task< void >::subscribe ( forward_of< callback_proto > auto && callback, callback_flags flags = callback_flags::synchronous )

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.

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