std::experi...r::exchange(3)

🌸 NAME 🌸

okay so bestie, this is the C++ Standard Libary manual page for std::experimental::atomic_weak_ptr::exchange, and the NAME line is literally std::experimental::atomic_weak_ptr::exchange - std::experimental::atomic_weak_ptr::exchange — the repetition is iconic, we respect it. 💖 It's the atomic exchange situation for a weak pointer, and we're gonna get through every detail together, no cap.

🦋 Synopsis 🦋

weak_ptr<T> exchange( weak_ptr<T> desired, std::memory_order order =
std::memory_order_seq_cst ) noexcept;

This atomically replaces the underlying weak_ptr with desired. The operation is a read-modify-write operation. Memory is affected according to the value of order. Slay. ✨

🎀 Parameters 🎀

• desired — value to assign. literally the new value going in. 💅
• order — memory order constraints to enforce. yes bestie, the memory-order vibe check. 🌀

🌟 Return value 🌟

The value of the atomic variable before the call. so you get the old value back, periodt. 🫶

💅 Remarks 💅

• All changes to the atomic_weak_ptr object itself, and all associated use_count increments, are guaranteed to be performed atomically. 🔥
• Associated use_count decrements take place after the atomic operation, but are not required to be part of it. 💀
• Any associated destruction or deallocation operations take place after the atomic operation and are not part of it. 🌈

💜 See also 💜

the see-also crew, all present and accounted for:

• std::atomic_is_lock_free(std::shared_ptr)
• std::atomic_load(std::shared_ptr)
• std::atomic_load_explicit(std::shared_ptr)
• std::atomic_store(std::shared_ptr)
• std::atomic_store_explicit(std::shared_ptr)
• std::atomic_exchange(std::shared_ptr)
• std::atomic_exchange_explicit(std::shared_ptr)
• std::atomic_compare_exchange_weak(std::shared_ptr)
• std::atomic_compare_exchange_strong(std::shared_ptr)
• std::atomic_compare_exchange_weak_explicit(std::shared_ptr)
• std::atomic_compare_exchange_strong_explicit(std::shared_ptr)

Also in the see-also zone, verbatim: specializes atomic operations for std::shared_ptr, (function template), (deprecated in C++20), (removed in C++26). The deprecated/removed tags are real caveats, bestie — don't ignore them. 👑

signing off with source http://cppreference.com, version/date 2024.06.10, and page std::experi...r::exchange(3) — bye bestie, go be atomic 💖🦋