|
|
|
|
|
<!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 `AtomicConsume` trait in crate `crossbeam_utils`."><meta name="keywords" content="rust, rustlang, rust-lang, AtomicConsume"><title>crossbeam_utils::atomic::AtomicConsume - 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 trait"><!--[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_utils/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait AtomicConsume</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Val">Val</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.load_consume">load_consume</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-AtomicConsume-for-AtomicBool">AtomicBool</a><a href="#impl-AtomicConsume-for-AtomicIsize">AtomicIsize</a><a href="#impl-AtomicConsume-for-AtomicPtr%3CT%3E">AtomicPtr<T></a><a href="#impl-AtomicConsume-for-AtomicUsize">AtomicUsize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>crossbeam_utils</a>::<wbr><a href='index.html'>atomic</a></p><script>window.sidebarCurrent = {name: 'AtomicConsume', ty: 'trait', 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"><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_utils/atomic/consume.rs.html#6-26' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>crossbeam_utils</a>::<wbr><a href='index.html'>atomic</a>::<wbr><a class="trait" href=''>AtomicConsume</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait AtomicConsume {
|
|
|
|
|
|
type <a href='#associatedtype.Val' class="type">Val</a>;
|
|
|
|
|
|
fn <a href='#tymethod.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/atomic/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::atomic::AtomicConsume::Val">Val</a>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Trait which allows reading from primitive atomic types with "consume" ordering.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Val' class='method'><code id='Val.t'>type <a href='#associatedtype.Val' class="type">Val</a></code></h3><div class='docblock'><p>Type returned by <code>load_consume</code>.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.load_consume' class='method'><code id='load_consume.v'>fn <a href='#tymethod.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/atomic/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::atomic::AtomicConsume::Val">Val</a></code></h3><div class='docblock'><p>Loads a value from the atomic using a "consume" memory ordering.</p>
|
|
|
|
|
|
<p>This is similar to the "acquire" ordering, except that an ordering is
|
|
|
|
|
|
only guaranteed with operations that "depend on" the result of the load.
|
|
|
|
|
|
However consume loads are usually much faster than acquire loads on
|
|
|
|
|
|
architectures with a weak memory model since they don't require memory
|
|
|
|
|
|
fence instructions.</p>
|
|
|
|
|
|
<p>The exact definition of "depend on" is a bit vague, but it works as you
|
|
|
|
|
|
would expect in practice since a lot of software, especially the Linux
|
|
|
|
|
|
kernel, rely on this behavior.</p>
|
|
|
|
|
|
<p>This is currently only implemented on ARM and AArch64, where a fence
|
|
|
|
|
|
can be avoided. On other architectures this will fall back to a simple
|
|
|
|
|
|
<code>load(Ordering::Acquire)</code>.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-AtomicConsume-for-AtomicBool' class='impl'><code class='in-band'>impl <a class="trait" href="../../crossbeam_utils/atomic/trait.AtomicConsume.html" title="trait crossbeam_utils::atomic::AtomicConsume">AtomicConsume</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/sync/atomic/struct.AtomicBool.html" title="struct core::sync::atomic::AtomicBool">AtomicBool</a></code><a href='#impl-AtomicConsume-for-AtomicBool' class='anchor'></a><a class='srclink' href='../../src/crossbeam_utils/atomic/consume.rs.html#52-55' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Val-1' class="type"><code id='Val.t-1'>type <a href='#associatedtype.Val' class="type">Val</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h4><h4 id='method.load_consume' class="method hidden"><code id='load_consume.v-1'>fn <a href='#method.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/atomic/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::atomic::AtomicConsume::Val">Val</a></code><a class='srclink' href='../../src/crossbeam_utils/atomic/consume.rs.html#44-46' title='goto source code'>[src]</a></h4></div><h3 id='impl-AtomicConsume-for-AtomicUsize' class='impl'><code class='in-band'>impl <a class="trait" href="../../crossbeam_utils/atomic/trait.AtomicConsume.html" title="trait crossbeam_utils::atomic::AtomicConsume">AtomicConsume</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/sync/atomic/struct.AtomicUsize.html" title="struct core::sync::atomic::AtomicUsize">AtomicUsize</a></code><a href='#impl-AtomicConsume-for-AtomicUsize' class='anchor'></a><a class='srclink' href='../../src/crossbeam_utils/atomic/consume.rs.html#52-55' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Val-2' class="type"><code id='Val.t-2'>type <a href='#associatedtype.Val' class="type">Val</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h4><h4 id='method.load_consume-1' class="method hidden"><code id='load_consume.v-2'>fn <a href='#method.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/atomic/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::atomic::AtomicConsume::Val">Val</a></code><a class='srclink' href='../../src/crossbeam_utils/atomic/consume.rs.html#44-46' title='goto source code'>[src]</a></h4></div><h3 id='impl-AtomicConsume-for-AtomicIsize' class='impl'><code class='in-band'>impl <a class="trait" href="../../crossbeam_utils/atomic/trait.AtomicConsume.html" title="trait crossbeam_utils::atomic::AtomicConsume">AtomicConsume</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/sync/atomic/struct.AtomicIsize.html" title="struct core::sync::atomic::AtomicIsize">AtomicIsize</a></code><a href='#impl-AtomicConsume-for-AtomicIsize' class='anchor'></a><a class='srclink' href='../../src/crossbeam_utils/atomic/consume.rs.html#52-55' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Val-3' class="type"><code id='Val.t-3'>type <a href='#associatedtype.Val' class="type">Val</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code></h4><h4 id='method.load_consume-2' class="method hidden"><code id='load_consume.v-3'>fn <a href='#method.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/atomic/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::atomic::AtomicConsume::Val">Val</a></code><a class='srclink' href='../../src/crossbeam_utils/atomic/consume.rs.html#44-46' title='goto source code'>[src]</a></h4></div><h3 id='impl-AtomicConsume-for-AtomicPtr%
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../../implementors/crossbeam_utils/atomic/trait.AtomicConsume.js">
|
|
|
|
|
|
</script></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_utils";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
