|
|
|
|
|
<!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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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><a href='../crossbeam/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate crossbeam</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all crossbeam's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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-112' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>crossbeam</a></span></h1><div class='docblock'><p>Tools for concurrent programming.</p>
|
|
|
|
|
|
<h2 id="atomics" class="section-header"><a href="#atomics">Atomics</a></h2>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="atomic/struct.AtomicCell.html"><code>AtomicCell</code></a>, a thread-safe mutable memory location.</li>
|
|
|
|
|
|
<li><a href="atomic/trait.AtomicConsume.html"><code>AtomicConsume</code></a>, for reading from primitive atomic types with "consume" ordering.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h2 id="data-structures" class="section-header"><a href="#data-structures">Data structures</a></h2>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="deque/index.html"><code>deque</code></a>, work-stealing deques for building task schedulers.</li>
|
|
|
|
|
|
<li><a href="queue/struct.ArrayQueue.html"><code>ArrayQueue</code></a>, a bounded MPMC queue that allocates a fixed-capacity buffer on construction.</li>
|
|
|
|
|
|
<li><a href="queue/struct.SegQueue.html"><code>SegQueue</code></a>, an unbounded MPMC queue that allocates small buffers, segments, on demand.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h2 id="memory-management" class="section-header"><a href="#memory-management">Memory management</a></h2>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="epoch/index.html"><code>epoch</code></a>, an epoch-based garbage collector.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h2 id="thread-synchronization" class="section-header"><a href="#thread-synchronization">Thread synchronization</a></h2>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="channel/index.html"><code>channel</code></a>, multi-producer multi-consumer channels for message passing.</li>
|
|
|
|
|
|
<li><a href="sync/struct.Parker.html"><code>Parker</code></a>, a thread parking primitive.</li>
|
|
|
|
|
|
<li><a href="sync/struct.ShardedLock.html"><code>ShardedLock</code></a>, a sharded reader-writer lock with fast concurrent reads.</li>
|
|
|
|
|
|
<li><a href="sync/struct.WaitGroup.html"><code>WaitGroup</code></a>, for synchronizing the beginning or end of some computation.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h2 id="utilities" class="section-header"><a href="#utilities">Utilities</a></h2>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="utils/struct.Backoff.html"><code>Backoff</code></a>, for exponential backoff in spin loops.</li>
|
|
|
|
|
|
<li><a href="utils/struct.CachePadded.html"><code>CachePadded</code></a>, for padding and aligning a value to the length of a cache line.</li>
|
|
|
|
|
|
<li><a href="fn.scope.html"><code>scope</code></a>, for spawning threads that borrow local variables from the stack.</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="atomic/index.html" title='crossbeam::atomic mod'>atomic</a></td><td class='docblock-short'><p>Atomic types.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="channel/index.html" title='crossbeam::channel mod'>channel</a></td><td class='docblock-short'><p>Multi-producer multi-consumer channels for message passing.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="deque/index.html" title='crossbeam::deque mod'>deque</a></td><td class='docblock-short'><p>Concurrent work-stealing deques.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="epoch/index.html" title='crossbeam::epoch mod'>epoch</a></td><td class='docblock-short'><p>Epoch-based memory reclamation.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="queue/index.html" title='crossbeam::queue mod'>queue</a></td><td class='docblock-short'><p>Concurrent queues.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="sync/index.html" title='crossbeam::sync mod'>sync</a></td><td class='docblock-short'><p>Thread synchronization primitives.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="thread/index.html" title='crossbeam::thread mod'>thread</a></td><td class='docblock-short'><p>Threads that can borrow variables from the stack.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="utils/index.html" title='crossbeam::utils mod'>utils</a></td><td class='docblock-short'><p>Miscellaneous utilities.</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.scope.html" title='crossbeam::scope fn'>scope</a></td><td class='docblock-short'><p>Creates a new scope for spawning threads.</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "crossbeam";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
