std::lock_g...::lock_guard(3)

💖 std::lock_g...::lock_guard(3) 💖

okay so bestie, you're in the C++ Standard Libary manual, and this page is all about std::lock_guard::lock_guard. yes, the NAME is literally std::lock_guard::lock_guard — std::lock_guard::lock_guard. it's giving constructor main-character energy, fr fr. 💅

✨ Synopsis ✨

three versions, all (since C++11), no cap:

explicit lock_guard( mutex_type& m );             (1) (since C++11)
lock_guard( mutex_type& m, std::adopt_lock_t t ); (2) (since C++11)
lock_guard( const lock_guard& ) = delete;         (3) (since C++11)

this whole situation acquires ownership of the given mutex m. 🫶

1. Effectively calls m.lock().
2. Acquires ownership of the mutex m without attempting to lock it. The behavior is undefined if the current thread does not hold a non-shared lock (i.e., a lock acquired by lock, try_lock, try_lock_for, or try_lock_until) on m. 💀
3. Copy constructor is deleted.

The behavior is undefined if m is destroyed before the lock_guard object is. like, do not let that happen, bestie — undefined behavior is not the vibe. 😭

🎀 Parameters 🎀

• m — mutex to acquire ownership of
• t — tag parameter used to select non-locking version of the constructor

😭 Exceptions 😭

1. Throws any exceptions thrown by m.lock().
2. Throws nothing.

✨ okay that's the whole page, bestie. source/version: cppreference.com · date: 2024.06.10 · manual: C++ Standard Libary · URL: http://cppreference.com · std::lock_g...::lock_guard(3) 🦋