Standard library header  (C++20) (original) (raw)

This header is part of the language support library.

[edit] Synopsis

#include   namespace std { // coroutine traits template<class R, class... ArgTypes> struct coroutine_traits;   // coroutine handle template struct coroutine_handle;   // comparison operators constexpr bool operator==(coroutine_handle<> x, coroutine_handle<> y) noexcept; constexpr strong_ordering operator<=>(coroutine_handle<> x, coroutine_handle<> y) noexcept;   // hash support template struct hash; template struct hash<coroutine_handle

>;   // no-op coroutines struct noop_coroutine_promise;   template<> struct coroutine_handle; using noop_coroutine_handle = coroutine_handle;   noop_coroutine_handle noop_coroutine() noexcept;   // trivial awaitables struct suspend_never; struct suspend_always; }

[edit] Class template std::coroutine_handle

namespace std { template<> struct coroutine_handle { // construct/reset constexpr coroutine_handle() noexcept; constexpr coroutine_handle(nullptr_t) noexcept; coroutine_handle& operator=(nullptr_t) noexcept;   // export/import constexpr void* address() const noexcept; static constexpr coroutine_handle from_address(void* addr);   // observers constexpr explicit operator bool() const noexcept; bool done() const;   // resumption void operator()() const; void resume() const; void destroy() const;   private: void* ptr; // exposition only };   template struct coroutine_handle { // construct/reset constexpr coroutine_handle() noexcept; constexpr coroutine_handle(nullptr_t) noexcept; static coroutine_handle from_promise(Promise&); coroutine_handle& operator=(nullptr_t) noexcept;   // export/import constexpr void* address() const noexcept; static constexpr coroutine_handle from_address(void* addr);   // conversion constexpr operator coroutine_handle<>() const noexcept;   // observers constexpr explicit operator bool() const noexcept; bool done() const;   // resumption void operator()() const; void resume() const; void destroy() const;   // promise access Promise& promise() const;   private: void* ptr; // exposition only }; }

[edit] Class std::noop_coroutine_promise

namespace std { struct noop_coroutine_promise {}; }

[edit] Class std::coroutine_handle<std::noop_coroutine_promise>

namespace std { template<> struct coroutine_handle { // conversion constexpr operator coroutine_handle<>() const noexcept;   // observers constexpr explicit operator bool() const noexcept; constexpr bool done() const noexcept;   // resumption constexpr void operator()() const noexcept; constexpr void resume() const noexcept; constexpr void destroy() const noexcept;   // promise access noop_coroutine_promise& promise() const noexcept;   // address constexpr void* address() const noexcept; private: coroutine_handle(/* unspecified /); void ptr; // exposition only }; }

[edit] Class std::suspend_never

namespace std { struct suspend_never { constexpr bool await_ready() const noexcept { return true; } constexpr void await_suspend(coroutine_handle<>) const noexcept {} constexpr void await_resume() const noexcept {} }; }

[edit] Class std::suspend_always

namespace std { struct suspend_always { constexpr bool await_ready() const noexcept { return false; } constexpr void await_suspend(coroutine_handle<>) const noexcept {} constexpr void await_resume() const noexcept {} }; }