STD::STOP_CALLBACK(3)

✨ std::stop_callback< _Callback > ✨

okay bestie, welcome to the libstdc++ section of the manual, page std::stop_callback< _Callback >(3), filed under Library Functions. this one's a whole vibe: it's the little wrapper that holds onto your callback and fires it the moment somebody makes a stop request. 🛑✨

---

🌸 NAME 🌸

std::stop_callback< _Callback > — a wrapper for callbacks to be run when a stop request is made.

like… that's it. that's the whole job. it babysits your callback until the stop token says "we're done here", and then it runs it. no cap. 💅

---

🎀 SYNOPSIS 🎀

#include <stop_token>

💖 Public Types 💖

• using callback_type

💜 Public Member Functions 💜

stop_callback (const stop_callback &)=delete

template<typename _Cb, enable_if_t< is_constructible_v< _Callback, _Cb >, int > = 0>
stop_callback (const stop_token &__token, _Cb &&__cb)
    noexcept(is_nothrow_constructible_v< _Callback, _Cb >)

stop_callback (stop_callback &&)=delete

template<typename _Cb, enable_if_t< is_constructible_v< _Callback, _Cb >, int > = 0>
stop_callback (stop_token &&__token, _Cb &&__cb)
    noexcept(is_nothrow_constructible_v< _Callback, _Cb >)

stop_callback & operator= (const stop_callback &)=delete

stop_callback & operator= (stop_callback &&)=delete

okay so real talk: the copy constructor, the move constructor, and both assignment operators are all =delete. this thing does not want to be copied, moved, or reassigned. it's giving "i'm built different and i stay put". respect it. 🙈

---

🦋 Detailed Description 🦋

template<typename _Callback>
    class std::stop_callback< _Callback >

"A wrapper for callbacks to be run when a stop request is made."

that's the tea. the class is templated on _Callback — your callback type — and it exists purely to be the middleman between a stop request and your callback. you hand it a stop_token and something constructible into _Callback, and it handles the rest. iconic behaviour honestly. 👑

the noexcept bits on the constructors come straight from is_nothrow_constructible_v< _Callback, _Cb >, so whether these are noexcept depends entirely on whether your callback can be built from _Cb without throwing. and the enable_if_t< is_constructible_v< _Callback, _Cb >, int > = 0 is the bouncer at the door — if _Callback isn't constructible from _Cb, you're not getting in. 💅

---

⭐ Author ⭐

Generated automatically by Doxygen for libstdc++ from the source code.

---

that's the whole page, bestie. shoutout to the libstdc++ crew and to Doxygen for auto-generating this from the source code — this page rolled out with the libstdc++ manual and the <rainbow>std::stop_callback< _Callback >(3)</rainbow> header up top, and ngl there's no date stamped on this one, so we're running it date-less. 🫶✨💖