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

💅 std::coroutine_handle::promise 💅

okay so this is the std::corout...le::promise(3) page from the C++ Standard Libary manual, and we're talking about the promise accessor on std::coroutine_handle. it's giving tiny function, big coroutine energy. 🦋💖

🌸 NAME 🌸

std::coroutine_handle::promise — literally std::coroutine_handle::promise. that's the whole NAME, bestie. periodt. 💅

✨ Synopsis ✨

Member of the primary template

Promise& promise() const;

(since C++20)

Member of specialization std::coroutine_handle<std::noop_coroutine_promise>

std::noop_coroutine_promise& promise() const noexcept;

(since C++20)

It obtains a reference to the promise object. that's the vibe. 🫶

⚠️ Undefined behavior alert: the behavior is undefined if *this does not refer to a coroutine whose promise object has not been destroyed. like, do not mess with this unless that condition is true, bestie. 😭

This function is not provided for the specialization std::coroutine_handle<>. not here, not today. 🙈

🌸 Parameters 🌸

None. zero. nada. (none) — no parameters at all. 🎀

🎀 Return value 🎀

A reference to the promise object. that's the whole return, and it ate. 💖

🦋 Notes 🦋

The promise object of a no-op coroutine is not destroyed as long as there is some std::noop_coroutine_handle referring to the coroutine. lowkey important, highkey iconic. 🦋

🌈 See also 🌈

• from_promise — creates a coroutine_handle from the promise object of a coroutine. it's [static], it's (C++20), and it's a (public static member function). 👑✨

source/version/date shoutout: http://cppreference.com · 2024.06.10 · std::corout...le::promise(3) — bye bestie, mwah 💋💖