about summary refs log tree commit diff
path: root/library/std/src/sys/pal/unix/sync/mutex.rs
diff options
context:
space:
mode:
authorjoboet <jonasboettiger@icloud.com>2024-11-30 16:22:56 +0100
committerjoboet <jonasboettiger@icloud.com>2024-11-30 16:22:56 +0100
commit8b2ff49ff9dd20ee417907c2e96daa9f0cd8e7c4 (patch)
tree592bc91bf8ee8e8b752dd9bf8ed959e293ef8e30 /library/std/src/sys/pal/unix/sync/mutex.rs
parent528b37a738abf6cb0166fb60701dc2841ad54ebf (diff)
downloadrust-8b2ff49ff9dd20ee417907c2e96daa9f0cd8e7c4.tar.gz
rust-8b2ff49ff9dd20ee417907c2e96daa9f0cd8e7c4.zip
std: clarify comments about initialization
Diffstat (limited to 'library/std/src/sys/pal/unix/sync/mutex.rs')
-rw-r--r--library/std/src/sys/pal/unix/sync/mutex.rs8
1 files changed, 5 insertions, 3 deletions
diff --git a/library/std/src/sys/pal/unix/sync/mutex.rs b/library/std/src/sys/pal/unix/sync/mutex.rs
index 8ffd375bf91..8ff6c3d3d15 100644
--- a/library/std/src/sys/pal/unix/sync/mutex.rs
+++ b/library/std/src/sys/pal/unix/sync/mutex.rs
@@ -18,7 +18,7 @@ impl Mutex {
     }
 
     /// # Safety
-    /// Must only be called once.
+    /// May only be called once per instance of `Self`.
     pub unsafe fn init(self: Pin<&mut Self>) {
         // Issue #33770
         //
@@ -58,7 +58,8 @@ impl Mutex {
     }
 
     /// # Safety
-    /// * If `init` was not called, reentrant locking causes undefined behaviour.
+    /// * If `init` was not called on this instance, reentrant locking causes
+    ///   undefined behaviour.
     /// * Destroying a locked mutex causes undefined behaviour.
     pub unsafe fn lock(self: Pin<&Self>) {
         #[cold]
@@ -82,7 +83,8 @@ impl Mutex {
     }
 
     /// # Safety
-    /// * If `init` was not called, reentrant locking causes undefined behaviour.
+    /// * If `init` was not called on this instance, reentrant locking causes
+    ///   undefined behaviour.
     /// * Destroying a locked mutex causes undefined behaviour.
     pub unsafe fn try_lock(self: Pin<&Self>) -> bool {
         unsafe { libc::pthread_mutex_trylock(self.raw()) == 0 }