std::suspend_always(3)

💅 std::suspend_always 💅

okay so bestie, welcome to the std::suspend_always(3) page from the C++ Standard Libary manual — yes, that's the manual name, and we're folding it in right here instead of copying the header line. This class is literally giving “always suspend, bestie” main character energy. 🦋

---

🎀 NAME 🎀

std::suspend_always - std::suspend_always (yes, the NAME line says the same thing twice, and honestly? iconic.) ✨

✨ Synopsis ✨

Defined in header <coroutine>:

struct suspend_always;

(since C++20)

suspend_always is an empty class which can be used to indicate that an await expression always suspends and does not produce a value. No cap, that's the whole point. 💅

💖 Member functions 💖

• await_ready — indicates that an await expression always suspends (C++20) (public member function)
• await_suspend — no-op (C++20) (public member function)
• await_resume — no-op (C++20) (public member function)

🌸 std::suspend_always::await_ready 🌸

constexpr bool await_ready() const noexcept { return false; }

(since C++20)

Always returns false, indicating that an await expression always suspends. It's literally saying “nope, we're pausing” every single time. 😭

🦋 std::suspend_always::await_suspend 🦋

constexpr void await_suspend( std::coroutine_handle<> ) const noexcept {}

(since C++20)

Does nothing. Like, absolutely nothing. A perfect little no-op. 💀

🍓 std::suspend_always::await_resume 🍓

constexpr void await_resume() const noexcept {}

(since C++20)

Does nothing. An await expression does not produce a value if suspend_always is used. So if you were waiting for a lil return value, bestie, there isn't one. 🙈

🌈 Example 🌈

This section is incomplete Reason: no example

🔥 See also 🔥

• suspend_never — indicates that an await-expression should never suspend (C++20) (class)

🏷️ Category: 🏷️

• Todo no example

---

xoxo, your cppreference.com bestie 💋 — source http://cppreference.com, date 2024.06.10, page std::suspend_always(3). 🫶