Namespaces
Variants

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

From ja.cppreference.net
Standard library headers

このヘッダは 言語サポート ライブラリの一部です。

目次

インクルード

(C++20)
三方比較演算子 サポート

クラス

コルーチンのプロミス型を発見するためのトレイト型
(クラステンプレート)
中断中または実行中のコルーチンを参照するために使用される
(クラステンプレート)
ハッシュサポート std::coroutine_handle
(クラステンプレートの特殊化)
無操作コルーチン
観測可能な効果のないコルーチンに使用されます
(クラス)
std::coroutine_handle<std::noop_coroutine_promise>, 無操作コルーチンを参照することを目的としています
(型エイリアス)
トリビアルな待機可能オブジェクト
待機式が中断すべきでないことを示す
(class)
待機式が常に中断すべきであることを示す
(class)

関数

2つの coroutine_handle オブジェクトを比較する
(関数)
ノーオペコルーチン
再開または破棄時に観測可能な効果がないコルーチンハンドルを作成する
(関数)

概要

// all freestanding
#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;
}

クラステンプレート 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
  };
}

クラス std::noop_coroutine_promise

namespace std {
  struct noop_coroutine_promise {};
}

クラス 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
  };
}

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

クラス 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 {}
  };
}