Struct spin_sleep::SpinSleeper

pub struct SpinSleeper { /* fields omitted */ }

Accuracy container for spin sleeping. See crate docs.

Methods

impl SpinSleeper

pub fn new(native_accuracy_ns: SubsecondNanoseconds) -> SpinSleeper

Constructs new SpinSleeper with the input native sleep accuracy. The lower the native_accuracy_ns the more we effectively trust the accuracy of the thread::sleep function.

pub fn native_accuracy_ns(self) -> SubsecondNanoseconds

Returns configured native_accuracy_ns

pub fn sleep(self, duration: Duration)

Puts the current thread to sleep, if duration is long enough, then spins until the specified duration has elapsed.

Windows: Automatically selects the best native sleep accuracy generally achieving ~1ms native sleep accuracy, instead of default ~16ms.

pub fn sleep_s(self, seconds: Seconds)

Puts the current thread to sleep, if duration is long enough, then spins until the specified second duration has elapsed.

Windows: Automatically selects the best native sleep accuracy generally achieving ~1ms native sleep accuracy, instead of default ~16ms.

pub fn sleep_ns(self, nanoseconds: Nanoseconds)

Puts the current thread to sleep, if duration is long enough, then spins until the specified nanosecond duration has elapsed.

Windows: Automatically selects the best native sleep accuracy generally achieving ~1ms native sleep accuracy, instead of default ~16ms.

Trait Implementations

impl Clone for SpinSleeper

fn clone(&self) -> SpinSleeper

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SpinSleeper

impl Debug for SpinSleeper

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

Formats the value using the given formatter.

impl Default for SpinSleeper

fn default() -> Self

Constructs new SpinSleeper with defaults suiting the current OS

impl Eq for SpinSleeper

impl Hash for SpinSleeper

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<SpinSleeper> for SpinSleeper

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

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

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

This method tests for !=.

impl StructuralEq for SpinSleeper

impl StructuralPartialEq for SpinSleeper