std::coroutine_handle<Promise>::from_promise

From cppreference.com
 
 
Utilities library
General utilities
Date and time
Function objects
Formatting library (C++20)
(C++11)
Relational operators (deprecated in C++20)
Integer comparison functions
(C++20)(C++20)(C++20)   
(C++20)
Swap and type operations
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
Common vocabulary types
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++23)
Elementary string conversions
(C++17)
(C++17)
 
Coroutine support
Coroutine traits
Coroutine handle
No-op coroutines
Trivial awaitables
 
std::coroutine_handle
Member functions
coroutine_handle::from_promise
(C++20)
Conversion
Observers
Control
Promise access
Export/import
Non-member functions
(C++20)(C++20)
Helper classes
 
static coroutine_handle from_promise( Promise& p );
(since C++20)

Creates a coroutine_handle from the promise object of a coroutine. The created coroutine_handle refers the coroutine, and promise() returns a reference to p.

The behavior is undefined if p is not a reference to a promise object. This function is only provided for the primary template, i.e. specializations std::coroutine_handle<> and std::coroutine_handle<std::noop_coroutine_promise> do not have this function.

Parameters

p - promise object of a coroutine to refer

Return value

A coroutine_handle referring the given coroutine.

Example

See also

constructs a coroutine_handle object
(public member function)
[static] (C++20)
imports a coroutine from a pointer
(public static member function)
creates a coroutine handle that has no observable effects when resumed or destroyed
(function)