# crossbeam::epoch::pin - Rust
API documentation for the Rust `pin` fn in crate `crossbeam`.
Keywords: rust, rustlang, rust-lang, pin

# Function crossbeam::epoch::pin [−] [src]

    pub fn pin() -> Guard

Pin the current epoch.

Threads generally pin before interacting with a lock-free data structure. Pinning requires a full memory barrier, so is somewhat expensive. It is rentrant -- you can safely acquire nested guards, and only the first guard requires a barrier. Thus, in cases where you expect to perform several lock-free operations in quick succession, you may consider pinning around the entire set of operations.

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