# [−][src]Struct parking_lot_core::SpinWait

    pub struct SpinWait { /* fields omitted */ }

A counter used to perform exponential backoff in spin loops.

## Methods

### `impl SpinWait`[src]

#### `pub fn new() -> SpinWait`[src]

Creates a new `SpinWait`.

#### `pub fn reset(&mut self)`[src]

Resets a `SpinWait` to its initial state.

#### `pub fn spin(&mut self) -> bool`[src]

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.

#### `pub fn spin_no_yield(&mut self)`[src]

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

### `impl Default for SpinWait`[src]

#### `fn default() -> SpinWait`[src]

Returns the "default value" for a type. Read more

## Auto Trait Implementations

### `impl Send for SpinWait`

### `impl Unpin for SpinWait`

### `impl Sync for SpinWait`

### `impl UnwindSafe for SpinWait`

### `impl RefUnwindSafe for SpinWait`

## Blanket Implementations

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)