std::execut...pon_stopped(3)

okay bestie, welcome to std::execut...pon_stopped(3) — that’s the manual page straight from the C++ Standard Libary (yes, “Libary,” that’s literally how it’s spelled in the header, iykyk 💅). this one is all about the std::execution::upon_stopped sender adaptor, and it is lowkey iconic ✨.

💖 NAME 💖

std::execution::upon_stopped - std::execution::upon_stopped

like, the name is the name, periodt 🎀. this is the page for std::execution::upon_stopped.

🦋 Synopsis 🦋

okay so here’s the whole synopsis vibe, copied exactly because we do not play with code 🫶:

Defined in header <execution>
execution::sender auto upon_stopped(

    execution::sender auto input,     (since C++26)
    std::invocable auto function

);

and yes, it says (since C++26) right there in the code — this is a C++26-era thing, no cap ⭐.

🌸 Parameters 🌸

• input — the sender which, once it gets a “stop token,” will notify the new node to execute the function 💌
• function — the invocable to be called in case a “stopped” signal is sent to the input sender 🔥

👑 Return value 👑

Returns a sender describing the task graph described by the input sender, with an added node of invoking the provided function in case the “stopped” signal is sent to the input sender 💫.

that’s the whole return-value situation, bestie: same task graph energy, plus one new node for the stopped-signal case 🧚.

shoutout to http://cppreference.com, dated 2024.06.10, and tagged std::execut...pon_stopped(3) — bye bestie, slay your sender adaptors responsibly 💖🎀