Skip to content

Commit

Permalink
Document how the RwLockWriteGuard structure is created.
Browse files Browse the repository at this point in the history
  • Loading branch information
frewsxcv committed Nov 25, 2016
1 parent 276d91d commit 6b4de8b
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/libstd/sync/rwlock.rs
Expand Up @@ -95,6 +95,13 @@ impl<'a, T: ?Sized> !marker::Send for RwLockReadGuard<'a, T> {}

/// RAII structure used to release the exclusive write access of a lock when
/// dropped.
///
/// This structure is created by the [`write()`] and [`try_write()`] methods
/// on [`RwLock`].
///
/// [`write()`]: struct.RwLock.html#method.write
/// [`try_write()`]: struct.RwLock.html#method.try_write
/// [`RwLock`]: struct.RwLock.html
#[must_use]
#[stable(feature = "rust1", since = "1.0.0")]
pub struct RwLockWriteGuard<'a, T: ?Sized + 'a> {
Expand Down

0 comments on commit 6b4de8b

Please sign in to comment.