Struct parking_lot_core::SpinWait

source ·
pub struct SpinWait { /* private fields */ }
Expand description

A counter used to perform exponential backoff in spin loops.

Implementations§

source§

impl SpinWait

source

pub fn new() -> Self

Creates a new SpinWait.

source

pub fn reset(&mut self)

Resets a SpinWait to its initial state.

source

pub fn spin(&mut self) -> bool

Spins until the sleep threshold has been reached.

This function returns whether the sleep threshold has been reached, at which point further spinning has diminishing returns and the thread should be parked instead.

The spin strategy will initially use a CPU-bound loop but will fall back to yielding the CPU to the OS after a few iterations.

source

pub fn spin_no_yield(&mut self)

Spins without yielding the thread to the OS.

Instead, the backoff is simply capped at a maximum value. This can be used to improve throughput in compare_exchange loops that have high contention.

Trait Implementations§

source§

impl Default for SpinWait

source§

fn default() -> SpinWait

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.