Struct std::sync::WaitTimeoutResult
1.5.0 · source · pub struct WaitTimeoutResult(_);
Expand description
A type indicating whether a timed wait on a condition variable returned due to a time out or not.
It is returned by the wait_timeout
method.
Implementations§
source§impl WaitTimeoutResult
impl WaitTimeoutResult
sourcepub fn timed_out(&self) -> bool
pub fn timed_out(&self) -> bool
Returns true
if the wait was known to have timed out.
Examples
This example spawns a thread which will update the boolean value and then wait 100 milliseconds before notifying the condvar.
The main thread will wait with a timeout on the condvar and then leave once the boolean has been updated and notified.
use std::sync::{Arc, Condvar, Mutex};
use std::thread;
use std::time::Duration;
let pair = Arc::new((Mutex::new(false), Condvar::new()));
let pair2 = Arc::clone(&pair);
thread::spawn(move || {
let (lock, cvar) = &*pair2;
// Let's wait 20 milliseconds before notifying the condvar.
thread::sleep(Duration::from_millis(20));
let mut started = lock.lock().unwrap();
// We update the boolean value.
*started = true;
cvar.notify_one();
});
// Wait for the thread to start up.
let (lock, cvar) = &*pair;
let mut started = lock.lock().unwrap();
loop {
// Let's put a timeout on the condvar's wait.
let result = cvar.wait_timeout(started, Duration::from_millis(10)).unwrap();
// 10 milliseconds have passed, or maybe the value changed!
started = result.0;
if *started == true {
// We received the notification and the value has been updated, we can leave.
break
}
}
RunTrait Implementations§
source§impl Clone for WaitTimeoutResult
impl Clone for WaitTimeoutResult
source§fn clone(&self) -> WaitTimeoutResult
fn clone(&self) -> WaitTimeoutResult
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for WaitTimeoutResult
impl Debug for WaitTimeoutResult
source§impl PartialEq<WaitTimeoutResult> for WaitTimeoutResult
impl PartialEq<WaitTimeoutResult> for WaitTimeoutResult
source§fn eq(&self, other: &WaitTimeoutResult) -> bool
fn eq(&self, other: &WaitTimeoutResult) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.