mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-23 11:40:40 +00:00
187 lines
9.0 KiB
HTML
187 lines
9.0 KiB
HTML
<!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 `chase_lev` mod in crate `crossbeam`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, chase_lev">
|
||
|
||
<title>crossbeam::sync::chase_lev - 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'>Module chase_lev</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>crossbeam</a>::<wbr><a href='../index.html'>sync</a></p><script>window.sidebarCurrent = {name: 'chase_lev', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></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'>Module <a href='../../index.html'>crossbeam</a>::<wbr><a href='../index.html'>sync</a>::<wbr><a class="mod" href=''>chase_lev</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/sync/chase_lev.rs.html#11-605' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>A lock-free concurrent work-stealing deque</p>
|
||
<p>This module contains a hybrid implementation of the Chase-Lev work stealing deque
|
||
described in <a href="http://neteril.org/%7Ejeremie/Dynamic_Circular_Work_Queue.pdf">"Dynamic Circular Work-Stealing Deque"</a> and the improved version
|
||
described in <a href="http://www.di.ens.fr/%7Ezappa/readings/ppopp13.pdf">"Correct and Efficient Work-Stealing for Weak Memory Models"</a>.
|
||
The implementation is heavily based on the pseudocode found in the papers.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">crossbeam</span>::<span class="ident">sync</span>::<span class="ident">chase_lev</span>;
|
||
<span class="kw">let</span> (<span class="ident">worker</span>, <span class="ident">stealer</span>) <span class="op">=</span> <span class="ident">chase_lev</span>::<span class="ident">deque</span>();
|
||
|
||
<span class="comment">// Only the worker may push/try_pop</span>
|
||
<span class="ident">worker</span>.<span class="ident">push</span>(<span class="number">1</span>);
|
||
<span class="ident">worker</span>.<span class="ident">try_pop</span>();
|
||
|
||
<span class="comment">// Stealers take data from the other end of the deque</span>
|
||
<span class="ident">worker</span>.<span class="ident">push</span>(<span class="number">1</span>);
|
||
<span class="ident">stealer</span>.<span class="ident">steal</span>();
|
||
|
||
<span class="comment">// Stealers can be cloned to have many stealers stealing in parallel</span>
|
||
<span class="ident">worker</span>.<span class="ident">push</span>(<span class="number">1</span>);
|
||
<span class="kw">let</span> <span class="ident">stealer2</span> <span class="op">=</span> <span class="ident">stealer</span>.<span class="ident">clone</span>();
|
||
<span class="ident">stealer2</span>.<span class="ident">steal</span>();</pre>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Stealer.html"
|
||
title='struct crossbeam::sync::chase_lev::Stealer'>Stealer</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The stealing half of the work-stealing deque. Stealers have access to the
|
||
opposite end of the deque from the worker, and they only have access to the
|
||
<code>steal</code> method.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Worker.html"
|
||
title='struct crossbeam::sync::chase_lev::Worker'>Worker</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Worker half of the work-stealing deque. This worker has exclusive access to
|
||
one side of the deque, and uses <code>push</code> and <code>try_pop</code> method to manipulate it.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.Steal.html"
|
||
title='enum crossbeam::sync::chase_lev::Steal'>Steal</a></td>
|
||
<td class='docblock-short'>
|
||
<p>When stealing some data, this is an enumeration of the possible outcomes.</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.deque.html"
|
||
title='fn crossbeam::sync::chase_lev::deque'>deque</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Creates a new empty deque</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> |