<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `crossbeam` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, crossbeam">
<title>crossbeam - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
<p class='location'>Crate crossbeam</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'crossbeam', ty: 'mod', relpath: '../'};</script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>crossbeam</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../src/crossbeam/lib.rs.html#1-67' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Support for concurrent and parallel programming.</p>
<p>This crate is an early work in progress. The focus for the moment is
concurrency:</p>
<ul>
<li>
<p><strong>Non-blocking data structures</strong>. These data structures allow for high
performance, highly-concurrent access, much superior to wrapping with a
<code>Mutex</code>. Ultimately the goal is to include stacks, queues, deques, bags,
sets and maps. These live in the <code>sync</code> module.</p>
</li>
<li>
<p><strong>Memory management</strong>. Because non-blocking data structures avoid global
synchronization, it is not easy to tell when internal data can be safely
freed. The <code>mem</code> module provides generic, easy to use, and high-performance
APIs for managing memory in these cases. These live in the <code>mem</code> module.</p>
</li>
<li>
<p><strong>Synchronization</strong>. The standard library provides a few synchronization
primitives (locks, barriers, etc) but this crate seeks to expand that set
to include more advanced/niche primitives, as well as userspace
alternatives. These live in the <code>sync</code> module.</p>
</li>
<li>
<p><strong>Scoped thread API</strong>. Finally, the crate provides a "scoped" thread API,
making it possible to spawn threads that share stack data with their
parents. This functionality is exported at the top-level.</p>
</li>
</ul>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="epoch/index.html"
title='mod crossbeam::epoch'>epoch</a></td>
<td class='docblock-short'>
<p>Epoch-based memory management</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="sync/index.html"
title='mod crossbeam::sync'>sync</a></td>
<td class='docblock-short'>
<p>Synchronization primitives.</p>
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.CachePadded.html"
title='struct crossbeam::CachePadded'>CachePadded</a></td>
<td class='docblock-short'>
<p>Pad <code>T</code> to the length of a cacheline.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Scope.html"
title='struct crossbeam::Scope'>Scope</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ScopedJoinHandle.html"
title='struct crossbeam::ScopedJoinHandle'>ScopedJoinHandle</a></td>
<td class='docblock-short'>
<p>A handle to a scoped thread</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.ZerosValid.html"
title='trait crossbeam::ZerosValid'>ZerosValid</a></td>
<td class='docblock-short'>
<p>Types for which mem::zeroed() is safe.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.builder_spawn_unsafe.html"
title='fn crossbeam::builder_spawn_unsafe'>builder_spawn_unsafe</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
<td class='docblock-short'>
<p>Like <code>std::thread::Builder::spawn</code>, but without the closure bounds.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.scope.html"
title='fn crossbeam::scope'>scope</a></td>
<td class='docblock-short'>
<p>Create a new <code>scope</code>, for deferred destructors.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.spawn_unsafe.html"
title='fn crossbeam::spawn_unsafe'>spawn_unsafe</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
<td class='docblock-short'>
<p>Like <code>std::thread::spawn</code>, but without the closure bounds.</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "crossbeam";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>