Struct SpinSleeper

pub struct SpinSleeper { /* private fields */ }

Accuracy container for spin sleeping. See crate docs.

Implementations

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 native_sleep function.

pub fn native_accuracy_ns(self) -> SubsecondNanoseconds

Returns configured native_accuracy_ns.

pub fn spin_strategy(self) -> SpinStrategy

Returns configured spin strategy.

pub fn with_spin_strategy(self, strategy: SpinStrategy) -> Self

Returns a spin sleeper with the given SpinStrategy.

Example

use spin_sleep::{SpinSleeper, SpinStrategy};

let sleeper = SpinSleeper::default().with_spin_strategy(SpinStrategy::SpinLoopHint);

pub fn sleep(self, duration: Duration)

Puts the current thread to sleep for the duration less the configured native accuracy. Then spins until the specified duration has elapsed.

pub fn sleep_until(self, deadline: Instant)

Puts the current thread to sleep until the deadline less the configured native accuracy. Then spins until the specified deadline is reached.

pub fn sleep_s(self, seconds: Seconds)

Puts the current thread to sleep for the give seconds-duration less the configured native accuracy. Then spins until the specified duration has elapsed.

pub fn sleep_ns(self, nanoseconds: Nanoseconds)

Puts the current thread to sleep for the give nanoseconds-duration less the configured native accuracy. Then spins until the specified duration has elapsed.

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 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 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SpinSleeper

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SpinSleeper

impl Eq for SpinSleeper

impl StructuralPartialEq for SpinSleeper