Namespaces
Variants
Views
Actions

Standard library header <coroutine> (C++20)

From cppreference.com
< cpp‎ | header
 
 
Standard library headers
Language support
<coroutine> (C++20)
<csignal>
<csetjmp>
<cstdarg>

Concepts
<concepts> (C++20)
Diagnostics
<system_error> (C++11)

Memory management
<memory_resource> (C++17)  
Metaprogramming
<type_traits> (C++11)
<ratio> (C++11)
General utilities
<utility>
<tuple> (C++11)
<optional> (C++17)
<variant> (C++17)
<any> (C++17)
<debugging> (C++26)
<expected> (C++23)
<bitset>
<charconv> (C++17)
<format> (C++20)
<bit> (C++20)

Strings
<cuchar> (C++11)

Containers
<flat_set> (C++23)
<span> (C++20)
<mdspan> (C++23)

Iterators
<iterator>
Ranges
<ranges> (C++20)
<generator> (C++23)
Algorithms
Numerics
<cfenv> (C++11)
<complex>
<cmath>
<linalg> (C++26)
<numbers> (C++20)

Time
<chrono> (C++11)
Localization
<codecvt> (C++11/17/26*)
<text_encoding> (C++26)
Input/output
<filesystem> (C++17)
<cstdio>
<cinttypes> (C++11)
<strstream> (C++98*)
Regular expressions
<regex> (C++11)
Concurrency support
<stop_token> (C++20)
<thread> (C++11)
<atomic> (C++11)
<rcu> (C++26)
<stdatomic.h> (C++23)
<mutex> (C++11)
<shared_mutex> (C++14)

<condition_variable> (C++11)  
<semaphore> (C++20)
<latch> (C++20)

<barrier> (C++20)
<future> (C++11)
<hazard_pointer> (C++26)

C compatibility
<cstdbool> (C++11/17/20*)  
<ccomplex> (C++11/17/20*)
<ctgmath> (C++11/17/20*)

<cstdalign> (C++11/17/20*)

<ciso646> (until C++20)

 

This header is part of the coroutine support library.

Contents

Includes

(C++20)
Three-way comparison operator support[edit]

Classes

trait type for discovering coroutine promise types
(class template) [edit]
used to refer to a suspended or executing coroutine
(class template) [edit]
hash support for std::coroutine_handle
(class template specialization) [edit]
No-op Coroutines
used for coroutines with no observable effects
(class) [edit]
std::coroutine_handle<std::noop_coroutine_promise>, intended to refer to a no-op coroutine
(typedef) [edit]
Trivial Awaitables
indicates that an await-expression should never suspend
(class) [edit]
indicates that an await-expression should always suspend
(class) [edit]

Functions

compares two coroutine_handle objects
(function) [edit]
No-op Coroutines
creates a coroutine handle that has no observable effects when resumed or destroyed
(function) [edit]

[edit] Synopsis

#include <compare>
 
namespace std {
  // coroutine traits
  template<class R, class... ArgTypes>
    struct coroutine_traits;
 
  // coroutine handle
  template<class Promise = void>
    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<class T> struct hash;
  template<class P> struct hash<coroutine_handle<P>>;
 
  // no-op coroutines
  struct noop_coroutine_promise;
 
  template<> struct coroutine_handle<noop_coroutine_promise>;
  using noop_coroutine_handle = coroutine_handle<noop_coroutine_promise>;
 
  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<void>
  {
    // 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<class Promise>
  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<noop_coroutine_promise>
  {
    // 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 {}
  };
}