std::corout...le::destroy(3)

✨ std::coroutine_handle::destroy ✨

okay so bestie, this is the std::corout...le::destroy(3) page from the C++ Standard Libary — yes, that's the manual name, spelled exactly like that. 🫶 No cap.

💖 NAME 💖

std::coroutine_handle::destroy — and yep, the name literally repeats: std::coroutine_handle::destroy. That's the whole entry. Main character energy, honestly. 💅

🌸 Synopsis 🌸

There are two versions listed, and here's the exact synopsis, bestie:

Member of other specializations
void destroy() const;
(1) (since C++20)

Member of specialization
std::coroutine_handle<std::noop_coroutine_promise>
constexpr void destroy() const noexcept;
(2) (since C++20)

1. This one destroys the coroutine state of the coroutine to which *this refers, or does nothing if the coroutine is a no-op coroutine.
2. This one does nothing. Periodt.

⚠️ The behavior is undefined if destroying is needed and *this does not refer to a suspended coroutine. Like, actually undefined — not "oopsie" undefined. Be careful. 😭

🎀 Parameters 🎀

(none) — literally zero parameters. Not a single one. ✨

🦋 Return value 🦋

(none) — nada comes back. Zero return value. 💀

🌈 Example 🌈

This section is incomplete Reason: no example

not a single example in sight 😭 we're just gonna sit with that.

👑 See also 👑

• operator() resumes execution of the coroutine
• resume (public member function) (C++20)

🍓 Category 🍓

• Todo no example

mwah 💋 shoutout to the source: http://cppreference.com, version/date 2024.06.10, page std::corout...le::destroy(3). That's the sign-off, bestie. 💖