Document that Condvar makes the best effort to use monotonic clock.

This commit is contained in:
Tomasz Miąsko 2016-08-19 14:00:20 +02:00
parent 8ec47261e1
commit 8dae1b6625

View file

@ -144,6 +144,10 @@ impl Condvar {
/// differences that may not cause the maximum amount of time
/// waited to be precisely `ms`.
///
/// Note that the best effort is made to ensure that the time waited is
/// measured with a monotonic clock, and not affected by the changes made to
/// the system time.
///
/// The returned boolean is `false` only if the timeout is known
/// to have elapsed.
///
@ -168,6 +172,10 @@ impl Condvar {
/// preemption or platform differences that may not cause the maximum
/// amount of time waited to be precisely `dur`.
///
/// Note that the best effort is made to ensure that the time waited is
/// measured with a monotonic clock, and not affected by the changes made to
/// the system time.
///
/// The returned `WaitTimeoutResult` value indicates if the timeout is
/// known to have elapsed.
///