1.5.0[][src]Struct std::sync::WaitTimeoutResult

pub struct WaitTimeoutResult(_);

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.


impl WaitTimeoutResult[src]

pub fn timed_out(&self) -> bool[src]

Returns true if the wait was known to have timed out.


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, Mutex, Condvar};
use std::thread;
use std::time::Duration;

let pair = Arc::new((Mutex::new(false), Condvar::new()));
let pair2 = pair.clone();

thread::spawn(move|| {
    let &(ref lock, ref cvar) = &*pair2;

    // Let's wait 20 milliseconds before notifying the condvar.

    let mut started = lock.lock().unwrap();
    // We update the boolean value.
    *started = true;

// Wait for the thread to start up.
let &(ref lock, ref 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.

Trait Implementations

impl PartialEq<WaitTimeoutResult> for WaitTimeoutResult[src]

impl Eq for WaitTimeoutResult[src]

impl Debug for WaitTimeoutResult[src]

impl Copy for WaitTimeoutResult[src]

impl Clone for WaitTimeoutResult[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl UnwindSafe for WaitTimeoutResult

impl RefUnwindSafe for WaitTimeoutResult

impl Unpin for WaitTimeoutResult

impl Send for WaitTimeoutResult

impl Sync for WaitTimeoutResult

Blanket Implementations

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> From<T> for T[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.