greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity
mentat/crossbeam_deque/struct.Deque.html

334 lines
31 KiB
HTML
Raw Permalink Normal View History

Update documentation
2018-08-22 17:04:13 +00:00
<!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 `Deque` struct in crate `crossbeam_deque`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Deque">
<title>crossbeam_deque::Deque - 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 struct">
<!--[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">&#9776;</div>
<p class='location'>Struct Deque</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.with_min_capacity">with_min_capacity</a><a href="#method.is_empty">is_empty</a><a href="#method.len">len</a><a href="#method.min_capacity">min_capacity</a><a href="#method.capacity">capacity</a><a href="#method.shrink_to_fit">shrink_to_fit</a><a href="#method.push">push</a><a href="#method.pop">pop</a><a href="#method.steal">steal</a><a href="#method.stealer">stealer</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div></div><p class='location'><a href='index.html'>crossbeam_deque</a></p><script>window.sidebarCurrent = {name: 'Deque', ty: 'struct', 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'>Struct <a href='index.html'>crossbeam_deque</a>::<wbr><a class="struct" href=''>Deque</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#306-309' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Deque&lt;T&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A concurrent work-stealing deque.</p>
<p>A deque has two ends: bottom and top. Elements can be <a href="struct.Deque.html#method.push"><code>push</code></a>ed into the bottom and <a href="struct.Deque.html#method.pop"><code>pop</code></a>ped
from the bottom. The top end is special in that elements can only be stolen from it using the
<a href="struct.Deque.html#method.steal"><code>steal</code></a> method.</p>
<h1 id="stealers" class="section-header"><a href="#stealers">Stealers</a></h1>
<p>While <a href="struct.Deque.html"><code>Deque</code></a> doesn't implement <code>Sync</code>, it can create <a href="struct.Stealer.html"><code>Stealer</code></a>s using the method
<a href="struct.Deque.html#method.stealer"><code>stealer</code></a>, and those can be easily shared among multiple threads. <a href="struct.Stealer.html"><code>Stealer</code></a>s can
only <a href="struct.Stealer.html#method.steal"><code>steal</code></a> elements from the top end of the deque.</p>
<h1 id="capacity" class="section-header"><a href="#capacity">Capacity</a></h1>
<p>The data structure is dynamically grows as elements are inserted and removed from it. If the
internal buffer gets full, a new one twice the size of the original is allocated. Similarly,
if it is less than a quarter full, a new buffer half the size of the original is allocated.</p>
<p>In order to prevent frequent resizing (reallocations may be costly), it is possible to specify
a large minimum capacity for the deque by calling <a href="struct.Deque.html#method.with_min_capacity"><code>Deque::with_min_capacity</code></a>. This
constructor will make sure that the internal buffer never shrinks below that size.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::{<span class="ident">Deque</span>, <span class="ident">Steal</span>};
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="ident">with_min_capacity</span>(<span class="number">1000</span>);
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">d</span>.<span class="ident">stealer</span>();
<span class="ident">d</span>.<span class="ident">push</span>(<span class="string">&#39;a&#39;</span>);
<span class="ident">d</span>.<span class="ident">push</span>(<span class="string">&#39;b&#39;</span>);
<span class="ident">d</span>.<span class="ident">push</span>(<span class="string">&#39;c&#39;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">pop</span>(), <span class="prelude-val">Some</span>(<span class="string">&#39;c&#39;</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">steal</span>(), <span class="ident">Steal</span>::<span class="ident">Data</span>(<span class="string">&#39;a&#39;</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">steal</span>(), <span class="ident">Steal</span>::<span class="ident">Data</span>(<span class="string">&#39;b&#39;</span>));</pre>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="struct" href="../crossbeam_deque/struct.Deque.html" title="struct crossbeam_deque::Deque">Deque</a>&lt;T&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#313-697' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../crossbeam_deque/struct.Deque.html" title="struct crossbeam_deque::Deque">Deque</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#325-330' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new deque.</p>
<p>The internal buffer is destructed as soon as the deque and all its stealers get dropped.</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::<span class="ident">Deque</span>;
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="op">&lt;</span><span class="ident">i32</span><span class="op">&gt;</span>::<span class="ident">new</span>();</pre>
</div><h4 id='method.with_min_capacity' class="method"><span id='with_min_capacity.v' class='invisible'><code>pub fn <a href='#method.with_min_capacity' class='fnname'>with_min_capacity</a>(min_cap: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../crossbeam_deque/struct.Deque.html" title="struct crossbeam_deque::Deque">Deque</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#346-351' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a new deque with the specified minimum capacity.</p>
<p>If the capacity is not a power of two, it will be rounded up to the next one.</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::<span class="ident">Deque</span>;
<span class="comment">// The minimum capacity will be rounded up to 1024.</span>
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="op">&lt;</span><span class="ident">i32</span><span class="op">&gt;</span>::<span class="ident">with_min_capacity</span>(<span class="number">1000</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">min_capacity</span>(), <span class="number">1024</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">capacity</span>(), <span class="number">1024</span>);</pre>
</div><h4 id='method.is_empty' class="method"><span id='is_empty.v' class='invisible'><code>pub fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#365-367' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns <code>true</code> if the deque is empty.</p>
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::<span class="ident">Deque</span>;
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="ident">new</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">is_empty</span>());
<span class="ident">d</span>.<span class="ident">push</span>(<span class="string">&quot;foo&quot;</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">d</span>.<span class="ident">is_empty</span>());</pre>
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>pub fn <a href='#method.len' class='fnname'>len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#382-386' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the number of elements in the deque.</p>
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::<span class="ident">Deque</span>;
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="ident">new</span>();
<span class="ident">d</span>.<span class="ident">push</span>(<span class="string">&#39;a&#39;</span>);
<span class="ident">d</span>.<span class="ident">push</span>(<span class="string">&#39;b&#39;</span>);
<span class="ident">d</span>.<span class="ident">push</span>(<span class="string">&#39;c&#39;</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">len</span>(), <span class="number">3</span>);</pre>
</div><h4 id='method.min_capacity' class="method"><span id='min_capacity.v' class='invisible'><code>pub fn <a href='#method.min_capacity' class='fnname'>min_capacity</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#404-406' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the minimum capacity of the deque.</p>
<p>The minimum capacity can be specified in <a href="struct.Deque.html#method.with_min_capacity"><code>Deque::with_min_capacity</code></a>.</p>
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::<span class="ident">Deque</span>;
<span class="comment">// Gets rounded to the next power of two.</span>
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="op">&lt;</span><span class="ident">i32</span><span class="op">&gt;</span>::<span class="ident">with_min_capacity</span>(<span class="number">50</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">min_capacity</span>(), <span class="number">64</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">capacity</span>(), <span class="number">64</span>);</pre>
</div><h4 id='method.capacity' class="method"><span id='capacity.v' class='invisible'><code>pub fn <a href='#method.capacity' class='fnname'>capacity</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#423-428' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the number of elements the deque can hold without reallocating.</p>
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::<span class="ident">Deque</span>;
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="ident">with_min_capacity</span>(<span class="number">50</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">capacity</span>(), <span class="number">64</span>);
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">200</span> {
<span class="ident">d</span>.<span class="ident">push</span>(<span class="ident">i</span>);
}
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">capacity</span>(), <span class="number">256</span>);</pre>
</div><h4 id='method.shrink_to_fit' class="method"><span id='shrink_to_fit.v' class='invisible'><code>pub fn <a href='#method.shrink_to_fit' class='fnname'>shrink_to_fit</a>(&amp;self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#459-476' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Shrinks the capacity of the deque as much as possible.</p>
<p>The capacity will drop down as close as possible to the length but there may still be some
free space left.</p>
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::<span class="ident">Deque</span>;
<span class="comment">// Insert a lot of elements. This makes the buffer grow.</span>
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="ident">new</span>();
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">200</span> {
<span class="ident">d</span>.<span class="ident">push</span>(<span class="ident">i</span>);
}
<span class="comment">// Remove all elements.</span>
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">d</span>.<span class="ident">stealer</span>();
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">200</span> {
<span class="ident">s</span>.<span class="ident">steal</span>();
}
<span class="comment">// Stealers cannot shrink the buffer, so the capacity is still very large.</span>
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">capacity</span>() <span class="op">&gt;=</span> <span class="number">200</span>);
<span class="comment">// Shrink the buffer. The capacity drops down, but some free space may still be left.</span>
<span class="ident">d</span>.<span class="ident">shrink_to_fit</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">capacity</span>() <span class="op">&lt;</span> <span class="number">50</span>);</pre>
</div><h4 id='method.push' class="method"><span id='push.v' class='invisible'><code>pub fn <a href='#method.push' class='fnname'>push</a>(&amp;self, value: T)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#492-522' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Pushes an element into the bottom of the deque.</p>
<p>If the internal buffer is full, a new one twice the capacity of the current one will be
allocated.</p>
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::<span class="ident">Deque</span>;
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="ident">new</span>();
<span class="ident">d</span>.<span class="ident">push</span>(<span class="number">1</span>);
<span class="ident">d</span>.<span class="ident">push</span>(<span class="number">2</span>);</pre>
</div><h4 id='method.pop' class="method"><span id='pop.v' class='invisible'><code>pub fn <a href='#method.pop' class='fnname'>pop</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#542-602' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Pops an element from the bottom of the deque.</p>
<p>If the internal buffer is less than a quarter full, a new buffer half the capacity of the
current one will be allocated.</p>
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::<span class="ident">Deque</span>;
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="ident">new</span>();
<span class="ident">d</span>.<span class="ident">push</span>(<span class="number">1</span>);
<span class="ident">d</span>.<span class="ident">push</span>(<span class="number">2</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">pop</span>(), <span class="prelude-val">Some</span>(<span class="number">2</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">pop</span>(), <span class="prelude-val">Some</span>(<span class="number">1</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">pop</span>(), <span class="prelude-val">None</span>);</pre>
</div><h4 id='method.steal' class="method"><span id='steal.v' class='invisible'><code>pub fn <a href='#method.steal' class='fnname'>steal</a>(&amp;self) -&gt; <a class="enum" href="../crossbeam_deque/enum.Steal.html" title="enum crossbeam_deque::Steal">Steal</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#640-671' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Steals an element from the top of the deque.</p>
<p>Unlike most methods in concurrent data structures, if another operation gets in the way
while attempting to steal data, this method will return immediately with <a href="enum.Steal.html#variant.Retry"><code>Steal::Retry</code></a>
instead of retrying.</p>
<p>If the internal buffer is less than a quarter full, a new buffer half the capacity of the
current one will be allocated.</p>
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::{<span class="ident">Deque</span>, <span class="ident">Steal</span>};
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="ident">new</span>();
<span class="ident">d</span>.<span class="ident">push</span>(<span class="number">1</span>);
<span class="ident">d</span>.<span class="ident">push</span>(<span class="number">2</span>);
<span class="comment">// Attempt to steal an element.</span>
<span class="comment">//</span>
<span class="comment">// No other threads are working with the deque, so this time we know for sure that we</span>
<span class="comment">// won&#39;t get `Steal::Retry` as the result.</span>
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">steal</span>(), <span class="ident">Steal</span>::<span class="ident">Data</span>(<span class="number">1</span>));
<span class="comment">// Attempt to steal an element, but keep retrying if we get `Retry`.</span>
<span class="kw">let</span> <span class="ident">stolen</span> <span class="op">=</span> <span class="kw">loop</span> {
<span class="kw">match</span> <span class="ident">d</span>.<span class="ident">steal</span>() {
<span class="ident">Steal</span>::<span class="ident">Empty</span> <span class="op">=&gt;</span> <span class="kw">break</span> <span class="prelude-val">None</span>,
<span class="ident">Steal</span>::<span class="ident">Data</span>(<span class="ident">data</span>) <span class="op">=&gt;</span> <span class="kw">break</span> <span class="prelude-val">Some</span>(<span class="ident">data</span>),
<span class="ident">Steal</span>::<span class="ident">Retry</span> <span class="op">=&gt;</span> {}
}
};
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">stolen</span>, <span class="prelude-val">Some</span>(<span class="number">2</span>));</pre>
</div><h4 id='method.stealer' class="method"><span id='stealer.v' class='invisible'><code>pub fn <a href='#method.stealer' class='fnname'>stealer</a>(&amp;self) -&gt; <a class="struct" href="../crossbeam_deque/struct.Stealer.html" title="struct crossbeam_deque::Stealer">Stealer</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#691-696' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Creates a stealer that can be shared with other threads.</p>
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">crossbeam_deque</span>::{<span class="ident">Deque</span>, <span class="ident">Steal</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Deque</span>::<span class="ident">new</span>();
<span class="ident">d</span>.<span class="ident">push</span>(<span class="number">1</span>);
<span class="ident">d</span>.<span class="ident">push</span>(<span class="number">2</span>);
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">d</span>.<span class="ident">stealer</span>();
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">steal</span>(), <span class="ident">Steal</span>::<span class="ident">Data</span>(<span class="number">1</span>));
}).<span class="ident">join</span>().<span class="ident">unwrap</span>();</pre>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Send' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../crossbeam_deque/struct.Deque.html" title="struct crossbeam_deque::Deque">Deque</a>&lt;T&gt;</code><a href='#impl-Send' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#311' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../crossbeam_deque/struct.Deque.html" title="struct crossbeam_deque::Deque">Deque</a>&lt;T&gt;</code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#699-703' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#700-702' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Default' class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../crossbeam_deque/struct.Deque.html" title="struct crossbeam_deque::Deque">Deque</a>&lt;T&gt;</code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#705-709' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../crossbeam_deque/struct.Deque.html" title="struct crossbeam_deque::Deque">Deque</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/crossbeam_deque/lib.rs.html#706-708' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div></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>&#9166;</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_deque";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>
Reference in a new issue Copy permalink