Skip to content

Commit 6b4de8b

Browse files
committed
Document how the RwLockWriteGuard structure is created.
1 parent 276d91d commit 6b4de8b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/libstd/sync/rwlock.rs

+7
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,13 @@ impl<'a, T: ?Sized> !marker::Send for RwLockReadGuard<'a, T> {}
9595

9696
/// RAII structure used to release the exclusive write access of a lock when
9797
/// dropped.
98+
///
99+
/// This structure is created by the [`write()`] and [`try_write()`] methods
100+
/// on [`RwLock`].
101+
///
102+
/// [`write()`]: struct.RwLock.html#method.write
103+
/// [`try_write()`]: struct.RwLock.html#method.try_write
104+
/// [`RwLock`]: struct.RwLock.html
98105
#[must_use]
99106
#[stable(feature = "rust1", since = "1.0.0")]
100107
pub struct RwLockWriteGuard<'a, T: ?Sized + 'a> {

0 commit comments

Comments
 (0)