Namespaces
Variants

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

From es.cppreference.net
Standard library headers

Este encabezado es parte de la biblioteca de soporte del lenguaje .

Contenido

Incluye

(C++20)
operador de comparación de tres vías soporte

Clases

tipo de rasgo para descubrir tipos de promesa de corrutina
(plantilla de clase)
se utiliza para referirse a una corrutina suspendida o en ejecución
(plantilla de clase)
soporte de hash para std::coroutine_handle
(especialización de plantilla de clase)
Corrutinas no-op
usado para corrutinas sin efectos observables
(clase)
std::coroutine_handle<std::noop_coroutine_promise>, destinado a referirse a una corrutina no-op
(typedef)
Awaitables triviales
indica que una expresión await nunca debe suspenderse
(clase)
indica que una expresión await siempre debe suspenderse
(clase)

Funciones

compara dos coroutine_handle objetos
(función)
Corrutinas no-op
crea un identificador de corrutina que no tiene efectos observables cuando se reanuda o destruye
(función)

Sinopsis

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

Plantilla de clase 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
  };
}

Clase std::noop_coroutine_promise

namespace std {
  struct noop_coroutine_promise {};
}

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

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

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