CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::ResumableFunction Class Referencefinal

Holds the resumable function's handle. More...

#include <CeresEngine/Foundation/Coroutine.hpp>

Classes

class  promise_type
 

Public Member Functions

 ResumableFunction () noexcept=default
 
 ResumableFunction (promise_type *ptr) noexcept
 
auto get () const noexcept
 
 operator CoroutineHandle< void > () const noexcept
 
const CoroutineHandle< void > * operator-> () const noexcept
 
CoroutineHandle< void > * operator-> () noexcept
 
const CoroutineHandle< void > & operator* () const noexcept
 
CoroutineHandle< void > & operator* () noexcept
 

Private Attributes

CoroutineHandle< voidhandle = nullptr
 

Detailed Description

Holds the resumable function's handle.

This type can be used when final suspend is required.

Constructor & Destructor Documentation

◆ ResumableFunction() [1/2]

CeresEngine::ResumableFunction::ResumableFunction ( )
defaultnoexcept

◆ ResumableFunction() [2/2]

CeresEngine::ResumableFunction::ResumableFunction ( promise_type ptr)
inlineexplicitnoexcept

Member Function Documentation

◆ get()

auto CeresEngine::ResumableFunction::get ( ) const
inlinenoexcept

◆ operator CoroutineHandle< void >()

CeresEngine::ResumableFunction::operator CoroutineHandle< void > ( ) const
inlineexplicitnoexcept

◆ operator*() [1/2]

const CoroutineHandle< void > & CeresEngine::ResumableFunction::operator* ( ) const
inlinenoexcept

◆ operator*() [2/2]

CoroutineHandle< void > & CeresEngine::ResumableFunction::operator* ( )
inlinenoexcept

◆ operator->() [1/2]

const CoroutineHandle< void > * CeresEngine::ResumableFunction::operator-> ( ) const
inlinenoexcept

◆ operator->() [2/2]

CoroutineHandle< void > * CeresEngine::ResumableFunction::operator-> ( )
inlinenoexcept

Member Data Documentation

◆ handle

CoroutineHandle<void> CeresEngine::ResumableFunction::handle = nullptr
private

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