Enum WaitOutcome 

#[non_exhaustive]
pub enum WaitOutcome {
    Signalled,
    Abandoned,
    TimedOut,
    Alerted,
}

How a wait that did not fail ended.

Non-exhaustive, so a wait that can end another way can be added.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Signalled

The object was signalled, and the wait has taken whatever a signalled object gives: an auto-reset event is unsignalled again, a mutex is owned by the waiting thread, a semaphore’s count is one lower.

Abandoned

The object is a mutex whose owner ended without releasing it. The waiting thread owns it now, and whatever it protected may be inconsistent. No other kind of object ends a wait this way, but the wait is over any handle, so a caller that cannot rule the handle out cannot ignore it.

TimedOut

The timeout passed with the object not signalled.

Alerted

An alertable wait was ended by an APC queued to the thread, which has run. Only a wait made Alertable::Yes ends this way. The object was not waited for: nothing was taken from it, so the caller waits again if it still needs it.

Trait Implementations

impl Clone for WaitOutcome

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WaitOutcome

impl Debug for WaitOutcome

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

Formats the value using the given formatter.

impl Eq for WaitOutcome

impl Hash for WaitOutcome

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WaitOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WaitOutcome