@@ -171,14 +171,16 @@ impl<T: ?Sized> RwLock<T> {
171
171
RwLockReadGuard :: new ( & * self . inner , & self . data )
172
172
}
173
173
174
- /// Attempts to acquire this lock with shared read access.
174
+ /// Attempts to acquire this rwlock with shared read access.
175
+ ///
176
+ /// If the access could not be granted at this time, then `Err` is returned.
177
+ /// Otherwise, an RAII guard is returned which will release the shared access
178
+ /// when it is dropped.
179
+ ///
180
+ /// This function does not block.
175
181
///
176
- /// This function will never block and will return immediately if `read`
177
- /// would otherwise succeed. Returns `Some` of an RAII guard which will
178
- /// release the shared access of this thread when dropped, or `None` if the
179
- /// access could not be granted. This method does not provide any
180
- /// guarantees with respect to the ordering of whether contentious readers
181
- /// or writers will acquire the lock first.
182
+ /// This function does not provide any guarantees with respect to the ordering
183
+ /// of whether contentious readers or writers will acquire the lock first.
182
184
///
183
185
/// # Failure
184
186
///
@@ -219,9 +221,14 @@ impl<T: ?Sized> RwLock<T> {
219
221
220
222
/// Attempts to lock this rwlock with exclusive write access.
221
223
///
222
- /// This function does not ever block, and it will return `None` if a call
223
- /// to `write` would otherwise block. If successful, an RAII guard is
224
- /// returned.
224
+ /// If the lock could not be acquired at this time, then `Err` is returned.
225
+ /// Otherwise, an RAII guard is returned which will release the lock when
226
+ /// it is dropped.
227
+ ///
228
+ /// This function does not block.
229
+ ///
230
+ /// This function does not provide any guarantees with respect to the ordering
231
+ /// of whether contentious readers or writers will acquire the lock first.
225
232
///
226
233
/// # Failure
227
234
///
0 commit comments