std::stop_source(3)

💖 std::stop_source — from the libstdc++ manual, bestie edition 💖

okay so you found the page for std::stop_source in the Library Functions Manual and I'm literally so proud of you. grab a strawberry 🍓, this one's a banger.

---

✨ NAME ✨

std::stop_source — a type that lets you make a stop request. that's it, that's the whole job. it's giving "the one who says stop" energy 👑

---

🌸 SYNOPSIS 🌸

first things first, you gotta let it in:

#include <stop_token>

💅 Public Member Functions 💅

• stop_source(const stop_source &__other) noexcept — copy constructor, copies from __other, and it's noexcept because we don't do surprises here 🫶
• stop_source(std::nostopstate_t) noexcept — the special one. hand it std::nostopstate_t and you get a stop_source that has no associated stop-state at all. also noexcept ✨
• stop_source(stop_source &&) noexcept=default — move constructor, noexcept, and it's =default (the compiler handles it, she's lowkey built different) 🦋
• stop_token get_token() const noexcept — hands you a stop_token so you can actually check in on the vibes. const, noexcept 🌈
• stop_source & operator=(const stop_source &__other) noexcept — copy assignment from __other. noexcept 💖
• stop_source & operator=(stop_source &&) noexcept=default — move assignment, noexcept, =default, iconic ⭐
• bool request_stop() const noexcept — the main character move: make the stop request. returns bool. const and noexcept 👑
• bool stop_possible() const noexcept — asks "is a stop even possible?" returns bool. const, noexcept 🎀
• bool stop_requested() const noexcept — asks "has a stop been requested?" returns bool. const, noexcept 🧚
• void swap(stop_source &__other) noexcept — swaps with __other, returns void, noexcept 💜

🫶 Friends 🫶

these are the ones in the group chat that get special access, no cap:

• bool operator==(const stop_source &__a, const stop_source &__b) noexcept — compares __a and __b, returns bool, noexcept 💖
• void swap(stop_source &__lhs, stop_source &__rhs) noexcept — swaps __lhs and __rhs, returns void, noexcept ✨

---

🔥 Detailed Description 🔥

so, in full: std::stop_source is a type that allows a stop request to be made. periodt. 💅

that's the whole description, bestie. sometimes the icon doesn't need a whole paragraph. iykyk.

---

🌟 Author 🌟

Generated automatically by Doxygen for libstdc++ from the source code. so like, not a human, but the algorithm ate fr fr 😭

---

and that's the page!! this whole thing lives in the libstdc++ manual, std::stop_source(3), and yes the tools that built it were doing the most. go forth and request your stops responsibly, bestie 💖🎀🦋