std::coroutine_handle<Promise>::done

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Utilities library

Language support Type support (basic types, RTTI) Library feature-test macros (C++20) Dynamic memory management Program utilities Coroutine support (C++20) Variadic functions is_constant_evaluated (C++20) launder (C++17) initializer_list (C++11) source_location (C++20) Three-way comparison (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)    is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

General utilities Date and time Function objects Formatting library (C++20) bitset hash (C++11) Relational operators (deprecated in C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Integer comparison functions cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)    cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Swap and type operations swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Common vocabulary types pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) Elementary string conversions to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

Coroutine support

Coroutine traits

coroutine_traits (C++20)

Coroutine handle

coroutine_handle (C++20)

No-op coroutines

noop_coroutine_promise (C++20)

noop_coroutine (C++20)

Trivial awaitables

suspend_never (C++20)

suspend_always (C++20)

 

std::coroutine_handle

Member functions

coroutine_handle::coroutine_handle (C++20)

coroutine_handle::operator= (C++20)

coroutine_handle::from_promise (C++20)

Conversion

coroutine_handle::operator coroutine_handle<> (C++20)

Observers

coroutine_handle::done (C++20)

coroutine_handle::operator bool (C++20)

Control

coroutine_handle::operator()coroutine_handle::resume (C++20)(C++20)

coroutine_handle::destroy (C++20)

Promise access

coroutine_handle::promise (C++20)

Export/import

coroutine_handle::address (C++20)

coroutine_handle::from_address (C++20)

Non-member functions

operator==operator<=> (C++20)(C++20)

Helper classes

std::hash<std::coroutine_handle> (C++20)

 

Member of other specializations
bool done() const;	(1)	(since C++20)
Member of specialization std::coroutine_handle<std::noop_coroutine_promise>
constexpr bool done() const noexcept;	(2)	(since C++20)

Checks if a suspended coroutine is suspended at its final suspended point.

1) Returns true if the coroutine to which *this refers is suspended at its final suspend point, or false if the coroutine is suspended at other suspend points. The behavior is undefined if *this does not refer to a suspended coroutine.

2) Always returns false.

Parameters

(none)

Return value

1) true if the coroutine is suspended at its final suspend point, false if the coroutine is suspended at other suspend points.

2) false.

Notes

A no-op coroutine is always considered not suspended at its final suspended point.