mathieu/granite-rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Remove references to guards in documentation for clear_poison

Browse source
This commit is contained in:
Thayne McCombs 2022-05-20 00:15:26 -06:00
parent 66d88c9a18
commit a65afd82d1
2 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
library/std/src/sync/mutex.rs
View file

@ -365,11 +365,11 @@ impl<T: ?Sized> Mutex<T> {
/// Clear the poisoned state from a mutex
///
/// If the mutex is poisoned, it will remain poisoned until this function is called
/// with a mutex guard. This allows recovering from a poisoned state and marking
/// that it has recovered. For example, if the value is overwritten by a known-good value,
/// then the mutex can be marked as un-poisoned. Or possibly, the value could be inspected to
/// determine if it is in a consistent state, and if so the poison is removed.
/// If the mutex is poisoned, it will remain poisoned until this function is called. This
/// allows recovering from a poisoned state and marking that it has recovered. For example, if
/// the value is overwritten by a known-good value, then the mutex can be marked as
/// un-poisoned. Or possibly, the value could be inspected to determine if it is in a
/// consistent state, and if so the poison is removed.
///
/// # Examples
///

10
library/std/src/sync/rwlock.rs
View file

@ -368,11 +368,11 @@ impl<T: ?Sized> RwLock<T> {
/// Clear the poisoned state from a lock
///
/// If the lock is poisoned, it will remain poisoned until this function is called
/// with a write guard. This allows recovering from a poisoned state and marking
/// that it has recovered. For example, if the value is overwritten by a known-good value,
/// then the mutex can be marked as un-poisoned. Or possibly, the value could be inspected to
/// determine if it is in a consistent state, and if so the poison is removed.
/// If the lock is poisoned, it will remain poisoned until this function is called. This allows
/// recovering from a poisoned state and marking that it has recovered. For example, if the
/// value is overwritten by a known-good value, then the mutex can be marked as un-poisoned. Or
/// possibly, the value could be inspected to determine if it is in a consistent state, and if
/// so the poison is removed.
///
/// # Examples
///