kcenon::container::async::detail::generator_promise< T > Struct Template Reference

Promise type for generator. More...

#include <generator.h>

Collaboration diagram for kcenon::container::async::detail::generator_promise< T >:

Public Types
using	value_type = std::remove_reference_t<T>
using	reference_type = std::conditional_t<std::is_reference_v<T>, T, T&>
using	pointer_type = value_type*

Public Member Functions
generator< T >	get_return_object () noexcept
	Get return object (the generator)
std::suspend_always	initial_suspend () noexcept
	Suspend at start - generators are lazy.
std::suspend_always	final_suspend () noexcept
	Suspend at final point.
std::suspend_always	yield_value (value_type &value) noexcept
	Yield a value.
std::suspend_always	yield_value (value_type &&value) noexcept
	Yield an rvalue.
void	return_void () noexcept
	Generators don't return values directly.
void	unhandled_exception () noexcept
	Handle unhandled exceptions.
reference_type	value () const noexcept
	Get the current value.
void	rethrow_if_exception ()
	Rethrow stored exception if any.

Public Attributes
pointer_type	current_value_ {nullptr}
std::exception_ptr	exception_

Detailed Description

template<typename T>
struct kcenon::container::async::detail::generator_promise< T >

Promise type for generator.

Definition at line 51 of file generator.h.

Member Typedef Documentation

pointer_type

template<typename T >

using kcenon::container::async::detail::generator_promise< T >::pointer_type = value_type*

Definition at line 55 of file generator.h.

reference_type

template<typename T >

using kcenon::container::async::detail::generator_promise< T >::reference_type = std::conditional_t<std::is_reference_v<T>, T, T&>

Definition at line 54 of file generator.h.

value_type

template<typename T >

using kcenon::container::async::detail::generator_promise< T >::value_type = std::remove_reference_t<T>

Definition at line 53 of file generator.h.

Member Function Documentation

final_suspend()

template<typename T >

std::suspend_always kcenon::container::async::detail::generator_promise< T >::final_suspend ( )

inlinenodiscardnoexcept

Suspend at final point.

Definition at line 76 of file generator.h.

            {
                return {};
            }

get_return_object()

template<typename T >

generator< T > kcenon::container::async::detail::generator_promise< T >::get_return_object ( )

nodiscardnoexcept

Get return object (the generator)

Definition at line 333 of file generator.h.

    {
        return generator<T>{
            std::coroutine_handle<detail::generator_promise<T>>::from_promise(*this)};
    }

initial_suspend()

template<typename T >

std::suspend_always kcenon::container::async::detail::generator_promise< T >::initial_suspend ( )

inlinenodiscardnoexcept

Suspend at start - generators are lazy.

Definition at line 68 of file generator.h.

            {
                return {};
            }

rethrow_if_exception()

template<typename T >

void kcenon::container::async::detail::generator_promise< T >::rethrow_if_exception ( )

inline

Rethrow stored exception if any.

Definition at line 123 of file generator.h.

            {
                if (exception_)
                {
                    std::rethrow_exception(exception_);
                }
            }

References kcenon::container::async::detail::generator_promise< T >::exception_.

return_void()

template<typename T >

void kcenon::container::async::detail::generator_promise< T >::return_void ( )

inlinenoexcept

Generators don't return values directly.

Definition at line 102 of file generator.h.

{}

unhandled_exception()

template<typename T >

void kcenon::container::async::detail::generator_promise< T >::unhandled_exception ( )

inlinenoexcept

Handle unhandled exceptions.

Definition at line 107 of file generator.h.

            {
                exception_ = std::current_exception();
            }

References kcenon::container::async::detail::generator_promise< T >::exception_.

value()

template<typename T >

reference_type kcenon::container::async::detail::generator_promise< T >::value ( ) const

inlinenodiscardnoexcept

Get the current value.

Definition at line 115 of file generator.h.

            {
                return *current_value_;
            }

References kcenon::container::async::detail::generator_promise< T >::current_value_.

yield_value() [1/2]

template<typename T >

std::suspend_always kcenon::container::async::detail::generator_promise< T >::yield_value ( value_type && value )

inlinenoexcept

Yield an rvalue.

Definition at line 93 of file generator.h.

            {
                current_value_ = std::addressof(value);
                return {};
            }

References kcenon::container::async::detail::generator_promise< T >::current_value_.

yield_value() [2/2]

template<typename T >

std::suspend_always kcenon::container::async::detail::generator_promise< T >::yield_value ( value_type & value )

inlinenoexcept

Yield a value.

Definition at line 84 of file generator.h.

            {
                current_value_ = std::addressof(value);
                return {};
            }

References kcenon::container::async::detail::generator_promise< T >::current_value_.

Member Data Documentation

current_value_

template<typename T >

pointer_type kcenon::container::async::detail::generator_promise< T >::current_value_ {nullptr}

Definition at line 57 of file generator.h.

{nullptr};

Referenced by kcenon::container::async::detail::generator_promise< T >::value(), kcenon::container::async::detail::generator_promise< T >::yield_value(), and kcenon::container::async::detail::generator_promise< T >::yield_value().

exception_

template<typename T >

std::exception_ptr kcenon::container::async::detail::generator_promise< T >::exception_

Definition at line 58 of file generator.h.

Referenced by kcenon::container::async::detail::generator_promise< T >::rethrow_if_exception(), and kcenon::container::async::detail::generator_promise< T >::unhandled_exception().

---

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

• internal/async/generator.h