Struct parking_lot_core::parking_lot::UnparkResult

pub struct UnparkResult {
    pub unparked_threads: usize,
    pub requeued_threads: usize,
    pub have_more_threads: bool,
    pub be_fair: bool,
    _sealed: (),
}

Result of an unpark operation.

Fields

unparked_threads: usize

The number of threads that were unparked.

requeued_threads: usize

The number of threads that were requeued.

have_more_threads: bool

Whether there are any threads remaining in the queue. This only returns true if a thread was unparked.

be_fair: bool

This is set to true on average once every 0.5ms for any given key. It should be used to switch to a fair unlocking mechanism for a particular unlock.

_sealed: ()

Private field so new fields can be added without breakage.

Trait Implementations

impl Clone for UnparkResult

fn clone(&self) -> UnparkResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnparkResult

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

Formats the value using the given formatter.

impl Default for UnparkResult

fn default() -> UnparkResult

Returns the “default value” for a type.

impl PartialEq for UnparkResult

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

This method tests for self and other values to be equal, and is used by ==.

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.

impl Copy for UnparkResult

impl Eq for UnparkResult

impl StructuralPartialEq for UnparkResult