Struct mycelium_util::sync::spin::Backoff

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

An exponential backoff for spin loops.

This is a helper struct for spinning in a busy loop, with an exponentially increasing number of spins up to a maximum value.

Implementations§

source§

impl Backoff

source

pub const DEFAULT_MAX_EXPONENT: u8 = 8u8

The default maximum exponent (2^8).

This is the maximum exponent returned by Backoff::new() and Backoff::default(). To override the maximum exponent, use Backoff::with_max_exponent().

source

pub const fn new() -> Backoff

Returns a new exponential backoff with the maximum exponent set to Self::DEFAULT_MAX_EXPONENT.

source

pub fn with_max_exponent(max: u8) -> Backoff

Returns a new exponential backoff with the provided max exponent.

source

pub fn spin(&mut self)

Backs off in a spin loop.

This should be used when an operation needs to be retried because another thread or core made progress. Depending on the target architecture, this will generally issue a sequence of yield or pause instructions.

Each time this function is called, it will issue 2^exp [spin loop hints], where exp is the current exponent value (starting at 0). If exp is less than the configured maximum exponent, the exponent is incremented once the spin is complete.

Trait Implementations§

source§

impl Clone for Backoff

source§

fn clone(&self) -> Backoff

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Backoff

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Backoff

source§

fn default() -> Backoff

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

impl Copy for Backoff

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.