mirror of
https://github.com/rust-lang/rust.git
synced 2026-05-23 02:27:39 +03:00
Update documentation for RwLock::try_{read,write}.
This commit is contained in:
+17
-10
@@ -171,14 +171,16 @@ pub fn read(&self) -> LockResult<RwLockReadGuard<T>> {
|
||||
RwLockReadGuard::new(&*self.inner, &self.data)
|
||||
}
|
||||
|
||||
/// Attempts to acquire this lock with shared read access.
|
||||
/// Attempts to acquire this rwlock with shared read access.
|
||||
///
|
||||
/// This function will never block and will return immediately if `read`
|
||||
/// would otherwise succeed. Returns `Some` of an RAII guard which will
|
||||
/// release the shared access of this thread when dropped, or `None` if the
|
||||
/// access could not be granted. This method does not provide any
|
||||
/// guarantees with respect to the ordering of whether contentious readers
|
||||
/// or writers will acquire the lock first.
|
||||
/// If the access could not be granted at this time, then `Err` is returned.
|
||||
/// Otherwise, an RAII guard is returned which will release the shared access
|
||||
/// when it is dropped.
|
||||
///
|
||||
/// This function does not block.
|
||||
///
|
||||
/// This function does not provide any guarantees with respect to the ordering
|
||||
/// of whether contentious readers or writers will acquire the lock first.
|
||||
///
|
||||
/// # Failure
|
||||
///
|
||||
@@ -219,9 +221,14 @@ pub fn write(&self) -> LockResult<RwLockWriteGuard<T>> {
|
||||
|
||||
/// Attempts to lock this rwlock with exclusive write access.
|
||||
///
|
||||
/// This function does not ever block, and it will return `None` if a call
|
||||
/// to `write` would otherwise block. If successful, an RAII guard is
|
||||
/// returned.
|
||||
/// If the lock could not be acquired at this time, then `Err` is returned.
|
||||
/// Otherwise, an RAII guard is returned which will release the lock when
|
||||
/// it is dropped.
|
||||
///
|
||||
/// This function does not block.
|
||||
///
|
||||
/// This function does not provide any guarantees with respect to the ordering
|
||||
/// of whether contentious readers or writers will acquire the lock first.
|
||||
///
|
||||
/// # Failure
|
||||
///
|
||||
|
||||
Reference in New Issue
Block a user