Standardbibliotheksheader <coroutine> (C++20)

 

C++

Compiler-Unterstützung

Freestanding und gehostet

Sprache

Standardbibliothek

Header der Standardbibliothek

Benannte Anforderungen

Feature-Test-Makros (C++20)

Bibliothek für Sprachunterstützung

Konzepte-Bibliothek (C++20)

Diagnostik-Bibliothek

Speicherverwaltungsbibliothek

Metaprogrammierungsbibliothek (C++11)

Allgemeine Dienstprogramme-Bibliothek

Container-Bibliothek

Iterator-Bibliothek

Ranges-Bibliothek (C++20)

Algorithmen-Bibliothek

Bibliothek für Zeichenketten

Textverarbeitungsbibliothek

Numerik-Bibliothek

Datums- und Zeitbibliothek

Ein-/Ausgabe-Bibliothek

Dateisystembibliothek (C++17)

Unterstützung für nebenläufige Programmierung (C++11)

Ausführungssteuerungsbibliothek (C++26)

Technische Spezifikationen

Symbolverzeichnis

Externe Bibliotheken

 

Header der Standardbibliothek

Sprachunterstützung <cfloat> <climits> <compare> (C++20) <contracts> (C++26) <coroutine> (C++20) <csetjmp> <csignal> <cstdarg> <cstddef> <cstdint> (C++11) <cstdlib> <exception> <initializer_list> (C++11)    <limits> <new> <source_location> (C++20) <stdfloat> (C++23) <typeinfo> <version> (C++20) Konzepte <concepts> (C++20) Diagnose <cassert> <cerrno> <debugging> (C++26) <stacktrace> (C++23) <stdexcept> <system_error> (C++11) Speicherverwaltung <memory> <memory_resource> (C++17) <scoped_allocator> (C++11) Metaprogrammierung <type_traits> (C++11) <ratio> (C++11)

Allgemeine Hilfsmittel <any> (C++17) <bitset> <bit> (C++20) <charconv> (C++17) <expected> (C++23) <format> (C++20) <functional> <optional> (C++17) <tuple> (C++11) <typeindex> (C++11) <utility> <variant> (C++17) Container <array> (C++11) <deque> <flat_map> (C++23) <flat_set> (C++23) <forward_list> (C++11) <hive> (C++26) <inplace_vector> (C++26)    <list> <map> <mdspan> (C++23) <queue> <set> <span> (C++20) <stack> <unordered_map> (C++11) <unordered_set> (C++11) <vector> Iteratoren <iterator> Bereiche (Ranges) <generator> (C++23) <ranges> (C++20)

Algorithmen <algorithm> <numeric> Strings <cctype> <cstring> <cuchar> (C++11) <cwchar> <cwctype> <string_view> (C++17) <string> Textverarbeitung <clocale> <codecvt> (C++11/17/26*) <locale> <regex> (C++11) <text_encoding> (C++26)    Numerik <cfenv> (C++11) <cmath> <complex> <linalg> (C++26) <numbers> (C++20) <random> (C++11) <simd> (C++26) <valarray> Zeit <chrono> (C++11) <ctime> C Kompatibilität <ccomplex> (C++11/17/20*) <ciso646> (bis C++20) <cstdalign> (C++11/17/20*) <cstdbool> (C++11/17/20*) <ctgmath> (C++11/17/20*)

Ein-/Ausgabe <cinttypes> (C++11) <cstdio> <filesystem> (C++17) <fstream> <iomanip> <iosfwd> <iostream> <ios> <istream> <ostream> <print> (C++23) <spanstream> (C++23) <sstream> <streambuf> <strstream> (C++98/26*) <syncstream> (C++20) Nebenläufigkeitsunterstützung <atomic> (C++11) <barrier> (C++20) <condition_variable> (C++11) <future> (C++11) <hazard_pointer> (C++26) <latch> (C++20) <mutex> (C++11) <rcu> (C++26) <semaphore> (C++20) <shared_mutex> (C++14) <stdatomic.h> (C++23) <stop_token> (C++20) <thread> (C++11) Ausführungshilfe <execution> (C++17)

 

Dieser Header ist Teil der Sprachunterstützungsbibliothek.

Includes
<compare> (C++20)	Unterstützung für den Drei-Wege-Vergleichsoperator
Klassen
coroutine_traits (C++20)	Trait-Typ zur Ermittlung von Koroutinen-Promise-Typen (Klassenschablone)
coroutine_handle (C++20)	wird verwendet, um auf eine pausierte oder ausgeführte Koroutine zu verweisen (Klassenschablone)
std::hash<std::coroutine_handle> (C++20)	Hash-Unterstützung für std::coroutine_handle (Klassentemplate-Spezialisierung)
No-op Coroutines (Nulloperationen-Koroutinen)
noop_coroutine_promise (C++20)	Wird für Coroutinen ohne beobachtbare Effekte verwendet (Klasse)
noop_coroutine_handle (C++20)	std::coroutine_handle<std::noop_coroutine_promise>, soll auf eine Nulloperationen-Koroutine verweisen (typedef)
Trivial Awaitables (Triviale Awaitables)
suspend_never (C++20)	Gibt an, dass ein await-Ausdruck niemals pausieren soll (Klasse)
suspend_always (C++20)	Gibt an, dass ein await-Ausdruck immer pausieren soll (Klasse)
Funktionen
operator==operator<=> (C++20)	vergleicht zwei coroutine_handle-Objekte (Funktion)
No-op Coroutines (Nulloperationen-Koroutinen)
noop_coroutine (C++20)	Erzeugt ein Coroutine-Handle, das beim Wiederaufnehmen oder Zerstören keine beobachtbaren Effekte hat (Funktion)

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;
}

Klassenschablone 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 
  };
}

Klasse std::noop_coroutine_promise

namespace std {
  struct noop_coroutine_promise {};
}

Klasse 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 
  };
}

Klasse 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 {}
  };
}

Klasse 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 {}
  };
}