File tree 1 file changed +7
-2
lines changed
1 file changed +7
-2
lines changed Original file line number Diff line number Diff line change @@ -195,8 +195,12 @@ impl Condvar {
195
195
if poisoned { Err ( PoisonError :: new ( guard) ) } else { Ok ( guard) }
196
196
}
197
197
198
- /// Blocks the current thread until this condition variable receives a
199
- /// notification and the provided condition is false.
198
+ /// Blocks the current thread while the provided condition stops returning
199
+ /// `true`
200
+ ///
201
+ /// `condition` is checked immediately; if not met (returns `true`), this
202
+ /// will [`wait`] for the next notification then check again. This repeats
203
+ /// until `condition` returns `false`, in which case this function returns.
200
204
///
201
205
/// This function will atomically unlock the mutex specified (represented by
202
206
/// `guard`) and block the current thread. This means that any calls
@@ -210,6 +214,7 @@ impl Condvar {
210
214
/// poisoned when this thread re-acquires the lock. For more information,
211
215
/// see information about [poisoning] on the [`Mutex`] type.
212
216
///
217
+ /// [`wait`]: Self::wait
213
218
/// [`notify_one`]: Self::notify_one
214
219
/// [`notify_all`]: Self::notify_all
215
220
/// [poisoning]: super::Mutex#poisoning
You can’t perform that action at this time.
0 commit comments