<!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 `AtomicU16` struct in crate `std`."><meta name="keywords" content="rust, rustlang, rust-lang, AtomicU16"><title>std::sync::atomic::AtomicU16 - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize1.35.0.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc1.35.0.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark1.35.0.css"><link rel="stylesheet" type="text/css" href="../../../light1.35.0.css" id="themeStyle"><script src="../../../storage1.35.0.js"></script><noscript><link rel="stylesheet" href="../../../noscript1.35.0.css"></noscript><link rel="shortcut icon" href="../../../favicon1.35.0.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow1.35.0.svg");}</style></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">☰</div><a href='../../../std/index.html'><img src='../../../rust-logo1.35.0.png' alt='logo' width='100'></a><p class='location'>Struct AtomicU16</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.compare_and_swap">compare_and_swap</a><a href="#method.compare_exchange">compare_exchange</a><a href="#method.compare_exchange_weak">compare_exchange_weak</a><a href="#method.fetch_add">fetch_add</a><a href="#method.fetch_and">fetch_and</a><a href="#method.fetch_max">fetch_max</a><a href="#method.fetch_min">fetch_min</a><a href="#method.fetch_nand">fetch_nand</a><a href="#method.fetch_or">fetch_or</a><a href="#method.fetch_sub">fetch_sub</a><a href="#method.fetch_update">fetch_update</a><a href="#method.fetch_xor">fetch_xor</a><a href="#method.get_mut">get_mut</a><a href="#method.into_inner">into_inner</a><a href="#method.load">load</a><a href="#method.new">new</a><a href="#method.store">store</a><a href="#method.swap">swap</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a><a href="#impl-From%3Cu16%3E">From<u16></a><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Sync">Sync</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow">Borrow</a><a href="#impl-BorrowMut">BorrowMut</a><a href="#impl-From">From</a><a href="#impl-Into">Into</a><a href="#impl-TryFrom">TryFrom</a><a href="#impl-TryInto">TryInto</a></div></div><p class='location'><a href='../../index.html'>std</a>::<wbr><a href='../index.html'>sync</a>::<wbr><a href='index.html'>atomic</a></p><script>window.sidebarCurrent = {name: 'AtomicU16', 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="../../../brush1.35.0.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme1.35.0.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="../../../wheel1.35.0.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span class='since' title='Stable since Rust version 1.34.0'>1.34.0</span><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/core/sync/atomic.rs.html#1164-1166' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../../index.html'>std</a>::<wbr><a href='../index.html'>sync</a>::<wbr><a href='index.html'>atomic</a>::<wbr><a class="struct" href=''>AtomicU16</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'><div class="docblock attributes">#[repr(C)]
</div>pub struct AtomicU16 { /* fields omitted */ }</pre></div><div class='docblock'><p>An integer type which can be safely shared between threads.</p>
<p>This type has the same in-memory representation as the underlying
integer type, <a href="../../../std/primitive.u16.html"><code>u16</code></a>. For more about the differences between atomic types and
non-atomic types as well as information about the portability of
this type, please see the <a href="index.html">module-level documentation</a>.</p>
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1205-1888' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub const fn <a href='#method.new' class='fnname'>new</a>(v: <a class="primitive" href="../../primitive.u16.html">u16</a>) -> <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1218-1220' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new atomic integer.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">AtomicU16</span>;
<span class="kw">let</span> <span class="ident">atomic_forty_two</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">42</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3AAtomicU16%3B%0A%0Alet%20atomic_forty_two%20%3D%20AtomicU16%3A%3Anew(42)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.get_mut' class="method"><code id='get_mut.v'>pub fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&mut self) -> &mut <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1241-1243' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a mutable reference to the underlying integer.</p>
<p>This is safe because the mutable reference guarantees that no other threads are
concurrently accessing the atomic data.</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">some_var</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">some_var</span>.<span class="ident">get_mut</span>(), <span class="number">10</span>);
<span class="kw-2">*</span><span class="ident">some_var</span>.<span class="ident">get_mut</span>() <span class="op">=</span> <span class="number">5</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">5</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20mut%20some_var%20%3D%20AtomicU16%3A%3Anew(10)%3B%0Aassert_eq!(*some_var.get_mut()%2C%2010)%3B%0A*some_var.get_mut()%20%3D%205%3B%0Aassert_eq!(some_var.load(Ordering%3A%3ASeqCst)%2C%205)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.into_inner' class="method"><code id='into_inner.v'>pub fn <a href='#method.into_inner' class='fnname'>into_inner</a>(self) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1262-1264' title='goto source code'>[src]</a></h4><div class='docblock'><p>Consumes the atomic and returns the contained value.</p>
<p>This is safe because passing <code>self</code> by value guarantees that no other threads are
concurrently accessing the atomic data.</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">AtomicU16</span>;
<span class="kw">let</span> <span class="ident">some_var</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">5</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">into_inner</span>(), <span class="number">5</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3AAtomicU16%3B%0A%0Alet%20some_var%20%3D%20AtomicU16%3A%3Anew(5)%3B%0Aassert_eq!(some_var.into_inner()%2C%205)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.load' class="method"><code id='load.v'>pub fn <a href='#method.load' class='fnname'>load</a>(&self, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1295-1297' title='goto source code'>[src]</a></h4><div class='docblock'><p>Loads a value from the atomic integer.</p>
<p><code>load</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering of this operation.
Possible values are <a href="enum.Ordering.html#variant.SeqCst"><code>SeqCst</code></a>, <a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> and <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
<p>Panics if <code>order</code> is <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> or <a href="enum.Ordering.html#variant.AcqRel"><code>AcqRel</code></a>.</p>
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_var</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">5</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">5</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20some_var%20%3D%20AtomicU16%3A%3Anew(5)%3B%0A%0Aassert_eq!(some_var.load(Ordering%3A%3ARelaxed)%2C%205)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.store' class="method"><code id='store.v'>pub fn <a href='#method.store' class='fnname'>store</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>)</code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1329-1331' title='goto source code'>[src]</a></h4><div class='docblock'><p>Stores a value into the atomic integer.</p>
<p><code>store</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering of this operation.
Possible values are <a href="enum.Ordering.html#variant.SeqCst"><code>SeqCst</code></a>, <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> and <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
<p>Panics if <code>order</code> is <a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> or <a href="enum.Ordering.html#variant.AcqRel"><code>AcqRel</code></a>.</p>
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_var</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">5</span>);
<span class="ident">some_var</span>.<span class="ident">store</span>(<span class="number">10</span>, <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">10</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20some_var%20%3D%20AtomicU16%3A%3Anew(5)%3B%0A%0Asome_var.store(10%2C%20Ordering%3A%3ARelaxed)%3B%0Aassert_eq!(some_var.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.swap' class="method"><code id='swap.v'>pub fn <a href='#method.swap' class='fnname'>swap</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1359-1361' title='goto source code'>[src]</a></h4><div class='docblock'><p>Stores a value into the atomic integer, returning the previous value.</p>
<p><code>swap</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering
of this operation. All ordering modes are possible. Note that using
<a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and
using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_var</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">5</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">swap</span>(<span class="number">10</span>, <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">5</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20some_var%20%3D%20AtomicU16%3A%3Anew(5)%3B%0A%0Aassert_eq!(some_var.swap(10%2C%20Ordering%3A%3ARelaxed)%2C%205)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.compare_and_swap' class="method"><code id='compare_and_swap.v'>pub fn <a href='#method.compare_and_swap' class='fnname'>compare_and_swap</a>(&self, current: <a class="primitive" href="../../primitive.u16.html">u16</a>, new: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1399-1410' title='goto source code'>[src]</a></h4><div class='docblock'><p>Stores a value into the atomic integer if the current value is the same as
the <code>current</code> value.</p>
<p>The return value is always the previous value. If it is equal to <code>current</code>, then the
value was updated.</p>
<p><code>compare_and_swap</code> also takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory
ordering of this operation. Notice that even when using <a href="enum.Ordering.html#variant.AcqRel"><code>AcqRel</code></a>, the operation
might fail and hence just perform an <code>Acquire</code> load, but not have <code>Release</code> semantics.
Using <a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a> if it
happens, and using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_var</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">5</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">compare_and_swap</span>(<span class="number">5</span>, <span class="number">10</span>, <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">5</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">compare_and_swap</span>(<span class="number">6</span>, <span class="number">12</span>, <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">10</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20some_var%20%3D%20AtomicU16%3A%3Anew(5)%3B%0A%0Aassert_eq!(some_var.compare_and_swap(5%2C%2010%2C%20Ordering%3A%3ARelaxed)%2C%205)%3B%0Aassert_eq!(some_var.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%0Aassert_eq!(some_var.compare_and_swap(6%2C%2012%2C%20Ordering%3A%3ARelaxed)%2C%2010)%3B%0Aassert_eq!(some_var.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.compare_exchange' class="method"><code id='compare_exchange.v'>pub fn <a href='#method.compare_exchange' class='fnname'>compare_exchange</a>(<br> &self, <br> current: <a class="primitive" href="../../primitive.u16.html">u16</a>, <br> new: <a class="primitive" href="../../primitive.u16.html">u16</a>, <br> success: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>, <br> failure: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a><br>) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><<a class="primitive" href="../../primitive.u16.html">u16</a>, <a class="primitive" href="../../primitive.u16.html">u16</a>></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1457-1463' title='goto source code'>[src]</a></h4><div class='docblock'><p>Stores a value into the atomic integer if the current value is the same as
the <code>current</code> value.</p>
<p>The return value is a result indicating whether the new value was written and
containing the previous value. On success this value is guaranteed to be equal to
<code>current</code>.</p>
<p><code>compare_exchange</code> takes two <a href="enum.Ordering.html"><code>Ordering</code></a> arguments to describe the memory
ordering of this operation. The first describes the required ordering if the
operation succeeds while the second describes the required ordering when the
operation fails. Using <a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> as success ordering makes the store part
of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the successful load
<a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>. The failure ordering can only be <a href="enum.Ordering.html#variant.SeqCst"><code>SeqCst</code></a>, <a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> or <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>
and must be equivalent to or weaker than the success ordering.</p>
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_var</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">5</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">compare_exchange</span>(<span class="number">5</span>, <span class="number">10</span>,
<span class="ident">Ordering</span>::<span class="ident">Acquire</span>,
<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>),
<span class="prelude-val">Ok</span>(<span class="number">5</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">compare_exchange</span>(<span class="number">6</span>, <span class="number">12</span>,
<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>,
<span class="ident">Ordering</span>::<span class="ident">Acquire</span>),
<span class="prelude-val">Err</span>(<span class="number">10</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">some_var</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">10</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20some_var%20%3D%20AtomicU16%3A%3Anew(5)%3B%0A%0Aassert_eq!(some_var.compare_exchange(5%2C%2010%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20Ordering%3A%3AAcquire%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20Ordering%3A%3ARelaxed)%2C%0A%20%20%20%20%20%20%20%20%20%20%20Ok(5))%3B%0Aassert_eq!(some_var.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%0Aassert_eq!(some_var.compare_exchange(6%2C%2012%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20Ordering%3A%3ASeqCst%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20Ordering%3A%3AAcquire)%2C%0A%20%20%20%20%20%20%20%20%20%20%20Err(10))%3B%0Aassert_eq!(some_var.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.compare_exchange_weak' class="method"><code id='compare_exchange_weak.v'>pub fn <a href='#method.compare_exchange_weak' class='fnname'>compare_exchange_weak</a>(<br> &self, <br> current: <a class="primitive" href="../../primitive.u16.html">u16</a>, <br> new: <a class="primitive" href="../../primitive.u16.html">u16</a>, <br> success: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>, <br> failure: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a><br>) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><<a class="primitive" href="../../primitive.u16.html">u16</a>, <a class="primitive" href="../../primitive.u16.html">u16</a>></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1509-1517' title='goto source code'>[src]</a></h4><div class='docblock'><p>Stores a value into the atomic integer if the current value is the same as
the <code>current</code> value.</p>
<p>Unlike <a href="#method.compare_exchange"><code>compare_exchange</code></a>, this function is allowed to spuriously fail even
when the comparison succeeds, which can result in more efficient code on some
platforms. The return value is a result indicating whether the new value was
written and containing the previous value.</p>
<p><code>compare_exchange_weak</code> takes two <a href="enum.Ordering.html"><code>Ordering</code></a> arguments to describe the memory
ordering of this operation. The first describes the required ordering if the
operation succeeds while the second describes the required ordering when the
operation fails. Using <a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> as success ordering makes the store part
of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the successful load
<a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>. The failure ordering can only be <a href="enum.Ordering.html#variant.SeqCst"><code>SeqCst</code></a>, <a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> or <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>
and must be equivalent to or weaker than the success ordering.</p>
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">val</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">4</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">old</span> <span class="op">=</span> <span class="ident">val</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>);
<span class="kw">loop</span> {
<span class="kw">let</span> <span class="ident">new</span> <span class="op">=</span> <span class="ident">old</span> <span class="op">*</span> <span class="number">2</span>;
<span class="kw">match</span> <span class="ident">val</span>.<span class="ident">compare_exchange_weak</span>(<span class="ident">old</span>, <span class="ident">new</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>, <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>) {
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=></span> <span class="kw">break</span>,
<span class="prelude-val">Err</span>(<span class="ident">x</span>) <span class="op">=></span> <span class="ident">old</span> <span class="op">=</span> <span class="ident">x</span>,
}
}<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20val%20%3D%20AtomicU16%3A%3Anew(4)%3B%0A%0Alet%20mut%20old%20%3D%20val.load(Ordering%3A%3ARelaxed)%3B%0Aloop%20%7B%0A%20%20%20%20let%20new%20%3D%20old%20*%202%3B%0A%20%20%20%20match%20val.compare_exchange_weak(old%2C%20new%2C%20Ordering%3A%3ASeqCst%2C%20Ordering%3A%3ARelaxed)%20%7B%0A%20%20%20%20%20%20%20%20Ok(_)%20%3D%3E%20break%2C%0A%20%20%20%20%20%20%20%20Err(x)%20%3D%3E%20old%20%3D%20x%2C%0A%20%20%20%20%7D%0A%7D%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.fetch_add' class="method"><code id='fetch_add.v'>pub fn <a href='#method.fetch_add' class='fnname'>fetch_add</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1547-1549' title='goto source code'>[src]</a></h4><div class='docblock'><p>Adds to the current value, returning the previous value.</p>
<p>This operation wraps around on overflow.</p>
<p><code>fetch_add</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering
of this operation. All ordering modes are possible. Note that using
<a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and
using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">0</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">fetch_add</span>(<span class="number">10</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">0</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">10</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(0)%3B%0Aassert_eq!(foo.fetch_add(10%2C%20Ordering%3A%3ASeqCst)%2C%200)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ASeqCst)%2C%2010)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.fetch_sub' class="method"><code id='fetch_sub.v'>pub fn <a href='#method.fetch_sub' class='fnname'>fetch_sub</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1579-1581' title='goto source code'>[src]</a></h4><div class='docblock'><p>Subtracts from the current value, returning the previous value.</p>
<p>This operation wraps around on overflow.</p>
<p><code>fetch_sub</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering
of this operation. All ordering modes are possible. Note that using
<a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and
using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">20</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">fetch_sub</span>(<span class="number">10</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">20</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">10</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(20)%3B%0Aassert_eq!(foo.fetch_sub(10%2C%20Ordering%3A%3ASeqCst)%2C%2020)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ASeqCst)%2C%2010)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.fetch_and' class="method"><code id='fetch_and.v'>pub fn <a href='#method.fetch_and' class='fnname'>fetch_and</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1614-1616' title='goto source code'>[src]</a></h4><div class='docblock'><p>Bitwise "and" with the current value.</p>
<p>Performs a bitwise "and" operation on the current value and the argument <code>val</code>, and
sets the new value to the result.</p>
<p>Returns the previous value.</p>
<p><code>fetch_and</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering
of this operation. All ordering modes are possible. Note that using
<a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and
using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">0b101101</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">fetch_and</span>(<span class="number">0b110011</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">0b101101</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">0b100001</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(0b101101)%3B%0Aassert_eq!(foo.fetch_and(0b110011%2C%20Ordering%3A%3ASeqCst)%2C%200b101101)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ASeqCst)%2C%200b100001)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.fetch_nand' class="method"><code id='fetch_nand.v'>pub fn <a href='#method.fetch_nand' class='fnname'>fetch_nand</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1650-1652' title='goto source code'>[src]</a></h4><div class='docblock'><p>Bitwise "nand" with the current value.</p>
<p>Performs a bitwise "nand" operation on the current value and the argument <code>val</code>, and
sets the new value to the result.</p>
<p>Returns the previous value.</p>
<p><code>fetch_nand</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering
of this operation. All ordering modes are possible. Note that using
<a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and
using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">0x13</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">fetch_nand</span>(<span class="number">0x31</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">0x13</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="op">!</span>(<span class="number">0x13</span> <span class="op">&</span> <span class="number">0x31</span>));<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(0x13)%3B%0Aassert_eq!(foo.fetch_nand(0x31%2C%20Ordering%3A%3ASeqCst)%2C%200x13)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ASeqCst)%2C%20!(0x13%20%26%200x31))%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.fetch_or' class="method"><code id='fetch_or.v'>pub fn <a href='#method.fetch_or' class='fnname'>fetch_or</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1685-1687' title='goto source code'>[src]</a></h4><div class='docblock'><p>Bitwise "or" with the current value.</p>
<p>Performs a bitwise "or" operation on the current value and the argument <code>val</code>, and
sets the new value to the result.</p>
<p>Returns the previous value.</p>
<p><code>fetch_or</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering
of this operation. All ordering modes are possible. Note that using
<a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and
using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">0b101101</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">fetch_or</span>(<span class="number">0b110011</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">0b101101</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">0b111111</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(0b101101)%3B%0Aassert_eq!(foo.fetch_or(0b110011%2C%20Ordering%3A%3ASeqCst)%2C%200b101101)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ASeqCst)%2C%200b111111)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.fetch_xor' class="method"><code id='fetch_xor.v'>pub fn <a href='#method.fetch_xor' class='fnname'>fetch_xor</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1720-1722' title='goto source code'>[src]</a></h4><div class='docblock'><p>Bitwise "xor" with the current value.</p>
<p>Performs a bitwise "xor" operation on the current value and the argument <code>val</code>, and
sets the new value to the result.</p>
<p>Returns the previous value.</p>
<p><code>fetch_xor</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering
of this operation. All ordering modes are possible. Note that using
<a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and
using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-14" class="section-header"><a href="#examples-14">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">0b101101</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">fetch_xor</span>(<span class="number">0b110011</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">0b101101</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">0b011110</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(0b101101)%3B%0Aassert_eq!(foo.fetch_xor(0b110011%2C%20Ordering%3A%3ASeqCst)%2C%200b101101)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ASeqCst)%2C%200b011110)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.fetch_update' class="method"><code id='fetch_update.v'>pub fn <a href='#method.fetch_update' class='fnname'>fetch_update</a><F>(<br> &self, <br> f: F, <br> fetch_order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>, <br> set_order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a><br>) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><<a class="primitive" href="../../primitive.u16.html">u16</a>, <a class="primitive" href="../../primitive.u16.html">u16</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../std/ops/trait.FnMut.html" title="trait std::ops::FnMut">FnMut</a>(<a class="primitive" href="../../primitive.u16.html">u16</a>) -> <a class="enum" href="../../../std/option/enum.Option.html" title="enum std::option::Option">Option</a><<a class="primitive" href="../../primitive.u16.html">u16</a>>, </span></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1770-1783' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>no_more_cas</code> <a href="https://github.com/rust-lang/rust/issues/48655">#48655</a>)</summary><p>no more CAS loops in user code</p>
</details></div></div><div class='docblock'><p>Fetches the value, and applies a function to it that returns an optional
new value. Returns a <code>Result</code> of <code>Ok(previous_value)</code> if the function returned <code>Some(_)</code>, else
<code>Err(previous_value)</code>.</p>
<p>Note: This may call the function multiple times if the value has been changed from other threads in
the meantime, as long as the function returns <code>Some(_)</code>, but the function will have been applied
but once to the stored value.</p>
<p><code>fetch_update</code> takes two <a href="enum.Ordering.html"><code>Ordering</code></a> arguments to describe the memory
ordering of this operation. The first describes the required ordering for loads
and failed updates while the second describes the required ordering when the
operation finally succeeds. Beware that this is different from the two
modes in <a href="#method.compare_exchange"><code>compare_exchange</code></a>!</p>
<p>Using <a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> as success ordering makes the store part
of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the final successful load
<a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>. The (failed) load ordering can only be <a href="enum.Ordering.html#variant.SeqCst"><code>SeqCst</code></a>, <a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> or <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>
and must be equivalent to or weaker than the success ordering.</p>
<h1 id="examples-15" class="section-header"><a href="#examples-15">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">no_more_cas</span>)]</span>
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">7</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">fetch_update</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="prelude-val">None</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="prelude-val">Err</span>(<span class="number">7</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">fetch_update</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="prelude-val">Some</span>(<span class="ident">x</span> <span class="op">+</span> <span class="number">1</span>), <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="prelude-val">Ok</span>(<span class="number">7</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">fetch_update</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="prelude-val">Some</span>(<span class="ident">x</span> <span class="op">+</span> <span class="number">1</span>), <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="prelude-val">Ok</span>(<span class="number">8</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">9</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(no_more_cas)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20x%20%3D%20AtomicU16%3A%3Anew(7)%3B%0Aassert_eq!(x.fetch_update(%7C_%7C%20None%2C%20Ordering%3A%3ASeqCst%2C%20Ordering%3A%3ASeqCst)%2C%20Err(7))%3B%0Aassert_eq!(x.fetch_update(%7Cx%7C%20Some(x%20%2B%201)%2C%20Ordering%3A%3ASeqCst%2C%20Ordering%3A%3ASeqCst)%2C%20Ok(7))%3B%0Aassert_eq!(x.fetch_update(%7Cx%7C%20Some(x%20%2B%201)%2C%20Ordering%3A%3ASeqCst%2C%20Ordering%3A%3ASeqCst)%2C%20Ok(8))%3B%0Aassert_eq!(x.load(Ordering%3A%3ASeqCst)%2C%209)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.fetch_max' class="method"><code id='fetch_max.v'>pub fn <a href='#method.fetch_max' class='fnname'>fetch_max</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1831-1833' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>atomic_min_max</code> <a href="https://github.com/rust-lang/rust/issues/48655">#48655</a>)</summary><p>easier and faster min/max than writing manual CAS loop</p>
</details></div></div><div class='docblock'><p>Maximum with the current value.</p>
<p>Finds the maximum of the current value and the argument <code>val</code>, and
sets the new value to the result.</p>
<p>Returns the previous value.</p>
<p><code>fetch_max</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering
of this operation. All ordering modes are possible. Note that using
<a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and
using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-16" class="section-header"><a href="#examples-16">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">atomic_min_max</span>)]</span>
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">23</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">fetch_max</span>(<span class="number">42</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">23</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>), <span class="number">42</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(atomic_min_max)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(23)%3B%0Aassert_eq!(foo.fetch_max(42%2C%20Ordering%3A%3ASeqCst)%2C%2023)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ASeqCst)%2C%2042)%3B%0A%7D&version=nightly">Run</a></pre></div>
<p>If you want to obtain the maximum value in one step, you can use the following:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">atomic_min_max</span>)]</span>
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">23</span>);
<span class="kw">let</span> <span class="ident">bar</span> <span class="op">=</span> <span class="number">42</span>;
<span class="kw">let</span> <span class="ident">max_foo</span> <span class="op">=</span> <span class="ident">foo</span>.<span class="ident">fetch_max</span>(<span class="ident">bar</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>).<span class="ident">max</span>(<span class="ident">bar</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">max_foo</span> <span class="op">==</span> <span class="number">42</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(atomic_min_max)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(23)%3B%0Alet%20bar%20%3D%2042%3B%0Alet%20max_foo%20%3D%20foo.fetch_max(bar%2C%20Ordering%3A%3ASeqCst).max(bar)%3B%0Aassert!(max_foo%20%3D%3D%2042)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.fetch_min' class="method"><code id='fetch_min.v'>pub fn <a href='#method.fetch_min' class='fnname'>fetch_min</a>(&self, val: <a class="primitive" href="../../primitive.u16.html">u16</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>) -> <a class="primitive" href="../../primitive.u16.html">u16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1883-1885' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>atomic_min_max</code> <a href="https://github.com/rust-lang/rust/issues/48655">#48655</a>)</summary><p>easier and faster min/max than writing manual CAS loop</p>
</details></div></div><div class='docblock'><p>Minimum with the current value.</p>
<p>Finds the minimum of the current value and the argument <code>val</code>, and
sets the new value to the result.</p>
<p>Returns the previous value.</p>
<p><code>fetch_min</code> takes an <a href="enum.Ordering.html"><code>Ordering</code></a> argument which describes the memory ordering
of this operation. All ordering modes are possible. Note that using
<a href="enum.Ordering.html#variant.Acquire"><code>Acquire</code></a> makes the store part of this operation <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>, and
using <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> makes the load part <a href="enum.Ordering.html#variant.Relaxed"><code>Relaxed</code></a>.</p>
<h1 id="examples-17" class="section-header"><a href="#examples-17">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">atomic_min_max</span>)]</span>
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">23</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">fetch_min</span>(<span class="number">42</span>, <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">23</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">23</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">fetch_min</span>(<span class="number">22</span>, <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">23</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">foo</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">22</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(atomic_min_max)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(23)%3B%0Aassert_eq!(foo.fetch_min(42%2C%20Ordering%3A%3ARelaxed)%2C%2023)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ARelaxed)%2C%2023)%3B%0Aassert_eq!(foo.fetch_min(22%2C%20Ordering%3A%3ARelaxed)%2C%2023)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ARelaxed)%2C%2022)%3B%0A%7D&version=nightly">Run</a></pre></div>
<p>If you want to obtain the minimum value in one step, you can use the following:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">atomic_min_max</span>)]</span>
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">integer_atomics</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicU16</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicU16</span>::<span class="ident">new</span>(<span class="number">23</span>);
<span class="kw">let</span> <span class="ident">bar</span> <span class="op">=</span> <span class="number">12</span>;
<span class="kw">let</span> <span class="ident">min_foo</span> <span class="op">=</span> <span class="ident">foo</span>.<span class="ident">fetch_min</span>(<span class="ident">bar</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>).<span class="ident">min</span>(<span class="ident">bar</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">min_foo</span>, <span class="number">12</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(atomic_min_max)%5D%0A%23!%5Bfeature(integer_atomics)%5D%0A%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicU16%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicU16%3A%3Anew(23)%3B%0Alet%20bar%20%3D%2012%3B%0Alet%20min_foo%20%3D%20foo.fetch_min(bar%2C%20Ordering%3A%3ASeqCst).min(bar)%3B%0Aassert_eq!(min_foo%2C%2012)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Default' class='impl'><code class='in-band'>impl <a class="trait" href="../../../std/default/trait.Default.html" title="trait std::default::Default">Default</a> for <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a href='#impl-Default' class='anchor'></a><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1178-1182' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.default' class="method hidden"><code id='default.v'>fn <a href='../../../std/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1179-1181' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the "default value" for a type. <a href="../../../std/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="../../../std/fmt/trait.Debug.html" title="trait std::fmt::Debug">Debug</a> for <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1195-1199' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='../../../std/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="../../../std/fmt/struct.Formatter.html" title="struct std::fmt::Formatter">Formatter</a>) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><<a class="primitive" href="../../primitive.unit.html">()</a>, <a class="struct" href="../../../std/fmt/struct.Error.html" title="struct std::fmt::Error">Error</a>></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1196-1198' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="../../../std/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="../../../std/marker/trait.Sync.html" title="trait std::marker::Sync">Sync</a> for <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a href='#impl-Sync' class='anchor'></a><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1203' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-From%3Cu16%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../../../std/convert/trait.From.html" title="trait std::convert::From">From</a><<a class="primitive" href="../../primitive.u16.html">u16</a>> for <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a href='#impl-From%3Cu16%3E' class='anchor'></a><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1185-1192' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method"><code id='from.v'>fn <a href='../../../std/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(v: <a class="primitive" href="../../primitive.u16.html">u16</a>) -> <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a class='srclink' href='../../../src/core/sync/atomic.rs.html#1190' title='goto source code'>[src]</a></h4><div class='docblock'><p>Converts an <code>u16</code> into an <code>AtomicU16</code>.</p>
</div></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="../../../std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a><a class='srclink' href='../../../src/std/panic.rs.html#269' title='goto source code'>[src]</a></h3><div class='impl-items'></div></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'><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="../../../std/marker/trait.Send.html" title="trait std::marker::Send">Send</a> for <a class="struct" href="../../../std/sync/atomic/struct.AtomicU16.html" title="struct std::sync::atomic::AtomicU16">AtomicU16</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></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'><h3 id='impl-TryFrom' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="../../../std/convert/trait.Into.html" title="trait std::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom' class='anchor'></a><a class='srclink' href='../../../src/core/convert.rs.html#565-571' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='../../../std/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../../../std/convert/enum.Infallible.html" title="enum std::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='../../../std/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><T, <T as <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="../../../std/convert/trait.TryFrom.html#associatedtype.Error" title="type std::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='../../../src/core/convert.rs.html#568-570' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-From' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/convert/trait.From.html" title="trait std::convert::From">From</a> for T</code><a href='#impl-From' class='anchor'></a><a class='srclink' href='../../../src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from-1' class="method hidden"><code id='from.v-1'>fn <a href='../../../std/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='../../../src/core/convert.rs.html#547' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryInto' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="../../../std/convert/trait.TryInto.html" title="trait std::convert::TryInto">TryInto</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto' class='anchor'></a><a class='srclink' href='../../../src/core/convert.rs.html#553-560' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='../../../std/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="../../../std/convert/trait.TryFrom.html#associatedtype.Error" title="type std::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='../../../std/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><U, <U as <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="../../../std/convert/trait.TryFrom.html#associatedtype.Error" title="type std::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='../../../src/core/convert.rs.html#557-559' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Into' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="../../../std/convert/trait.Into.html" title="trait std::convert::Into">Into</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="../../../std/convert/trait.From.html" title="trait std::convert::From">From</a><T>, </span></code><a href='#impl-Into' class='anchor'></a><a class='srclink' href='../../../src/core/convert.rs.html#537-542' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='../../../std/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='../../../src/core/convert.rs.html#539-541' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Borrow' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/borrow/trait.Borrow.html" title="trait std::borrow::Borrow">Borrow</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow' class='anchor'></a><a class='srclink' href='../../../src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F</h3><code class="content"><span class="where fmt-newline">impl<'_, F> <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../std/marker/trait.Unpin.html" title="trait std::marker::Unpin">Unpin</a> + <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='../../../std/future/trait.Future.html#associatedtype.Output' class="type">Output</a> = <F as <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a>>::<a class="type" href="../../../std/future/trait.Future.html#associatedtype.Output" title="type std::future::Future::Output">Output</a>;</span><span class="where fmt-newline">impl<'_, I> <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='../../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a>>::<a class="type" href="../../../std/iter/trait.Iterator.html#associatedtype.Item" title="type std::iter::Iterator::Item">Item</a>;</span><span class="where fmt-newline">impl<R: <a class="trait" href="../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, '_> <a class="trait" href="../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>R</span><span class="where fmt-newline">impl<W: <a class="trait" href="../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, '_> <a class="trait" href="../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>W</span></code></div></div><code id='borrow.v'>fn <a href='../../../std/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="../../primitive.reference.html">&</a>T</code><a class='srclink' href='../../../src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="../../../std/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-BorrowMut' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/borrow/trait.BorrowMut.html" title="trait std::borrow::BorrowMut">BorrowMut</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut' class='anchor'></a><a class='srclink' href='../../../src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F</h3><code class="content"><span class="where fmt-newline">impl<'_, F> <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../std/marker/trait.Unpin.html" title="trait std::marker::Unpin">Unpin</a> + <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='../../../std/future/trait.Future.html#associatedtype.Output' class="type">Output</a> = <F as <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a>>::<a class="type" href="../../../std/future/trait.Future.html#associatedtype.Output" title="type std::future::Future::Output">Output</a>;</span><span class="where fmt-newline">impl<'_, I> <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='../../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a>>::<a class="type" href="../../../std/iter/trait.Iterator.html#associatedtype.Item" title="type std::iter::Iterator::Item">Item</a>;</span><span class="where fmt-newline">impl<R: <a class="trait" href="../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, '_> <a class="trait" href="../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>R</span><span class="where fmt-newline">impl<W: <a class="trait" href="../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, '_> <a class="trait" href="../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>W</span></code></div></div><code id='borrow_mut.v'>fn <a href='../../../std/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="../../primitive.reference.html">&mut </a>T</code><a class='srclink' href='../../../src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="../../../std/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/any/trait.Any.html" title="trait std::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='../../../src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='../../../std/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="../../../std/any/struct.TypeId.html" title="struct std::any::TypeId">TypeId</a></code><a class='srclink' href='../../../src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="../../../std/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></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>⏎</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 = "std";</script><script src="../../../aliases.js"></script><script src="../../../main1.35.0.js"></script><script defer src="../../../search-index.js"></script></body></html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0c2243f8a1696816431e7210e991fa52
>
files
>
16830
