core::sync::atomic::spin_loop_hint - Rust
Description: API documentation for the Rust `spin_loop_hint` fn in crate `core`.
Keywords: rust, rustlang, rust-lang, spin_loop_hint

# Function core::sync::atomic::spin_loop_hint 1.24.0[−][src]

    pub fn spin_loop_hint()

Save power or switch hyperthreads in a busy-wait spin-loop.

This function is deliberately more primitive than `std::thread::yield_now` and does not directly yield to the system's scheduler. In some cases it might be useful to use a combination of both functions. Careful benchmarking is advised.

On some platforms this function may not do anything at all.

# 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`)