[#StdMutex-Guard]
= xref:StdMutex.adoc[StdMutex]::Guard
:relfileprefix: ../
:mrdocs:

An annotated version of std::lock_guard for StdMutex.

== Synopsis

Declared in `<util/stdmutex.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class [[scoped_lockable]] Guard
    : public std::lock_guard<StdMutex>
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `std::lock_guard<StdMutex>`
| 
|===

== Type Aliases

[cols="1"]
|===
| Name
| xref:StdMutex/Guard/mutex_type.adoc[`mutex_type`] 
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:StdMutex/Guard/2constructor.adoc[`Guard`]         [.small]#[constructor]#
| Acquire the given mutex for the lifetime of this guard.
| xref:StdMutex/Guard/2destructor.adoc[`~Guard`] [.small]#[destructor]#
| Release the held mutex when the guard is destroyed.
| xref:StdMutex/Guard/operator_assign.adoc[`operator=`]  [.small]#[deleted]#
| 
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#