std::genera...romise_type(3)

💅 NAME

std::generator::promise_type — bestie, this is literally std::generator::promise_type, the promise type situation for std::generator 🌸 (yes, the C++ Standard Library page, we're in the big leagues now)

This page lives in the C++ Standard Library section of the cppreference man pages — ok so now you know where you are, let's go ✨

---

✨ SYNOPSIS ✨

class generator<Ref, V, Allocator>::promise_type;  (since C++23)

That's it, that's the declaration 🎀 since C++23 — so if you're on an older standard, she is not here for you yet, no cap.

The promise type of std::generator. Like, that's her whole job description 💅

---

🌈 MEMBER FUNCTIONS 🌈

Ok bestie this is the part you actually came for, the whole roster, everybody's here, nobody gets left out 🫶

• constructor — constructs the promise_type object, and note that she's (implicitly declared) and a (public member function) 🎀
• destructor — destroys the promise_type object, also (implicitly declared), also (public member function) 💀
• get_return_object — issues the generator object (public member function) 👑
• initial_suspend — issues an awaiter for initial suspend point (public member function) ⭐
• final_suspend — issues an awaiter for final suspend point (public member function) 🔥
• yield_value — processes the object obtained from co_yield (public member function) 🍓
• await_transform — maps the object obtained from co_await to an awaiter — and heads up, this one is marked [deleted] (public member function) 🙈 iykyk, she's not available
• return_void — handles co_return; or the exit out of coroutine's body (public member function) 💖
• unhandled_exception — processes exceptions that leaked from the coroutine's body (public member function) 😭
• operator new — allocates memory using Allocator, marked [static] and (C++23) (public static member function) ✨
• operator delete — deallocates memory previously obtained from operator new, marked [static] and (C++23) (public static member function) 🧚

---

🦋 EXAMPLE 🦋

Ok so bestie, I have to be honest with you about this one:

This section is incomplete Reason: no example

Yeah. No example. It's giving "the assignment is due and the doc is empty" 😭 literally nothing to show you here, moving on 💀

---

👑 SEE ALSO 👑

• noop_coroutine_promise — used for coroutines with no observable effects (C++20) (class) 🌸 — the lowkey chill one with nothing to prove

---

💜 CATEGORY

• Todo no example

Like, the todo is literally "no example". We been knew 💅

---

little sign-off bc you deserve it 🌟 — this beauty comes to you straight from http://cppreference.com, dated 2024.06.10. Slay, go write a generator, and remember: keep every co_await in check and every co_yield cute 🎀✨💖