STD::UNIQUE_LOCK(3)

✨ NAME ✨

std::unique_lock< _Mutex > — A movable scoped lock type. 💅

hiii bestie, welcome to the std::unique_lock< _Mutex >(3) page from the Library Functions Manual. The header up top is literally std::uniqu...< _Mutex >(3) (truncated, iykyk) and the manual name is Library Functions Manual. This page is about a movable scoped lock type, and we are keeping every single crumb. 🫶

---

🦋 SYNOPSIS 🦋

#include <mutex>

💖 Public Types 💖

• typedef _Mutex mutex_type — the one and only public type, exactly as written. periodt. 🎀

👑 Public Member Functions 👑

okay so here is every single member function, in the exact order the original gives them. No skips, no merges, no invented lore. fr fr ✨

• unique_lock (const unique_lock &)=delete — copy construction is deleted, so do not try it, bestie 💅
• unique_lock (mutex_type &__m) — constructor that takes mutex_type &__m.
• unique_lock (mutex_type &__m, adopt_lock_t) noexcept — constructor with adopt_lock_t, and it is noexcept.
• template<typename _Rep, typename _Period> unique_lock (mutex_type &__m, const chrono::duration< _Rep, _Period > &__rtime) — constructor with chrono::duration< _Rep, _Period > &__rtime.
• template<typename _Clock, typename _Duration> unique_lock (mutex_type &__m, const chrono::time_point< _Clock, _Duration > &__atime) — constructor with chrono::time_point< _Clock, _Duration > &__atime.
• unique_lock (mutex_type &__m, defer_lock_t) noexcept — constructor with defer_lock_t, and it is noexcept.
• unique_lock (mutex_type &__m, try_to_lock_t) — constructor with try_to_lock_t.
• unique_lock (unique_lock &&__u) noexcept — move constructor, and it is noexcept.
• void lock () — member function named lock.
• mutex_type * mutex () const noexcept — returns a mutex_type *, and it is const noexcept.
• operator bool () const noexcept — bool conversion operator, and it is const noexcept.
• unique_lock & operator= (const unique_lock &)=delete — copy assignment is deleted.
• unique_lock & operator= (unique_lock &&__u) noexcept — move assignment, and it is noexcept.
• bool owns_lock () const noexcept — returns bool, and it is const noexcept.
• mutex_type * release () noexcept — returns mutex_type *, and it is noexcept.
• void swap (unique_lock &__u) noexcept — member swap taking unique_lock &__u, and it is noexcept.
• bool try_lock () — returns bool.
• template<typename _Rep, typename _Period> bool try_lock_for (const chrono::duration< _Rep, _Period > &__rtime) — template returning bool, taking chrono::duration< _Rep, _Period > &__rtime.
• template<typename _Clock, typename _Duration> bool try_lock_until (const chrono::time_point< _Clock, _Duration > &__atime) — template returning bool, taking chrono::time_point< _Clock, _Duration > &__atime.
• void unlock () — member function named unlock.

🌈 Related Symbols 🌈

• (Note that these are not member symbols.) the original literally says this, bestie, so it stays.
• template<typename _Mutex> void swap (unique_lock< _Mutex > &__x, unique_lock< _Mutex > &__y) noexcept — Swap overload for unique_lock objects. that description is exactly from the page.

---

💅 Detailed Description 💅

template<typename _Mutex>
class std::unique_lock< _Mutex >"A movable scoped lock type.

yes, there is a stray quote mark right there in the original, and I am not fixing it. we keep the details exactly. 💀

okay so unique_lock controls mutex ownership within a scope. Ownership of the mutex can be delayed until after construction, and it can be transferred to another unique_lock by move construction or move assignment. If a mutex lock is owned when the destructor runs, ownership will be released. that is the whole vibe, no cap.

Since:

C++11

---

🎀 Friends And Related Symbol Documentation 🎀

template<typename _Mutex> void swap (unique_lock< _Mutex > & __x, unique_lock< _Mutex > & __y) [related]

Swap overload for unique_lock objects.

ngl, this one has spaces in & __x and & __y, and it ends with [related]. The earlier Related Symbols version has &__x and &__y and noexcept. Both are real, both stay. slay. ✨

---

🌸 Author 🌸

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

---

okay bye bestie 💖 the footer at the bottom says libstdc++ and std::uniqu...< _Mutex >(3), so that is the source/version and page-name sign-off. There is no date in that footer, fr fr, so I am not inventing one. Stay iconic, stay locked, mwah 💅✨