175 lines
40 KiB
HTML
175 lines
40 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="Performs exponential backoff in spin loops."><meta name="keywords" content="rust, rustlang, rust-lang, Backoff"><title>Backoff in crossbeam_utils - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../crossbeam_utils/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Struct Backoff</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.is_completed">is_completed</a><a href="#method.new">new</a><a href="#method.reset">reset</a><a href="#method.snooze">snooze</a><a href="#method.spin">spin</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2 class="location">Other items in<br><a href="index.html">crossbeam_utils</a></h2><div id="sidebar-vars" data-name="Backoff" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../crossbeam_utils/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><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><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">crossbeam_utils</a>::<wbr><a class="struct" href="#">Backoff</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></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_utils/backoff.rs.html#80-82" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust struct"><code>pub struct Backoff { /* fields omitted */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Performs exponential backoff in spin loops.</p>
|
||
<p>Backing off in spin loops reduces contention and improves overall performance.</p>
|
||
<p>This primitive can execute <em>YIELD</em> and <em>PAUSE</em> instructions, yield the current thread to the OS
|
||
scheduler, and tell when is a good time to block the thread using a different synchronization
|
||
mechanism. Each step of the back off procedure takes roughly twice as long as the previous
|
||
step.</p>
|
||
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
|
||
<p>Backing off in a lock-free loop:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::Backoff</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::AtomicUsize</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::Ordering::SeqCst</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">fetch_mul</span>(<span class="ident">a</span>: <span class="kw-2">&</span><span class="ident">AtomicUsize</span>, <span class="ident">b</span>: <span class="ident">usize</span>) -> <span class="ident">usize</span> {
|
||
<span class="kw">let</span> <span class="ident">backoff</span> <span class="op">=</span> <span class="ident">Backoff::new</span>();
|
||
<span class="kw">loop</span> {
|
||
<span class="kw">let</span> <span class="ident">val</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>);
|
||
<span class="kw">if</span> <span class="ident">a</span>.<span class="ident">compare_exchange</span>(<span class="ident">val</span>, <span class="ident">val</span>.<span class="ident">wrapping_mul</span>(<span class="ident">b</span>), <span class="ident">SeqCst</span>, <span class="ident">SeqCst</span>).<span class="ident">is_ok</span>() {
|
||
<span class="kw">return</span> <span class="ident">val</span>;
|
||
}
|
||
<span class="ident">backoff</span>.<span class="ident">spin</span>();
|
||
}
|
||
}</code></pre></div>
|
||
<p>Waiting for an <a href="https://doc.rust-lang.org/1.59.0/core/sync/atomic/struct.AtomicBool.html"><code>AtomicBool</code></a> to become <code>true</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::Backoff</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::AtomicBool</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::Ordering::SeqCst</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">spin_wait</span>(<span class="ident">ready</span>: <span class="kw-2">&</span><span class="ident">AtomicBool</span>) {
|
||
<span class="kw">let</span> <span class="ident">backoff</span> <span class="op">=</span> <span class="ident">Backoff::new</span>();
|
||
<span class="kw">while</span> <span class="op">!</span><span class="ident">ready</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
|
||
<span class="ident">backoff</span>.<span class="ident">snooze</span>();
|
||
}
|
||
}</code></pre></div>
|
||
<p>Waiting for an <a href="https://doc.rust-lang.org/1.59.0/core/sync/atomic/struct.AtomicBool.html"><code>AtomicBool</code></a> to become <code>true</code> and parking the thread after a long wait.
|
||
Note that whoever sets the atomic variable to <code>true</code> must notify the parked thread by calling
|
||
<a href="https://doc.rust-lang.org/1.59.0/std/thread/struct.Thread.html#method.unpark"><code>unpark()</code></a>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::Backoff</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::AtomicBool</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::Ordering::SeqCst</span>;
|
||
<span class="kw">use</span> <span class="ident">std::thread</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">blocking_wait</span>(<span class="ident">ready</span>: <span class="kw-2">&</span><span class="ident">AtomicBool</span>) {
|
||
<span class="kw">let</span> <span class="ident">backoff</span> <span class="op">=</span> <span class="ident">Backoff::new</span>();
|
||
<span class="kw">while</span> <span class="op">!</span><span class="ident">ready</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
|
||
<span class="kw">if</span> <span class="ident">backoff</span>.<span class="ident">is_completed</span>() {
|
||
<span class="ident">thread::park</span>();
|
||
} <span class="kw">else</span> {
|
||
<span class="ident">backoff</span>.<span class="ident">snooze</span>();
|
||
}
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#84-279" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#95-97" title="goto source code">[src]</a></div><a href="#method.new" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></div></summary><div class="docblock"><p>Creates a new <code>Backoff</code>.</p>
|
||
<h5 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::Backoff</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">backoff</span> <span class="op">=</span> <span class="ident">Backoff::new</span>();</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.reset" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#110-112" title="goto source code">[src]</a></div><a href="#method.reset" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.reset" class="fnname">reset</a>(&self)</h4></div></summary><div class="docblock"><p>Resets the <code>Backoff</code>.</p>
|
||
<h5 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::Backoff</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">backoff</span> <span class="op">=</span> <span class="ident">Backoff::new</span>();
|
||
<span class="ident">backoff</span>.<span class="ident">reset</span>();</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.spin" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#146-157" title="goto source code">[src]</a></div><a href="#method.spin" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.spin" class="fnname">spin</a>(&self)</h4></div></summary><div class="docblock"><p>Backs off in a lock-free loop.</p>
|
||
<p>This method should be used when we need to retry an operation because another thread made
|
||
progress.</p>
|
||
<p>The processor may yield using the <em>YIELD</em> or <em>PAUSE</em> instruction.</p>
|
||
<h5 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h5>
|
||
<p>Backing off in a lock-free loop:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::Backoff</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::AtomicUsize</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::Ordering::SeqCst</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">fetch_mul</span>(<span class="ident">a</span>: <span class="kw-2">&</span><span class="ident">AtomicUsize</span>, <span class="ident">b</span>: <span class="ident">usize</span>) -> <span class="ident">usize</span> {
|
||
<span class="kw">let</span> <span class="ident">backoff</span> <span class="op">=</span> <span class="ident">Backoff::new</span>();
|
||
<span class="kw">loop</span> {
|
||
<span class="kw">let</span> <span class="ident">val</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>);
|
||
<span class="kw">if</span> <span class="ident">a</span>.<span class="ident">compare_exchange</span>(<span class="ident">val</span>, <span class="ident">val</span>.<span class="ident">wrapping_mul</span>(<span class="ident">b</span>), <span class="ident">SeqCst</span>, <span class="ident">SeqCst</span>).<span class="ident">is_ok</span>() {
|
||
<span class="kw">return</span> <span class="ident">val</span>;
|
||
}
|
||
<span class="ident">backoff</span>.<span class="ident">spin</span>();
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="ident">AtomicUsize::new</span>(<span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">fetch_mul</span>(<span class="kw-2">&</span><span class="ident">a</span>, <span class="number">8</span>), <span class="number">7</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">a</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>), <span class="number">56</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.snooze" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#208-232" title="goto source code">[src]</a></div><a href="#method.snooze" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.snooze" class="fnname">snooze</a>(&self)</h4></div></summary><div class="docblock"><p>Backs off in a blocking loop.</p>
|
||
<p>This method should be used when we need to wait for another thread to make progress.</p>
|
||
<p>The processor may yield using the <em>YIELD</em> or <em>PAUSE</em> instruction and the current thread
|
||
may yield by giving up a timeslice to the OS scheduler.</p>
|
||
<p>In <code>#[no_std]</code> environments, this method is equivalent to <a href="struct.Backoff.html#method.spin"><code>spin</code></a>.</p>
|
||
<p>If possible, use <a href="struct.Backoff.html#method.is_completed"><code>is_completed</code></a> to check when it is advised to stop using backoff and
|
||
block the current thread using a different synchronization mechanism instead.</p>
|
||
<h5 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h5>
|
||
<p>Waiting for an <a href="https://doc.rust-lang.org/1.59.0/core/sync/atomic/struct.AtomicBool.html"><code>AtomicBool</code></a> to become <code>true</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::Backoff</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::Arc</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::AtomicBool</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::Ordering::SeqCst</span>;
|
||
<span class="kw">use</span> <span class="ident">std::thread</span>;
|
||
<span class="kw">use</span> <span class="ident">std::time::Duration</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">spin_wait</span>(<span class="ident">ready</span>: <span class="kw-2">&</span><span class="ident">AtomicBool</span>) {
|
||
<span class="kw">let</span> <span class="ident">backoff</span> <span class="op">=</span> <span class="ident">Backoff::new</span>();
|
||
<span class="kw">while</span> <span class="op">!</span><span class="ident">ready</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
|
||
<span class="ident">backoff</span>.<span class="ident">snooze</span>();
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">Arc::new</span>(<span class="ident">AtomicBool::new</span>(<span class="bool-val">false</span>));
|
||
<span class="kw">let</span> <span class="ident">ready2</span> <span class="op">=</span> <span class="ident">ready</span>.<span class="ident">clone</span>();
|
||
|
||
<span class="ident">thread::spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
||
<span class="ident">thread::sleep</span>(<span class="ident">Duration::from_millis</span>(<span class="number">100</span>));
|
||
<span class="ident">ready2</span>.<span class="ident">store</span>(<span class="bool-val">true</span>, <span class="ident">SeqCst</span>);
|
||
});
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">ready</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>), <span class="bool-val">false</span>);
|
||
<span class="ident">spin_wait</span>(<span class="kw-2">&</span><span class="ident">ready</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">ready</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>), <span class="bool-val">true</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.is_completed" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#276-278" title="goto source code">[src]</a></div><a href="#method.is_completed" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.is_completed" class="fnname">is_completed</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Returns <code>true</code> if exponential backoff has completed and blocking the thread is advised.</p>
|
||
<h5 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h5>
|
||
<p>Waiting for an <a href="https://doc.rust-lang.org/1.59.0/core/sync/atomic/struct.AtomicBool.html"><code>AtomicBool</code></a> to become <code>true</code> and parking the thread after a long wait:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">crossbeam_utils::Backoff</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::Arc</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::AtomicBool</span>;
|
||
<span class="kw">use</span> <span class="ident">std::sync::atomic::Ordering::SeqCst</span>;
|
||
<span class="kw">use</span> <span class="ident">std::thread</span>;
|
||
<span class="kw">use</span> <span class="ident">std::time::Duration</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">blocking_wait</span>(<span class="ident">ready</span>: <span class="kw-2">&</span><span class="ident">AtomicBool</span>) {
|
||
<span class="kw">let</span> <span class="ident">backoff</span> <span class="op">=</span> <span class="ident">Backoff::new</span>();
|
||
<span class="kw">while</span> <span class="op">!</span><span class="ident">ready</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>) {
|
||
<span class="kw">if</span> <span class="ident">backoff</span>.<span class="ident">is_completed</span>() {
|
||
<span class="ident">thread::park</span>();
|
||
} <span class="kw">else</span> {
|
||
<span class="ident">backoff</span>.<span class="ident">snooze</span>();
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">Arc::new</span>(<span class="ident">AtomicBool::new</span>(<span class="bool-val">false</span>));
|
||
<span class="kw">let</span> <span class="ident">ready2</span> <span class="op">=</span> <span class="ident">ready</span>.<span class="ident">clone</span>();
|
||
<span class="kw">let</span> <span class="ident">waiter</span> <span class="op">=</span> <span class="ident">thread::current</span>();
|
||
|
||
<span class="ident">thread::spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
||
<span class="ident">thread::sleep</span>(<span class="ident">Duration::from_millis</span>(<span class="number">100</span>));
|
||
<span class="ident">ready2</span>.<span class="ident">store</span>(<span class="bool-val">true</span>, <span class="ident">SeqCst</span>);
|
||
<span class="ident">waiter</span>.<span class="ident">unpark</span>();
|
||
});
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">ready</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>), <span class="bool-val">false</span>);
|
||
<span class="ident">blocking_wait</span>(<span class="kw-2">&</span><span class="ident">ready</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">ready</span>.<span class="ident">load</span>(<span class="ident">SeqCst</span>), <span class="bool-val">true</span>);</code></pre></div>
|
||
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Debug" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#281-288" title="goto source code">[src]</a></div><a href="#impl-Debug" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#282-287" title="goto source code">[src]</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.59.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Default" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#290-294" title="goto source code">[src]</a></div><a href="#impl-Default" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.default" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/crossbeam_utils/backoff.rs.html#291-293" title="goto source code">[src]</a></div><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="struct.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></h4></div></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.59.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl !<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Backoff.html" title="struct crossbeam_utils::Backoff">Backoff</a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/any.rs.html#133" title="goto source code">[src]</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.59.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#209-214" title="goto source code">[src]</a></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#211" title="goto source code">[src]</a></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&</a>T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#218-222" title="goto source code">[src]</a></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/borrow.rs.html#219" title="goto source code">[src]</a></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.reference.html">&mut </a>T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.59.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#550-554" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#551" title="goto source code">[src]</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#538-545" title="goto source code">[src]</a></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#542" title="goto source code">[src]</a></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#588-597" title="goto source code">[src]</a></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#594" title="goto source code">[src]</a></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#574-583" title="goto source code">[src]</a></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.59.0/src/core/convert/mod.rs.html#580" title="goto source code">[src]</a></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="crossbeam_utils" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |