<!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 `AtomicI32` struct in crate `std`.">
<meta name="keywords" content="rust, rustlang, rust-lang, AtomicI32">
<title>std::sync::atomic::AtomicI32 - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</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">
<a href='../../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Struct AtomicI32</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></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: 'AtomicI32', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>std</a>::<wbr><a href='../index.html'>sync</a>::<wbr><a href='index.html'>atomic</a>::<wbr><a class="struct" href=''>AtomicI32</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version '></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#932-934' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct AtomicI32 { /* fields omitted */ }</pre><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></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.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../../std/sync/atomic/struct.AtomicI32.html" title="struct std::sync::atomic::AtomicI32">AtomicI32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/core/sync/atomic.rs.html#960-1328' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>const fn <a href='#method.new' class='fnname'>new</a>(v: <a class="primitive" href="../../primitive.i32.html">i32</a>) -> <a class="struct" href="../../../std/sync/atomic/struct.AtomicI32.html" title="struct std::sync::atomic::AtomicI32">AtomicI32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><div class='docblock'><p>Creates a new atomic integer.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">AtomicIsize</span>;
<span class="kw">let</span> <span class="ident">atomic_forty_two</span> <span class="op">=</span> <span class="ident">AtomicIsize</span>::<span class="ident">new</span>(<span class="number">42</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3AAtomicIsize%3B%0A%0Alet%20atomic_forty_two%20%20%3D%20AtomicIsize%3A%3Anew(42)%3B%0A%7D">Run</a></pre>
</div><h4 id='method.get_mut' class="method"><span id='get_mut.v' class='invisible'><code>fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&mut self) -> &mut <a class="primitive" href="../../primitive.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">some_isize</span> <span class="op">=</span> <span class="ident">AtomicIsize</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_isize</span>.<span class="ident">get_mut</span>(), <span class="number">10</span>);
<span class="kw-2">*</span><span class="ident">some_isize</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_isize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20mut%20some_isize%20%3D%20AtomicIsize%3A%3Anew(10)%3B%0Aassert_eq!(*some_isize.get_mut()%2C%2010)%3B%0A*some_isize.get_mut()%20%3D%205%3B%0Aassert_eq!(some_isize.load(Ordering%3A%3ASeqCst)%2C%205)%3B%0A%7D">Run</a></pre>
</div><h4 id='method.into_inner' class="method"><span id='into_inner.v' class='invisible'><code>fn <a href='#method.into_inner' class='fnname'>into_inner</a>(self) -> <a class="primitive" href="../../primitive.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">AtomicIsize</span>;
<span class="kw">let</span> <span class="ident">some_isize</span> <span class="op">=</span> <span class="ident">AtomicIsize</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_isize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3AAtomicIsize%3B%0A%0Alet%20some_isize%20%3D%20AtomicIsize%3A%3Anew(5)%3B%0Aassert_eq!(some_isize.into_inner()%2C%205)%3B%0A%7D">Run</a></pre>
</div><h4 id='method.load' class="method"><span id='load.v' class='invisible'><code>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.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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.</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>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_isize</span> <span class="op">=</span> <span class="ident">AtomicIsize</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_isize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20some_isize%20%3D%20AtomicIsize%3A%3Anew(5)%3B%0A%0Aassert_eq!(some_isize.load(Ordering%3A%3ARelaxed)%2C%205)%3B%0A%7D">Run</a></pre>
</div><h4 id='method.store' class="method"><span id='store.v' class='invisible'><code>fn <a href='#method.store' class='fnname'>store</a>(&self, val: <a class="primitive" href="../../primitive.i32.html">i32</a>, order: <a class="enum" href="../../../std/sync/atomic/enum.Ordering.html" title="enum std::sync::atomic::Ordering">Ordering</a>)</code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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.</p>
<h1 id='examples-4' class='section-header'><a href='#examples-4'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_isize</span> <span class="op">=</span> <span class="ident">AtomicIsize</span>::<span class="ident">new</span>(<span class="number">5</span>);
<span class="ident">some_isize</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_isize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20some_isize%20%3D%20AtomicIsize%3A%3Anew(5)%3B%0A%0Asome_isize.store(10%2C%20Ordering%3A%3ARelaxed)%3B%0Aassert_eq!(some_isize.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%7D">Run</a></pre>
<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>
</div><h4 id='method.swap' class="method"><span id='swap.v' class='invisible'><code>fn <a href='#method.swap' class='fnname'>swap</a>(&self, val: <a class="primitive" href="../../primitive.i32.html">i32</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.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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.</p>
<h1 id='examples-5' class='section-header'><a href='#examples-5'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_isize</span> <span class="op">=</span> <span class="ident">AtomicIsize</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_isize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20some_isize%20%3D%20AtomicIsize%3A%3Anew(5)%3B%0A%0Aassert_eq!(some_isize.swap(10%2C%20Ordering%3A%3ARelaxed)%2C%205)%3B%0A%7D">Run</a></pre>
</div><h4 id='method.compare_and_swap' class="method"><span id='compare_and_swap.v' class='invisible'><code>fn <a href='#method.compare_and_swap' class='fnname'>compare_and_swap</a>(&self, current: <a class="primitive" href="../../primitive.i32.html">i32</a>, new: <a class="primitive" href="../../primitive.i32.html">i32</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.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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.</p>
<h1 id='examples-6' class='section-header'><a href='#examples-6'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_isize</span> <span class="op">=</span> <span class="ident">AtomicIsize</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_isize</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_isize</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_isize</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_isize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20some_isize%20%3D%20AtomicIsize%3A%3Anew(5)%3B%0A%0Aassert_eq!(some_isize.compare_and_swap(5%2C%2010%2C%20Ordering%3A%3ARelaxed)%2C%205)%3B%0Aassert_eq!(some_isize.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%0Aassert_eq!(some_isize.compare_and_swap(6%2C%2012%2C%20Ordering%3A%3ARelaxed)%2C%2010)%3B%0Aassert_eq!(some_isize.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%7D">Run</a></pre>
</div><h4 id='method.compare_exchange' class="method"><span id='compare_exchange.v' class='invisible'><code>fn <a href='#method.compare_exchange' class='fnname'>compare_exchange</a>(<br> &self, <br> current: <a class="primitive" href="../../primitive.i32.html">i32</a>, <br> new: <a class="primitive" href="../../primitive.i32.html">i32</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.i32.html">i32</a>, <a class="primitive" href="../../primitive.i32.html">i32</a>></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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. The failure ordering can't be <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> or <a href="enum.Ordering.html#variant.AcqRel"><code>AcqRel</code></a> and
must be equivalent or weaker than the success ordering.</p>
<h1 id='examples-7' class='section-header'><a href='#examples-7'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">some_isize</span> <span class="op">=</span> <span class="ident">AtomicIsize</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_isize</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_isize</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_isize</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_isize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20some_isize%20%3D%20AtomicIsize%3A%3Anew(5)%3B%0A%0Aassert_eq!(some_isize.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%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%20%20%20Ordering%3A%3ARelaxed)%2C%0A%20%20%20%20%20%20%20%20%20%20%20Ok(5))%3B%0Aassert_eq!(some_isize.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%0Aassert_eq!(some_isize.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%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%20%20%20Ordering%3A%3AAcquire)%2C%0A%20%20%20%20%20%20%20%20%20%20%20Err(10))%3B%0Aassert_eq!(some_isize.load(Ordering%3A%3ARelaxed)%2C%2010)%3B%0A%7D">Run</a></pre>
</div><h4 id='method.compare_exchange_weak' class="method"><span id='compare_exchange_weak.v' class='invisible'><code>fn <a href='#method.compare_exchange_weak' class='fnname'>compare_exchange_weak</a>(<br> &self, <br> current: <a class="primitive" href="../../primitive.i32.html">i32</a>, <br> new: <a class="primitive" href="../../primitive.i32.html">i32</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.i32.html">i32</a>, <a class="primitive" href="../../primitive.i32.html">i32</a>></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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. The failure ordering can't be <a href="enum.Ordering.html#variant.Release"><code>Release</code></a> or <a href="enum.Ordering.html#variant.AcqRel"><code>AcqRel</code></a> and
must be equivalent or weaker than the success ordering.</p>
<h1 id='examples-8' class='section-header'><a href='#examples-8'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">val</span> <span class="op">=</span> <span class="ident">AtomicIsize</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="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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20val%20%3D%20AtomicIsize%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">Run</a></pre>
</div><h4 id='method.fetch_add' class="method"><span id='fetch_add.v' class='invisible'><code>fn <a href='#method.fetch_add' class='fnname'>fetch_add</a>(&self, val: <a class="primitive" href="../../primitive.i32.html">i32</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.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><div class='docblock'><p>Adds to the current value, returning the previous value.</p>
<p>This operation wraps around on overflow.</p>
<h1 id='examples-9' class='section-header'><a href='#examples-9'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicIsize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicIsize%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">Run</a></pre>
</div><h4 id='method.fetch_sub' class="method"><span id='fetch_sub.v' class='invisible'><code>fn <a href='#method.fetch_sub' class='fnname'>fetch_sub</a>(&self, val: <a class="primitive" href="../../primitive.i32.html">i32</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.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><div class='docblock'><p>Subtracts from the current value, returning the previous value.</p>
<p>This operation wraps around on overflow.</p>
<h1 id='examples-10' class='section-header'><a href='#examples-10'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicIsize</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_sub</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="op">-</span><span class="number">10</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicIsize%3A%3Anew(0)%3B%0Aassert_eq!(foo.fetch_sub(10%2C%20Ordering%3A%3ASeqCst)%2C%200)%3B%0Aassert_eq!(foo.load(Ordering%3A%3ASeqCst)%2C%20-10)%3B%0A%7D">Run</a></pre>
</div><h4 id='method.fetch_and' class="method"><span id='fetch_and.v' class='invisible'><code>fn <a href='#method.fetch_and' class='fnname'>fetch_and</a>(&self, val: <a class="primitive" href="../../primitive.i32.html">i32</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.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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>
<h1 id='examples-11' class='section-header'><a href='#examples-11'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicIsize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicIsize%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">Run</a></pre>
</div><h4 id='method.fetch_or' class="method"><span id='fetch_or.v' class='invisible'><code>fn <a href='#method.fetch_or' class='fnname'>fetch_or</a>(&self, val: <a class="primitive" href="../../primitive.i32.html">i32</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.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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>
<h1 id='examples-12' class='section-header'><a href='#examples-12'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicIsize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicIsize%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">Run</a></pre>
</div><h4 id='method.fetch_xor' class="method"><span id='fetch_xor.v' class='invisible'><code>fn <a href='#method.fetch_xor' class='fnname'>fetch_xor</a>(&self, val: <a class="primitive" href="../../primitive.i32.html">i32</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.i32.html">i32</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>integer_atomics </code><a href="https://github.com/rust-lang/rust/issues/32976">#32976</a>)</div></div><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>
<h1 id='examples-13' class='section-header'><a href='#examples-13'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicIsize</span>, <span class="ident">Ordering</span>};
<span class="kw">let</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">AtomicIsize</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=fn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Aatomic%3A%3A%7BAtomicIsize%2C%20Ordering%7D%3B%0A%0Alet%20foo%20%3D%20AtomicIsize%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">Run</a></pre>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>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.AtomicI32.html" title="struct std::sync::atomic::AtomicI32">AtomicI32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/core/sync/atomic.rs.html#958' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>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.AtomicI32.html" title="struct std::sync::atomic::AtomicI32">AtomicI32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/core/sync/atomic.rs.html#941-945' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='../../../std/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../../../std/sync/atomic/struct.AtomicI32.html" title="struct std::sync::atomic::AtomicI32">AtomicI32</a></code></span></h4>
<div class='docblock'><p>Returns the "default value" for a type. <a href="../../../std/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>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.AtomicI32.html" title="struct std::sync::atomic::AtomicI32">AtomicI32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/core/sync/atomic.rs.html#948-954' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='../../../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.tuple.html">()</a>, <a class="struct" href="../../../std/fmt/struct.Error.html" title="struct std::fmt::Error">Error</a>></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>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.AtomicI32.html" title="struct std::sync::atomic::AtomicI32">AtomicI32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/std/panic.rs.html#246' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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 = "std";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
564935689ab5527f955e5449ded02799
>
files
>
5089
