std::stop_source(3cxx)

💅 std::stop_source 💅

okay so welcome to the std::stop_source(3cxx) manual page, bestie — this is the libstdc++ stop-source situation, and we’re keeping every signature exactly where it belongs. no cap. 🫶

🌸 NAME 🌸

std::stop_source — a type that allows a stop request to be made. 💖

🌈 SYNOPSIS 🌈

#include <stop_token>

✨ Public Member Functions ✨

• stop_source (const stop_source &__other) noexcept — copy ctor energy, noexcept and all that. 🎀
• stop_source (std::nostopstate_t) noexcept — ctor that takes std::nostopstate_t, noexcept bestie. 💅
• stop_source (stop_source &&) noexcept=default — move ctor, noexcept=default, iconic. 🫶
• stop_token get_token () const noexcept — returns a stop_token, const noexcept. 🌸
• stop_source & operator= (const stop_source &__other) noexcept — copy assignment, returns stop_source &, noexcept. 🎀
• stop_source & operator= (stop_source &&) noexcept=default — move assignment, returns stop_source &, noexcept=default. ✨
• bool request_stop () const noexcept — returns bool, const noexcept. 🔥
• bool stop_possible () const noexcept — returns bool, const noexcept. 💜
• bool stop_requested () const noexcept — returns bool, const noexcept. ⭐
• void swap (stop_source &__other) noexcept — takes stop_source &__other, returns void, noexcept. 🦋

🫶 Friends 🫶

these two are friends of the class, and yes both are noexcept; the exact lines are:

bool operator== (const stop_source &__a, const stop_source &__b)
    noexcept
void swap (stop_source &__lhs, stop_source &__rhs) noexcept

💫 Detailed Description 💫

A type that allows a stop request to be made. periodt. 💅

👑 Author 👑

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

---

bye bestie! source/version: libstdc++; manual page: std::stop_source(3cxx); date: not shown in the original footer, so I’m not inventing one 🫶💖