# Struct std::sync::WaitTimeoutResult

1.5.0 · source ·

    pub struct WaitTimeoutResult(/* private fields */);

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

source

#### 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 sleep 20 milliseconds before updating a boolean value and then notifying the condvar.

The main thread will wait with a 10 millisecond timeout on the condvar and will leave the loop upon timeout.

    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;
    loop {
        // Let's put a timeout on the condvar's wait.
        let result = cvar.wait_timeout(lock.lock().unwrap(), Duration::from_millis(10)).unwrap();
        // 10 milliseconds have passed.
        if result.1.timed_out() {
            // timed out now and we can leave.
            break
        }
    }

Run

## Trait Implementations§

source§

### impl Clone for WaitTimeoutResult

source§

#### fn clone(&self) -> WaitTimeoutResult

Returns a copy of the value. Read more
1.0.0 · source§

#### fn clone_from(&mut self, source: &Self)

Performs copy-assignment from `source`. Read more
source§

### impl Debug for WaitTimeoutResult

source§

#### fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

### impl PartialEq for WaitTimeoutResult

source§

#### fn eq(&self, other: &WaitTimeoutResult) -> bool

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

#### fn ne(&self, other: &Rhs) -> bool

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl Copy for WaitTimeoutResult

source§

### impl Eq for WaitTimeoutResult

source§

### impl StructuralEq for WaitTimeoutResult

source§

### 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§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.