blob: bb4ae48e0dfa14f2ef5b0fc10992b5248e702217 [file] [log] [blame]
<!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="Pads and aligns a value to the length of a cache line."><meta name="keywords" content="rust, rustlang, rust-lang, CachePadded"><title>CachePadded in crossbeam_utils - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../crossbeam_utils/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../crossbeam_utils/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">CachePadded</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-CachePadded%3CT%3E">Clone</a></li><li><a href="#impl-Copy-for-CachePadded%3CT%3E">Copy</a></li><li><a href="#impl-Debug-for-CachePadded%3CT%3E">Debug</a></li><li><a href="#impl-Default-for-CachePadded%3CT%3E">Default</a></li><li><a href="#impl-Deref-for-CachePadded%3CT%3E">Deref</a></li><li><a href="#impl-DerefMut-for-CachePadded%3CT%3E">DerefMut</a></li><li><a href="#impl-Eq-for-CachePadded%3CT%3E">Eq</a></li><li><a href="#impl-From%3CT%3E-for-CachePadded%3CT%3E">From&lt;T&gt;</a></li><li><a href="#impl-Hash-for-CachePadded%3CT%3E">Hash</a></li><li><a href="#impl-PartialEq%3CCachePadded%3CT%3E%3E-for-CachePadded%3CT%3E">PartialEq&lt;CachePadded&lt;T&gt;&gt;</a></li><li><a href="#impl-Send-for-CachePadded%3CT%3E">Send</a></li><li><a href="#impl-StructuralEq-for-CachePadded%3CT%3E">StructuralEq</a></li><li><a href="#impl-StructuralPartialEq-for-CachePadded%3CT%3E">StructuralPartialEq</a></li><li><a href="#impl-Sync-for-CachePadded%3CT%3E">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-CachePadded%3CT%3E">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-CachePadded%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-CachePadded%3CT%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-CachePadded%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-CachePadded%3CT%3E">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-CachePadded%3CT%3E">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3C!%3E-for-CachePadded%3CT%3E">From&lt;!&gt;</a></li><li><a href="#impl-From%3CT%3E-for-CachePadded%3CT%3E-1">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-CachePadded%3CT%3E">Into&lt;U&gt;</a></li><li><a href="#impl-ToOwned-for-CachePadded%3CT%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-CachePadded%3CT%3E">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-CachePadded%3CT%3E">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In crossbeam_utils</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="index.html">crossbeam_utils</a>::<wbr><a class="struct" href="#">CachePadded</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/crossbeam_utils/cache_padded.rs.html#128-130">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code><div class="code-attribute">#[repr(align(128))]</div>pub struct CachePadded&lt;T&gt; { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Pads and aligns a value to the length of a cache line.</p>
<p>In concurrent programming, sometimes it is desirable to make sure commonly accessed pieces of
data are not placed into the same cache line. Updating an atomic value invalidates the whole
cache line it belongs to, which makes the next access to the same cache line slower for other
CPU cores. Use <code>CachePadded</code> to ensure updating one piece of data doesn’t invalidate other
cached data.</p>
<h2 id="size-and-alignment"><a href="#size-and-alignment">Size and alignment</a></h2>
<p>Cache lines are assumed to be N bytes long, depending on the architecture:</p>
<ul>
<li>On x86-64, aarch64, and powerpc64, N = 128.</li>
<li>On arm, mips, mips64, and riscv64, N = 32.</li>
<li>On s390x, N = 256.</li>
<li>On all others, N = 64.</li>
</ul>
<p>Note that N is just a reasonable guess and is not guaranteed to match the actual cache line
length of the machine the program is running on. On modern Intel architectures, spatial
prefetcher is pulling pairs of 64-byte cache lines at a time, so we pessimistically assume that
cache lines are 128 bytes long.</p>
<p>The size of <code>CachePadded&lt;T&gt;</code> is the smallest multiple of N bytes large enough to accommodate
a value of type <code>T</code>.</p>
<p>The alignment of <code>CachePadded&lt;T&gt;</code> is the maximum of N bytes and the alignment of <code>T</code>.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<p>Alignment and padding:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::CachePadded;
<span class="kw">let </span>array = [CachePadded::new(<span class="number">1i8</span>), CachePadded::new(<span class="number">2i8</span>)];
<span class="kw">let </span>addr1 = <span class="kw-2">&amp;*</span>array[<span class="number">0</span>] <span class="kw">as </span><span class="kw-2">*const </span>i8 <span class="kw">as </span>usize;
<span class="kw">let </span>addr2 = <span class="kw-2">&amp;*</span>array[<span class="number">1</span>] <span class="kw">as </span><span class="kw-2">*const </span>i8 <span class="kw">as </span>usize;
<span class="macro">assert!</span>(addr2 - addr1 &gt;= <span class="number">32</span>);
<span class="macro">assert_eq!</span>(addr1 % <span class="number">32</span>, <span class="number">0</span>);
<span class="macro">assert_eq!</span>(addr2 % <span class="number">32</span>, <span class="number">0</span>);</code></pre></div>
<p>When building a concurrent queue with a head and a tail index, it is wise to place them in
different cache lines so that concurrent threads pushing and popping elements don’t invalidate
each other’s cache lines:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::CachePadded;
<span class="kw">use </span>std::sync::atomic::AtomicUsize;
<span class="kw">struct </span>Queue&lt;T&gt; {
head: CachePadded&lt;AtomicUsize&gt;,
tail: CachePadded&lt;AtomicUsize&gt;,
buffer: <span class="kw-2">*mut </span>T,
}</code></pre></div>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#135-163">source</a><a href="#impl-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#145-147">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fnname">new</a>(t: T) -&gt; <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h4></section></summary><div class="docblock"><p>Pads and aligns a value to the length of a cache line.</p>
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::CachePadded;
<span class="kw">let </span>padded_value = CachePadded::new(<span class="number">1</span>);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_inner" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#160-162">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the inner value.</p>
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_utils::CachePadded;
<span class="kw">let </span>padded_value = CachePadded::new(<span class="number">7</span>);
<span class="kw">let </span>value = padded_value.into_inner();
<span class="macro">assert_eq!</span>(value, <span class="number">7</span>);</code></pre></div>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#impl-Clone-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Clone&gt; Clone for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#179-185">source</a><a href="#impl-Debug-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Debug&gt; Debug for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#180-184">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#impl-Default-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Default&gt; Default for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a class="fnname">default</a>() -&gt; <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Deref-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#165-171">source</a><a href="#impl-Deref-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Deref for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Target" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Target</a> = T</h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#168-170">source</a><a href="#method.deref" class="anchor"></a><h4 class="code-header">fn <a class="fnname">deref</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Dereferences the value.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-DerefMut-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#173-177">source</a><a href="#impl-DerefMut-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; DerefMut for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#174-176">source</a><a href="#method.deref_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">deref_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably dereferences the value.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CT%3E-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#187-191">source</a><a href="#impl-From%3CT%3E-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#188-190">source</a><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Hash-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#impl-Hash-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Hash&gt; Hash for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#method.hash" class="anchor"></a><h4 class="code-header">fn <a class="fnname">hash</a>&lt;__H:&nbsp;Hasher&gt;(&amp;self, state: &amp;mut __H)</h4></section></summary><div class='docblock'>Feeds this value into the given [<code>Hasher</code>]. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash_slice" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.3.0">1.3.0</span><a href="#method.hash_slice" class="anchor"></a><h4 class="code-header">fn <a class="fnname">hash_slice</a>&lt;H&gt;(data: &amp;[Self], state: &amp;mut H)<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;H: Hasher,</span></h4></section></summary><div class='docblock'>Feeds a slice of this type into the given [<code>Hasher</code>]. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CCachePadded%3CT%3E%3E-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#impl-PartialEq%3CCachePadded%3CT%3E%3E-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;PartialEq&gt; PartialEq&lt;<a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;&gt; for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a class="fnname">eq</a>(&amp;self, other: &amp;<a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;) -&gt; bool</h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.ne" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ne</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
sufficient, and should not be overridden without very good reason. <a>Read more</a></div></details></div></details><section id="impl-Copy-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#impl-Copy-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Copy&gt; Copy for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section><section id="impl-Eq-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#impl-Eq-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Eq&gt; Eq for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section><section id="impl-Send-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#132">source</a><a href="#impl-Send-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Send&gt; Send for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section><section id="impl-StructuralEq-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#impl-StructuralEq-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; StructuralEq for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section><section id="impl-StructuralPartialEq-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#61">source</a><a href="#impl-StructuralPartialEq-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; StructuralPartialEq for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section><section id="impl-Sync-for-CachePadded%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_utils/cache_padded.rs.html#133">source</a><a href="#impl-Sync-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Sync&gt; Sync for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;</h3></section></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"><section id="impl-RefUnwindSafe-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; RefUnwindSafe for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: RefUnwindSafe,</span></h3></section><section id="impl-Unpin-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Unpin for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; UnwindSafe for <a class="struct" href="struct.CachePadded.html" title="struct crossbeam_utils::CachePadded">CachePadded</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3C!%3E-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-From%3C!%3E-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;!&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from-2" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: !) -&gt; T</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-CachePadded%3CT%3E-1" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-CachePadded%3CT%3E-1" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; ToOwned for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&amp;self, target: &amp;mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-CachePadded%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-CachePadded%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="crossbeam_utils" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>