168 lines
No EOL
15 KiB
HTML
168 lines
No EOL
15 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 `AtomicConsume` trait in crate `crossbeam_utils`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, AtomicConsume">
|
||
|
||
<title>crossbeam_utils::consume::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>
|
||
|
||
|
||
|
||
|
||
</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>
|
||
|
||
<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">AtomicBool</a><a href="#impl-AtomicConsume">AtomicUsize</a><a href="#impl-AtomicConsume">AtomicIsize</a><a href="#impl-AtomicConsume">AtomicPtr<T></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'>consume</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">
|
||
<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'>Trait <a href='../index.html'>crossbeam_utils</a>::<wbr><a href='index.html'>consume</a>::<wbr><a class="trait" href=''>AtomicConsume</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_utils/consume.rs.html#6-26' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><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/consume/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::consume::AtomicConsume::Val">Val</a>;
|
||
}</pre></div><div class='docblock'><p>Trait which allows reading from an atomic type 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'><span id='Val.t' class='invisible'><code>type <a href='#associatedtype.Val' class="type">Val</a></code></span></h3><div class='docblock'><p>Type returned by <code>load_consume</code>.</p>
|
||
</div></div>
|
||
<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'><span id='load_consume.v' class='invisible'><code>fn <a href='#tymethod.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/consume/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::consume::AtomicConsume::Val">Val</a></code></span></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>
|
||
<h2 id='foreign-impls' class='small-section-header'>
|
||
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-AtomicConsume' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../crossbeam_utils/consume/trait.AtomicConsume.html" title="trait crossbeam_utils::consume::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' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/crossbeam_utils/consume.rs.html#52-55' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Val-1' class="type"><span id='Val.t-1' class='invisible'><code>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></span></h4>
|
||
<h4 id='method.load_consume' class="method"><span id='load_consume.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/consume/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::consume::AtomicConsume::Val">Val</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/crossbeam_utils/consume.rs.html#44-46' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-AtomicConsume-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../crossbeam_utils/consume/trait.AtomicConsume.html" title="trait crossbeam_utils::consume::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-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/crossbeam_utils/consume.rs.html#52-55' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Val-2' class="type"><span id='Val.t-2' class='invisible'><code>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></span></h4>
|
||
<h4 id='method.load_consume-1' class="method"><span id='load_consume.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/consume/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::consume::AtomicConsume::Val">Val</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/crossbeam_utils/consume.rs.html#44-46' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-AtomicConsume-2' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../crossbeam_utils/consume/trait.AtomicConsume.html" title="trait crossbeam_utils::consume::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-2' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/crossbeam_utils/consume.rs.html#52-55' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Val-3' class="type"><span id='Val.t-3' class='invisible'><code>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></span></h4>
|
||
<h4 id='method.load_consume-2' class="method"><span id='load_consume.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/consume/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::consume::AtomicConsume::Val">Val</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/crossbeam_utils/consume.rs.html#44-46' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-AtomicConsume-3' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="../../crossbeam_utils/consume/trait.AtomicConsume.html" title="trait crossbeam_utils::consume::AtomicConsume">AtomicConsume</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/sync/atomic/struct.AtomicPtr.html" title="struct core::sync::atomic::AtomicPtr">AtomicPtr</a><T></code><a href='#impl-AtomicConsume-3' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/crossbeam_utils/consume.rs.html#79-82' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.Val-4' class="type"><span id='Val.t-4' class='invisible'><code>type <a href='#associatedtype.Val' class="type">Val</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut T</a></code></span></h4>
|
||
<h4 id='method.load_consume-3' class="method"><span id='load_consume.v-4' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.load_consume' class='fnname'>load_consume</a>(&self) -> Self::<a class="type" href="../../crossbeam_utils/consume/trait.AtomicConsume.html#associatedtype.Val" title="type crossbeam_utils::consume::AtomicConsume::Val">Val</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/crossbeam_utils/consume.rs.html#44-46' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span>
|
||
<h2 id='implementors' class='small-section-header'>
|
||
Implementors<a href='#implementors' class='anchor'></a>
|
||
</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../../implementors/crossbeam_utils/consume/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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "crossbeam_utils";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |