| <!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="A pointer to an object protected by the epoch GC."><meta name="keywords" content="rust, rustlang, rust-lang, Shared"><title>Shared in crossbeam_epoch - 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">☰</button><a class="sidebar-logo" href="../crossbeam_epoch/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_epoch/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Shared</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.as_raw">as_raw</a></li><li><a href="#method.as_ref">as_ref</a></li><li><a href="#method.deref">deref</a></li><li><a href="#method.deref_mut">deref_mut</a></li><li><a href="#method.into_owned">into_owned</a></li><li><a href="#method.is_null">is_null</a></li><li><a href="#method.null">null</a></li><li><a href="#method.tag">tag</a></li><li><a href="#method.try_into_owned">try_into_owned</a></li><li><a href="#method.with_tag">with_tag</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Shared%3C%27_%2C%20T%3E">Clone</a></li><li><a href="#impl-Copy-for-Shared%3C%27_%2C%20T%3E">Copy</a></li><li><a href="#impl-Debug-for-Shared%3C%27_%2C%20T%3E">Debug</a></li><li><a href="#impl-Default-for-Shared%3C%27_%2C%20T%3E">Default</a></li><li><a href="#impl-Eq-for-Shared%3C%27_%2C%20T%3E">Eq</a></li><li><a href="#impl-From%3C*const%20T%3E-for-Shared%3C%27_%2C%20T%3E">From<*const T></a></li><li><a href="#impl-From%3CShared%3C%27g%2C%20T%3E%3E-for-Atomic%3CT%3E">From<Shared<'g, T>></a></li><li><a href="#impl-Ord-for-Shared%3C%27_%2C%20T%3E">Ord</a></li><li><a href="#impl-PartialEq%3CShared%3C%27g%2C%20T%3E%3E-for-Shared%3C%27g%2C%20T%3E">PartialEq<Shared<'g, T>></a></li><li><a href="#impl-PartialOrd%3CShared%3C%27g%2C%20T%3E%3E-for-Shared%3C%27g%2C%20T%3E">PartialOrd<Shared<'g, T>></a></li><li><a href="#impl-Pointer%3CT%3E-for-Shared%3C%27_%2C%20T%3E">Pointer<T></a></li><li><a href="#impl-Pointer-for-Shared%3C%27_%2C%20T%3E">Pointer</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Shared%3C%27g%2C%20T%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Shared%3C%27g%2C%20T%3E">!Send</a></li><li><a href="#impl-Sync-for-Shared%3C%27g%2C%20T%3E">!Sync</a></li><li><a href="#impl-Unpin-for-Shared%3C%27g%2C%20T%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Shared%3C%27g%2C%20T%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Shared%3C%27g%2C%20T%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Shared%3C%27g%2C%20T%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Shared%3C%27g%2C%20T%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Shared%3C%27g%2C%20T%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Shared%3C%27g%2C%20T%3E">Into<U></a></li><li><a href="#impl-ToOwned-for-Shared%3C%27g%2C%20T%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Shared%3C%27g%2C%20T%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Shared%3C%27g%2C%20T%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In crossbeam_epoch</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_epoch</a>::<wbr><a class="struct" href="#">Shared</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_epoch/atomic.rs.html#1309-1312">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Shared<'g, T: 'g + ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A pointer to an object protected by the epoch GC.</p> |
| <p>The pointer is valid for use only during the lifetime <code>'g</code>.</p> |
| <p>The pointer must be properly aligned. Since it is aligned, a tag can be stored into the unused |
| least significant bits of the address.</p> |
| </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-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1340-1362">source</a><a href="#impl-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<'g, T> <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_raw" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1358-1361">source</a><h4 class="code-header">pub fn <a href="#method.as_raw" class="fnname">as_raw</a>(&self) -> *const T</h4></section></summary><div class="docblock"><p>Converts the pointer to a raw pointer (without the tag).</p> |
| <h5 id="examples"><a href="#examples">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::{<span class="self">self </span><span class="kw">as </span>epoch, Atomic, Owned}; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| |
| <span class="kw">let </span>o = Owned::new(<span class="number">1234</span>); |
| <span class="kw">let </span>raw = <span class="kw-2">&*</span>o <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>; |
| <span class="kw">let </span>a = Atomic::from(o); |
| |
| <span class="kw">let </span>guard = <span class="kw-2">&</span>epoch::pin(); |
| <span class="kw">let </span>p = a.load(SeqCst, guard); |
| <span class="macro">assert_eq!</span>(p.as_raw(), raw);</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Shared%3C%27g%2C%20T%3E-1" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1364-1622">source</a><a href="#impl-Shared%3C%27g%2C%20T%3E-1" class="anchor"></a><h3 class="code-header">impl<'g, T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.null" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1375-1380">source</a><h4 class="code-header">pub fn <a href="#method.null" class="fnname">null</a>() -> <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></h4></section></summary><div class="docblock"><p>Returns a new null pointer.</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_epoch::Shared; |
| |
| <span class="kw">let </span>p = Shared::<i32>::null(); |
| <span class="macro">assert!</span>(p.is_null());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_null" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1397-1400">source</a><h4 class="code-header">pub fn <a href="#method.is_null" class="fnname">is_null</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the pointer is null.</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_epoch::{<span class="self">self </span><span class="kw">as </span>epoch, Atomic, Owned}; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| |
| <span class="kw">let </span>a = Atomic::null(); |
| <span class="kw">let </span>guard = <span class="kw-2">&</span>epoch::pin(); |
| <span class="macro">assert!</span>(a.load(SeqCst, guard).is_null()); |
| a.store(Owned::new(<span class="number">1234</span>), SeqCst); |
| <span class="macro">assert!</span>(!a.load(SeqCst, guard).is_null());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1434-1437">source</a><h4 class="code-header">pub unsafe fn <a href="#method.deref" class="fnname">deref</a>(&self) -> &'g T</h4></section></summary><div class="docblock"><p>Dereferences the pointer.</p> |
| <p>Returns a reference to the pointee that is valid during the lifetime <code>'g</code>.</p> |
| <h5 id="safety"><a href="#safety">Safety</a></h5> |
| <p>Dereferencing a pointer is unsafe because it could be pointing to invalid memory.</p> |
| <p>Another concern is the possibility of data races due to lack of proper synchronization. |
| For example, consider the following scenario:</p> |
| <ol> |
| <li>A thread creates a new object: <code>a.store(Owned::new(10), Relaxed)</code></li> |
| <li>Another thread reads it: <code>*a.load(Relaxed, guard).as_ref().unwrap()</code></li> |
| </ol> |
| <p>The problem is that relaxed orderings don’t synchronize initialization of the object with |
| the read from the second thread. This is a data race. A possible solution would be to use |
| <code>Release</code> and <code>Acquire</code> orderings.</p> |
| <h5 id="examples-3"><a href="#examples-3">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::{<span class="self">self </span><span class="kw">as </span>epoch, Atomic}; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| |
| <span class="kw">let </span>a = Atomic::new(<span class="number">1234</span>); |
| <span class="kw">let </span>guard = <span class="kw-2">&</span>epoch::pin(); |
| <span class="kw">let </span>p = a.load(SeqCst, guard); |
| <span class="kw">unsafe </span>{ |
| <span class="macro">assert_eq!</span>(p.deref(), <span class="kw-2">&</span><span class="number">1234</span>); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref_mut" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1476-1479">source</a><h4 class="code-header">pub unsafe fn <a href="#method.deref_mut" class="fnname">deref_mut</a>(&mut self) -> &'g mut T</h4></section></summary><div class="docblock"><p>Dereferences the pointer.</p> |
| <p>Returns a mutable reference to the pointee that is valid during the lifetime <code>'g</code>.</p> |
| <h5 id="safety-1"><a href="#safety-1">Safety</a></h5> |
| <ul> |
| <li> |
| <p>There is no guarantee that there are no more threads attempting to read/write from/to the |
| actual object at the same time.</p> |
| <p>The user must know that there are no concurrent accesses towards the object itself.</p> |
| </li> |
| <li> |
| <p>Other than the above, all safety concerns of <code>deref()</code> applies here.</p> |
| </li> |
| </ul> |
| <h5 id="examples-4"><a href="#examples-4">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::{<span class="self">self </span><span class="kw">as </span>epoch, Atomic}; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| |
| <span class="kw">let </span>a = Atomic::new(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]); |
| <span class="kw">let </span>guard = <span class="kw-2">&</span>epoch::pin(); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>p = a.load(SeqCst, guard); |
| <span class="kw">unsafe </span>{ |
| <span class="macro">assert!</span>(!p.is_null()); |
| <span class="kw">let </span>b = p.deref_mut(); |
| <span class="macro">assert_eq!</span>(b, <span class="kw-2">&</span><span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]); |
| b.push(<span class="number">5</span>); |
| <span class="macro">assert_eq!</span>(b, <span class="kw-2">&</span><span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]); |
| } |
| |
| <span class="kw">let </span>p = a.load(SeqCst, guard); |
| <span class="kw">unsafe </span>{ |
| <span class="macro">assert_eq!</span>(p.deref(), <span class="kw-2">&</span><span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_ref" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1513-1520">source</a><h4 class="code-header">pub unsafe fn <a href="#method.as_ref" class="fnname">as_ref</a>(&self) -> Option<&'g T></h4></section></summary><div class="docblock"><p>Converts the pointer to a reference.</p> |
| <p>Returns <code>None</code> if the pointer is null, or else a reference to the object wrapped in <code>Some</code>.</p> |
| <h5 id="safety-2"><a href="#safety-2">Safety</a></h5> |
| <p>Dereferencing a pointer is unsafe because it could be pointing to invalid memory.</p> |
| <p>Another concern is the possibility of data races due to lack of proper synchronization. |
| For example, consider the following scenario:</p> |
| <ol> |
| <li>A thread creates a new object: <code>a.store(Owned::new(10), Relaxed)</code></li> |
| <li>Another thread reads it: <code>*a.load(Relaxed, guard).as_ref().unwrap()</code></li> |
| </ol> |
| <p>The problem is that relaxed orderings don’t synchronize initialization of the object with |
| the read from the second thread. This is a data race. A possible solution would be to use |
| <code>Release</code> and <code>Acquire</code> orderings.</p> |
| <h5 id="examples-5"><a href="#examples-5">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::{<span class="self">self </span><span class="kw">as </span>epoch, Atomic}; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| |
| <span class="kw">let </span>a = Atomic::new(<span class="number">1234</span>); |
| <span class="kw">let </span>guard = <span class="kw-2">&</span>epoch::pin(); |
| <span class="kw">let </span>p = a.load(SeqCst, guard); |
| <span class="kw">unsafe </span>{ |
| <span class="macro">assert_eq!</span>(p.as_ref(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">1234</span>)); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_owned" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1546-1549">source</a><h4 class="code-header">pub unsafe fn <a href="#method.into_owned" class="fnname">into_owned</a>(self) -> <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h4></section></summary><div class="docblock"><p>Takes ownership of the pointee.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>Panics if this pointer is null, but only in debug mode.</p> |
| <h5 id="safety-3"><a href="#safety-3">Safety</a></h5> |
| <p>This method may be called only if the pointer is valid and nobody else is holding a |
| reference to the same object.</p> |
| <h5 id="examples-6"><a href="#examples-6">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::{<span class="self">self </span><span class="kw">as </span>epoch, Atomic}; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| |
| <span class="kw">let </span>a = Atomic::new(<span class="number">1234</span>); |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>guard = <span class="kw-2">&</span>epoch::unprotected(); |
| <span class="kw">let </span>p = a.load(SeqCst, guard); |
| drop(p.into_owned()); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into_owned" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1573-1579">source</a><h4 class="code-header">pub unsafe fn <a href="#method.try_into_owned" class="fnname">try_into_owned</a>(self) -> Option<<a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T>></h4></section></summary><div class="docblock"><p>Takes ownership of the pointee if it is not null.</p> |
| <h5 id="safety-4"><a href="#safety-4">Safety</a></h5> |
| <p>This method may be called only if the pointer is valid and nobody else is holding a |
| reference to the same object, or if the pointer is null.</p> |
| <h5 id="examples-7"><a href="#examples-7">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::{<span class="self">self </span><span class="kw">as </span>epoch, Atomic}; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| |
| <span class="kw">let </span>a = Atomic::new(<span class="number">1234</span>); |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>guard = <span class="kw-2">&</span>epoch::unprotected(); |
| <span class="kw">let </span>p = a.load(SeqCst, guard); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(x) = p.try_into_owned() { |
| drop(x); |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.tag" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1595-1598">source</a><h4 class="code-header">pub fn <a href="#method.tag" class="fnname">tag</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the tag stored within the pointer.</p> |
| <h5 id="examples-8"><a href="#examples-8">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::{<span class="self">self </span><span class="kw">as </span>epoch, Atomic, Owned}; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| |
| <span class="kw">let </span>a = Atomic::<u64>::from(Owned::new(<span class="number">0u64</span>).with_tag(<span class="number">2</span>)); |
| <span class="kw">let </span>guard = <span class="kw-2">&</span>epoch::pin(); |
| <span class="kw">let </span>p = a.load(SeqCst, guard); |
| <span class="macro">assert_eq!</span>(p.tag(), <span class="number">2</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_tag" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1619-1621">source</a><h4 class="code-header">pub fn <a href="#method.with_tag" class="fnname">with_tag</a>(&self, tag: usize) -> <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></h4></section></summary><div class="docblock"><p>Returns the same pointer, but tagged with <code>tag</code>. <code>tag</code> is truncated to be fit into the |
| unused bits of the pointer to <code>T</code>.</p> |
| <h5 id="examples-9"><a href="#examples-9">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::{<span class="self">self </span><span class="kw">as </span>epoch, Atomic}; |
| <span class="kw">use </span>std::sync::atomic::Ordering::SeqCst; |
| |
| <span class="kw">let </span>a = Atomic::new(<span class="number">0u64</span>); |
| <span class="kw">let </span>guard = <span class="kw-2">&</span>epoch::pin(); |
| <span class="kw">let </span>p1 = a.load(SeqCst, guard); |
| <span class="kw">let </span>p2 = p1.with_tag(<span class="number">2</span>); |
| |
| <span class="macro">assert_eq!</span>(p1.tag(), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(p2.tag(), <span class="number">2</span>); |
| <span class="macro">assert_eq!</span>(p1.as_raw(), p2.as_raw());</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-Shared%3C%27_%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1314-1321">source</a><a href="#impl-Clone-for-Shared%3C%27_%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> Clone for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, T></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_epoch/atomic.rs.html#1315-1320">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> Self</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>(&mut self, source: &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-Shared%3C%27_%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1667-1676">source</a><a href="#impl-Debug-for-Shared%3C%27_%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> Debug for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, T></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_epoch/atomic.rs.html#1668-1675">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> 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-Shared%3C%27_%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1684-1688">source</a><a href="#impl-Default-for-Shared%3C%27_%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> Default for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, T></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_epoch/atomic.rs.html#1685-1687">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a class="fnname">default</a>() -> Self</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-From%3C*const%20T%3E-for-Shared%3C%27_%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1624-1645">source</a><a href="#impl-From%3C*const%20T%3E-for-Shared%3C%27_%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T> From<*const T> for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, 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"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1640-1644">source</a><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(raw: *const T) -> Self</h4></section></summary><div class="docblock"><p>Returns a new pointer pointing to <code>raw</code>.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>Panics if <code>raw</code> is not properly aligned.</p> |
| <h5 id="examples-11"><a href="#examples-11">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::Shared; |
| |
| <span class="kw">let </span>p = Shared::from(Box::into_raw(Box::new(<span class="number">1234</span>)) <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>); |
| <span class="macro">assert!</span>(!p.is_null());</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CShared%3C%27g%2C%20T%3E%3E-for-Atomic%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1009-1022">source</a><a href="#impl-From%3CShared%3C%27g%2C%20T%3E%3E-for-Atomic%3CT%3E" class="anchor"></a><h3 class="code-header">impl<'g, T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> From<<a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T>> for <a class="struct" href="struct.Atomic.html" title="struct crossbeam_epoch::Atomic">Atomic</a><T></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_epoch/atomic.rs.html#1019-1021">source</a><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(ptr: <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T>) -> Self</h4></section></summary><div class="docblock"><p>Returns a new atomic pointer pointing to <code>ptr</code>.</p> |
| <h5 id="examples-10"><a href="#examples-10">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>crossbeam_epoch::{Atomic, Shared}; |
| |
| <span class="kw">let </span>a = Atomic::<i32>::from(Shared::<i32>::null());</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Ord-for-Shared%3C%27_%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1661-1665">source</a><a href="#impl-Ord-for-Shared%3C%27_%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> Ord for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cmp" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1662-1664">source</a><a href="#method.cmp" class="anchor"></a><h4 class="code-header">fn <a class="fnname">cmp</a>(&self, other: &Self) -> Ordering</h4></section></summary><div class='docblock'>This method returns an [<code>Ordering</code>] between <code>self</code> and <code>other</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.21.0">1.21.0</span><a href="#method.max" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">max</a>(self, other: Self) -> Self</h4></section></summary><div class='docblock'>Compares and returns the maximum of two values. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.min" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.21.0">1.21.0</span><a href="#method.min" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">min</a>(self, other: Self) -> Self</h4></section></summary><div class='docblock'>Compares and returns the minimum of two values. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clamp" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.50.0">1.50.0</span><a href="#method.clamp" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clamp</a>(self, min: Self, max: Self) -> Self<span class="where fmt-newline">where<br> Self: PartialOrd<Self>,</span></h4></section></summary><div class='docblock'>Restrict a value to a certain interval. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CShared%3C%27g%2C%20T%3E%3E-for-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1647-1651">source</a><a href="#impl-PartialEq%3CShared%3C%27g%2C%20T%3E%3E-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<'g, T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> PartialEq<<a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T>> for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></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_epoch/atomic.rs.html#1648-1650">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a class="fnname">eq</a>(&self, other: &Self) -> 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>(&self, other: &Rhs) -> 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><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialOrd%3CShared%3C%27g%2C%20T%3E%3E-for-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1655-1659">source</a><a href="#impl-PartialOrd%3CShared%3C%27g%2C%20T%3E%3E-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<'g, T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> PartialOrd<<a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T>> for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.partial_cmp" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1656-1658">source</a><a href="#method.partial_cmp" class="anchor"></a><h4 class="code-header">fn <a class="fnname">partial_cmp</a>(&self, other: &Self) -> Option<Ordering></h4></section></summary><div class='docblock'>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lt" 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.lt" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">lt</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.le" 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.le" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">le</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code> |
| operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.gt" 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.gt" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">gt</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ge" 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.ge" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ge</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code> |
| operator. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Pointer%3CT%3E-for-Shared%3C%27_%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1325-1338">source</a><a href="#impl-Pointer%3CT%3E-for-Shared%3C%27_%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> <a class="trait" href="trait.Pointer.html" title="trait crossbeam_epoch::Pointer">Pointer</a><T> for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_usize" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1327-1329">source</a><a href="#method.into_usize" class="anchor"></a><h4 class="code-header">fn <a href="trait.Pointer.html#tymethod.into_usize" class="fnname">into_usize</a>(self) -> usize</h4></section></summary><div class='docblock'>Returns the machine representation of the pointer.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_usize" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1332-1337">source</a><a href="#method.from_usize" class="anchor"></a><h4 class="code-header">unsafe fn <a href="trait.Pointer.html#tymethod.from_usize" class="fnname">from_usize</a>(data: usize) -> Self</h4></section></summary><div class='docblock'>Returns a new pointer pointing to the tagged pointer <code>data</code>. <a href="trait.Pointer.html#tymethod.from_usize">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Pointer-for-Shared%3C%27_%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1678-1682">source</a><a href="#impl-Pointer-for-Shared%3C%27_%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> Pointer for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1679-1681">source</a><a href="#method.fmt-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter.</div></details></div></details><section id="impl-Copy-for-Shared%3C%27_%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1323">source</a><a href="#impl-Copy-for-Shared%3C%27_%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> Copy for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, T></h3></section><section id="impl-Eq-for-Shared%3C%27_%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1653">source</a><a href="#impl-Eq-for-Shared%3C%27_%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized + <a class="trait" href="trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> Eq for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, T></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-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<'g, T: ?Sized> RefUnwindSafe for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T><span class="where fmt-newline">where<br> T: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-Send-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<'g, T> !Send for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></h3></section><section id="impl-Sync-for-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-Sync-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<'g, T> !Sync for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></h3></section><section id="impl-Unpin-for-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<'g, T: ?Sized> Unpin for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></h3></section><section id="impl-UnwindSafe-for-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<'g, T: ?Sized> UnwindSafe for <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T><span class="where fmt-newline">where<br> T: RefUnwindSafe,</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-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-Any-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> 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>(&self) -> 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-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> 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>(&self) -> &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-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> 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>(&mut self) -> &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%3CT%3E-for-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> 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: T) -> 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-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</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) -> 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]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> 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>(&self) -> 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>(&self, target: &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-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</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) -> Result<T, <T as TryFrom<U>>::Error></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-Shared%3C%27g%2C%20T%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Shared%3C%27g%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</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> = <U as TryFrom<T>>::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) -> Result<U, <U as TryFrom<T>>::Error></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_epoch" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
