uvco::MultiPromise< T >::MultiPromiseAwaiter_ Struct Reference

#include <multipromise.h>

Collaboration diagram for uvco::MultiPromise< T >::MultiPromiseAwaiter_:

Public Member Functions
constexpr	MultiPromiseAwaiter_ (PromiseCore_ *core)
	MultiPromiseAwaiter_ (MultiPromiseAwaiter_ &&)=delete
	MultiPromiseAwaiter_ (const MultiPromiseAwaiter_ &)=delete
MultiPromiseAwaiter_ &	operator= (MultiPromiseAwaiter_ &&)=delete
MultiPromiseAwaiter_ &	operator= (const MultiPromiseAwaiter_ &)=delete
	~MultiPromiseAwaiter_ ()=default
bool	await_ready () const
std::coroutine_handle	await_suspend (std::coroutine_handle<> handle) const
std::optional< T >	await_resume () const

Public Attributes
PromiseCore_ *	core_

Detailed Description

template<typename T>
struct uvco::MultiPromise< T >::MultiPromiseAwaiter_

A MultiPromiseAwaiter_ handles suspension and resumption of coroutines receiving values from a generating (yielding) coroutine. This awaiter is used when applying the co_await operator on a MultiPromise.

Constructor & Destructor Documentation

MultiPromiseAwaiter_() [1/3]

template<typename T>

uvco::MultiPromise< T >::MultiPromiseAwaiter_::MultiPromiseAwaiter_ ( PromiseCore_ * core )

inlineexplicitconstexpr

: core_{core} {}

MultiPromiseAwaiter_() [2/3]

template<typename T>

uvco::MultiPromise< T >::MultiPromiseAwaiter_::MultiPromiseAwaiter_ ( MultiPromiseAwaiter_ && )

delete

MultiPromiseAwaiter_() [3/3]

template<typename T>

uvco::MultiPromise< T >::MultiPromiseAwaiter_::MultiPromiseAwaiter_ ( const MultiPromiseAwaiter_ & )

delete

~MultiPromiseAwaiter_()

template<typename T>

uvco::MultiPromise< T >::MultiPromiseAwaiter_::~MultiPromiseAwaiter_ ( )

default

Member Function Documentation

await_ready()

template<typename T>

bool uvco::MultiPromise< T >::MultiPromiseAwaiter_::await_ready ( ) const

inlinenodiscard

Part of the coroutine protocol. Returns true if the MultiPromise already has a value.

                                           {
      return core_ == nullptr || core_->isTerminated() ||
             core_->slot.has_value();
    }

await_resume()

template<typename T>

std::optional< T > uvco::MultiPromise< T >::MultiPromiseAwaiter_::await_resume ( ) const

inline

Part of the coroutine protocol. Returns a value if co_yield was called in the generating coroutine. Otherwise, returns an empty optional if the generating coroutine has co_returned.

If an exception has been thrown, repeatedly rethrows this exception upon awaiting.

                                        {
      if (core_ == nullptr) {
        return std::nullopt;
      }
      if (!core_->slot) {
        // Terminated by co_return
        return std::nullopt;
      }
      switch (core_->slot->index()) {
      [[likely]] case 0: {
        std::optional<T> result = std::move(std::get<0>(core_->slot.value()));
        core_->slot.reset();
        return std::move(result);
      }
      case 1:
        // Terminated by exception
        BOOST_ASSERT(core_->isTerminated());
        std::rethrow_exception(std::get<1>(core_->slot.value()));
      default:
        throw UvcoException("MultiPromiseAwaiter_::await_resume: invalid slot");
      }
    }

await_suspend()

template<typename T>

std::coroutine_handle uvco::MultiPromise< T >::MultiPromiseAwaiter_::await_suspend ( std::coroutine_handle<> handle ) const

inlinenodiscard

Part of the coroutine protocol. Always returns true; stores the suspension handle in the MultiPromiseCore for later resumption.

                                                      {
      if (core_ == nullptr) {
        return Loop::getNext();
      }
      BOOST_ASSERT_MSG(!core_->isAwaited(),
                       "promise is already being waited on!\n");
      core_->setHandle(handle);
      core_->resumeGenerator();
      return Loop::getNext();
    }

operator=() [1/2]

template<typename T>

MultiPromiseAwaiter_ & uvco::MultiPromise< T >::MultiPromiseAwaiter_::operator= ( const MultiPromiseAwaiter_ & )

delete

operator=() [2/2]

template<typename T>

MultiPromiseAwaiter_ & uvco::MultiPromise< T >::MultiPromiseAwaiter_::operator= ( MultiPromiseAwaiter_ && )

delete

Member Data Documentation

core_

template<typename T>

PromiseCore_* uvco::MultiPromise< T >::MultiPromiseAwaiter_::core_

---

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

• uvco/promise/multipromise.h