diff options
Diffstat (limited to 'src/rwlock/rwlock.rs')
| -rw-r--r-- | src/rwlock/rwlock.rs | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/src/rwlock/rwlock.rs b/src/rwlock/rwlock.rs index 6432128..a249675 100644 --- a/src/rwlock/rwlock.rs +++ b/src/rwlock/rwlock.rs @@ -277,10 +277,19 @@ impl<T: ?Sized, R: RawRwLock> RwLock<T, R> { /// Attempts to acquire this `RwLock` with shared read access without /// blocking. /// - /// If the access could not be granted at this time, then `None` is + /// 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 provide any guarantees with respect to the + /// ordering of whether contentious readers or writers will acquire the + /// lock first. + /// + /// # Errors + /// + /// If the `RwLock` could not be acquired because it was already locked + /// exclusively, then an error will be returned containing the given key. + /// /// # Examples /// /// ``` @@ -351,8 +360,10 @@ impl<T: ?Sized, R: RawRwLock> RwLock<T, R> { /// let key = ThreadKey::get().unwrap(); /// let lock = RwLock::new(1); /// - /// let mut n = lock.write(key); - /// *n += 2; + /// match lock.try_write(key) { + /// Ok(n) => assert_eq!(*n, 1), + /// Err(_) => unreachable!(), + /// }; /// ``` /// /// [`ThreadKey`]: `crate::ThreadKey` @@ -378,6 +389,11 @@ impl<T: ?Sized, R: RawRwLock> RwLock<T, R> { /// ordering of whether contentious readers or writers will acquire the /// lock first. /// + /// # Errors + /// + /// If the `RwLock` could not be acquired because it was already locked, + /// then an error will be returned containing the given key. + /// /// # Examples /// /// ``` |