Struct caffe2_imports::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
}
}
Trait 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 ==
.impl Copy for WaitTimeoutResult
impl Eq for WaitTimeoutResult
impl StructuralEq for WaitTimeoutResult
impl StructuralPartialEq for WaitTimeoutResult
Auto Trait Implementations§
impl RefUnwindSafe for WaitTimeoutResult
impl Send for WaitTimeoutResult
impl Sync for WaitTimeoutResult
impl Unpin for WaitTimeoutResult
impl UnwindSafe for WaitTimeoutResult
Blanket Implementations§
§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.