std_mutex.h(3cxx)

hey bestie πŸ’– welcome to the manual page for std_mutex.h, manual section 3cxx. it's giving internal C++ mutex header energy, and we're gonna go through it together, no cap. ✨

🌸 NAME 🌸

std_mutex.h β€” that's the name, that's the vibe. πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

okay so here's the whole cast, periodt.

πŸ¦‹ Classes πŸ¦‹

  • struct std::adopt_lock_t β€” assume the calling thread has already obtained mutex ownership and manage it. πŸ’…
  • struct std::defer_lock_t β€” do not acquire ownership of the mutex. πŸ™ˆ
  • class std::lock_guard< _Mutex > β€” a simple scoped lock type. 🫢
  • class std::mutex β€” literally the mutex class, main character energy. πŸ‘‘
  • struct std::try_to_lock_t β€” try to acquire ownership of the mutex without blocking. πŸ”₯

🌈 Namespaces 🌈

  • namespace std β€” ISO C++ entities toplevel namespace is std. ⭐

πŸ“ Variables πŸ“

  • constexpr adopt_lock_t std::adopt_lock β€” tag used to make a scoped lock take ownership of a locked mutex. πŸ’–
  • constexpr defer_lock_t std::defer_lock β€” tag used to prevent a scoped lock from acquiring ownership of a mutex. ✨
  • constexpr try_to_lock_t std::try_to_lock β€” tag used to prevent a scoped lock from blocking if a mutex is locked. πŸŽ€

πŸ’œ DETAILED DESCRIPTION πŸ’œ

okay so real talk: this is an internal header file, included by other library headers. Do not attempt to use it directly. Instead, include <mutex>. 🚨

bestie, do NOT try to use it directly. It's giving internal-only, iykyk. The way to do it is <mutex>, periodt. πŸ’…

πŸ‘‘ AUTHOR πŸ‘‘

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


that's the page, bestie. source/version: libstdc++, page: std_mutex.h(3cxx). no date in this footer, so we not inventing one. slay, bye. πŸ’–πŸ¦‹