Crate spin_sleep 

Accurate sleeping. Only use native sleep as far as it can be trusted, then spin.

The problem with thread::sleep is it isn’t always very accurate, and this accuracy varies on platform and state. Spinning is as accurate as we can get, but consumes the CPU rather ungracefully.

This library adds a middle ground, using a configurable native accuracy setting allowing thread::sleep to wait the bulk of a sleep time, and spin the final section to guarantee accuracy.

Example: Replace thread::sleep

The simplest usage with default native accuracy is a drop in replacement for thread::sleep.

spin_sleep::sleep(Duration::new(1, 12_550_000));

Example: Configure

More advanced usage, including setting a custom native accuracy, can be achieved by constructing a SpinSleeper.

// Create a new sleeper that trusts native thread::sleep with 100μs accuracy
let spin_sleeper = spin_sleep::SpinSleeper::new(100_000)
    .with_spin_strategy(spin_sleep::SpinStrategy::YieldThread);

// Sleep for 1.01255 seconds, this will:
//  - thread:sleep for 1.01245 seconds, i.e., 100μs less than the requested duration
//  - spin until total 1.01255 seconds have elapsed
spin_sleeper.sleep(Duration::new(1, 12_550_000));

Sleep can also be requested in f64 seconds or u64 nanoseconds (useful when used with time crate)

spin_sleeper.sleep_s(1.01255);
spin_sleeper.sleep_ns(1_012_550_000);

OS-specific default settings should be good enough for most cases.

let sleeper = SpinSleeper::default();

Structs

SpinSleeper

Accuracy container for spin sleeping. See crate docs.

Enums

SpinStrategy

What to do while spinning.

Functions

native_sleep

Asks the OS to put the current thread to sleep for at least the specified amount of time. Does not spin.

sleep

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

sleep_until

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

Type Aliases

Nanoseconds

Marker alias to show the meaning of a u64 in certain methods.

RatePerSecond

Marker alias to show the meaning of a f64 in certain methods.

Seconds

Marker alias to show the meaning of a f64 in certain methods.

SubsecondNanoseconds

Marker alias to show the meaning of a u32 in certain methods.