| <!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="An owned heap-allocated object."><meta name="keywords" content="rust, rustlang, rust-lang, Owned"><title>Owned 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="#">Owned</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.from_raw">from_raw</a></li><li><a href="#method.init">init</a></li><li><a href="#method.into_box">into_box</a></li><li><a href="#method.into_shared">into_shared</a></li><li><a href="#method.new">new</a></li><li><a href="#method.tag">tag</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-AsMut%3CT%3E-for-Owned%3CT%3E">AsMut<T></a></li><li><a href="#impl-AsRef%3CT%3E-for-Owned%3CT%3E">AsRef<T></a></li><li><a href="#impl-Borrow%3CT%3E-for-Owned%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Owned%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-Clone-for-Owned%3CT%3E">Clone</a></li><li><a href="#impl-Debug-for-Owned%3CT%3E">Debug</a></li><li><a href="#impl-Deref-for-Owned%3CT%3E">Deref</a></li><li><a href="#impl-DerefMut-for-Owned%3CT%3E">DerefMut</a></li><li><a href="#impl-Drop-for-Owned%3CT%3E">Drop</a></li><li><a href="#impl-From%3CBox%3CT%2C%20Global%3E%3E-for-Owned%3CT%3E">From<Box<T, Global>></a></li><li><a href="#impl-From%3COwned%3CT%3E%3E-for-Atomic%3CT%3E">From<Owned<T>></a></li><li><a href="#impl-From%3CT%3E-for-Owned%3CT%3E">From<T></a></li><li><a href="#impl-Pointer%3CT%3E-for-Owned%3CT%3E">Pointer<T></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Owned%3CT%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Owned%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-Owned%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-Owned%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Owned%3CT%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Owned%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Owned%3CT%3E-1">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Owned%3CT%3E-1">BorrowMut<T></a></li><li><a href="#impl-From%3C!%3E-for-Owned%3CT%3E">From<!></a></li><li><a href="#impl-From%3CT%3E-for-Owned%3CT%3E-1">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Owned%3CT%3E">Into<U></a></li><li><a href="#impl-ToOwned-for-Owned%3CT%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Owned%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Owned%3CT%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="#">Owned</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#1060-1063">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 Owned<T: ?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>An owned heap-allocated object.</p> |
| <p>This type is very similar to <code>Box<T></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-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1088-1146">source</a><a href="#impl-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_raw" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1111-1115">source</a><h4 class="code-header">pub unsafe fn <a href="#method.from_raw" class="fnname">from_raw</a>(raw: *mut T) -> <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h4></section></summary><div class="docblock"><p>Returns a new owned pointer pointing to <code>raw</code>.</p> |
| <p>This function is unsafe because improper use may lead to memory problems. Argument <code>raw</code> |
| must be a valid pointer. Also, a double-free may occur if the function is called twice on |
| the same raw pointer.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>Panics if <code>raw</code> is not properly aligned.</p> |
| <h5 id="safety"><a href="#safety">Safety</a></h5> |
| <p>The given <code>raw</code> should have been derived from <code>Owned</code>, and one <code>raw</code> should not be converted |
| back by <code>Owned::from_raw()</code> multiple times.</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::Owned; |
| |
| <span class="kw">let </span>o = <span class="kw">unsafe </span>{ Owned::from_raw(Box::into_raw(Box::new(<span class="number">1234</span>))) };</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_box" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1128-1132">source</a><h4 class="code-header">pub fn <a href="#method.into_box" class="fnname">into_box</a>(self) -> Box<T></h4></section></summary><div class="docblock"><p>Converts the owned pointer into a <code>Box</code>.</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::Owned; |
| |
| <span class="kw">let </span>o = Owned::new(<span class="number">1234</span>); |
| <span class="kw">let </span>b: Box<i32> = o.into_box(); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">*</span>b, <span class="number">1234</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1143-1145">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(init: T) -> <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h4></section></summary><div class="docblock"><p>Allocates <code>value</code> on the heap and returns a new owned pointer pointing to it.</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::Owned; |
| |
| <span class="kw">let </span>o = Owned::new(<span class="number">1234</span>);</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Owned%3CT%3E-1" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1148-1210">source</a><a href="#impl-Owned%3CT%3E-1" 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="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.init" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1158-1160">source</a><h4 class="code-header">pub fn <a href="#method.init" class="fnname">init</a>(init: T::<a class="associatedtype" href="trait.Pointable.html#associatedtype.Init" title="type crossbeam_epoch::Pointable::Init">Init</a>) -> <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h4></section></summary><div class="docblock"><p>Allocates <code>value</code> on the heap and returns a new owned pointer pointing to it.</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::Owned; |
| |
| <span class="kw">let </span>o = Owned::<i32>::init(<span class="number">1234</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_shared" class="method has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1175-1177">source</a><h4 class="code-header">pub fn <a href="#method.into_shared" class="fnname">into_shared</a><'g>(self, _: &'g <a class="struct" href="struct.Guard.html" title="struct crossbeam_epoch::Guard">Guard</a>) -> <a class="struct" href="struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'g, T></h4></section></summary><div class="docblock"><p>Converts the owned pointer into a <a href="struct.Shared.html" title="Shared"><code>Shared</code></a>.</p> |
| <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, Owned}; |
| |
| <span class="kw">let </span>o = Owned::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 = o.into_shared(guard);</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#1188-1191">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-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::Owned; |
| |
| <span class="macro">assert_eq!</span>(Owned::new(<span class="number">1234</span>).tag(), <span class="number">0</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#1206-1209">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.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><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-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::Owned; |
| |
| <span class="kw">let </span>o = Owned::new(<span class="number">0u64</span>); |
| <span class="macro">assert_eq!</span>(o.tag(), <span class="number">0</span>); |
| <span class="kw">let </span>o = o.with_tag(<span class="number">2</span>); |
| <span class="macro">assert_eq!</span>(o.tag(), <span class="number">2</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-AsMut%3CT%3E-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1297-1301">source</a><a href="#impl-AsMut%3CT%3E-for-Owned%3CT%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>> AsMut<T> for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1298-1300">source</a><a href="#method.as_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">as_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Converts this type into a mutable reference of the (usually inferred) input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsRef%3CT%3E-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1291-1295">source</a><a href="#impl-AsRef%3CT%3E-for-Owned%3CT%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>> AsRef<T> for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_ref" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1292-1294">source</a><a href="#method.as_ref" class="anchor"></a><h4 class="code-header">fn <a class="fnname">as_ref</a>(&self) -> &T</h4></section></summary><div class='docblock'>Converts this type into a shared reference of the (usually inferred) input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Borrow%3CT%3E-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1279-1283">source</a><a href="#impl-Borrow%3CT%3E-for-Owned%3CT%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>> Borrow<T> for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></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"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1280-1282">source</a><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" open><summary><section id="impl-BorrowMut%3CT%3E-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1285-1289">source</a><a href="#impl-BorrowMut%3CT%3E-for-Owned%3CT%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>> BorrowMut<T> for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></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"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1286-1288">source</a><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" open><summary><section id="impl-Clone-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1232-1236">source</a><a href="#impl-Clone-for-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: Clone> Clone for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</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#1233-1235">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-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1221-1230">source</a><a href="#impl-Debug-for-Owned%3CT%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.Owned.html" title="struct crossbeam_epoch::Owned">Owned</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#1222-1229">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-Deref-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1238-1245">source</a><a href="#impl-Deref-for-Owned%3CT%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>> Deref for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></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_epoch/atomic.rs.html#1241-1244">source</a><a href="#method.deref" class="anchor"></a><h4 class="code-header">fn <a class="fnname">deref</a>(&self) -> &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-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1247-1252">source</a><a href="#impl-DerefMut-for-Owned%3CT%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>> DerefMut for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></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_epoch/atomic.rs.html#1248-1251">source</a><a href="#method.deref_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">deref_mut</a>(&mut self) -> &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-Drop-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1212-1219">source</a><a href="#impl-Drop-for-Owned%3CT%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>> Drop for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1213-1218">source</a><a href="#method.drop" class="anchor"></a><h4 class="code-header">fn <a class="fnname">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CBox%3CT%2C%20Global%3E%3E-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1260-1277">source</a><a href="#impl-From%3CBox%3CT%2C%20Global%3E%3E-for-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<Box<T, Global>> for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><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"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1274-1276">source</a><a href="#method.from-2" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(b: Box<T>) -> Self</h4></section></summary><div class="docblock"><p>Returns a new owned pointer pointing to <code>b</code>.</p> |
| <h5 id="panics-2"><a href="#panics-2">Panics</a></h5> |
| <p>Panics if the pointer (the <code>Box</code>) is not properly aligned.</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::Owned; |
| |
| <span class="kw">let </span>o = <span class="kw">unsafe </span>{ Owned::from_raw(Box::into_raw(Box::new(<span class="number">1234</span>))) };</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3COwned%3CT%3E%3E-for-Atomic%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#979-995">source</a><a href="#impl-From%3COwned%3CT%3E%3E-for-Atomic%3CT%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>> From<<a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><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#990-994">source</a><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(owned: <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T>) -> Self</h4></section></summary><div class="docblock"><p>Returns a new atomic pointer pointing to <code>owned</code>.</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::{Atomic, Owned}; |
| |
| <span class="kw">let </span>a = Atomic::<i32>::from(Owned::new(<span class="number">1234</span>));</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CT%3E-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1254-1258">source</a><a href="#impl-From%3CT%3E-for-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</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#1255-1257">source</a><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> 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-Pointer%3CT%3E-for-Owned%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/crossbeam_epoch/atomic.rs.html#1065-1086">source</a><a href="#impl-Pointer%3CT%3E-for-Owned%3CT%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.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h3></section></summary><div class="impl-items"><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#1079-1085">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"><p>Returns a new pointer pointing to the tagged pointer <code>data</code>.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>Panics if the data is zero in debug mode.</p> |
| </div></details><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#1067-1071">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></div></details></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-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized> RefUnwindSafe for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T><span class="where fmt-newline">where<br> T: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized> Send for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T><span class="where fmt-newline">where<br> T: Send,</span></h3></section><section id="impl-Sync-for-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized> Sync for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T><span class="where fmt-newline">where<br> T: Sync,</span></h3></section><section id="impl-Unpin-for-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized> Unpin for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></h3></section><section id="impl-UnwindSafe-for-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: ?Sized> UnwindSafe for <a class="struct" href="struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T><span class="where fmt-newline">where<br> 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-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-Owned%3CT%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-Owned%3CT%3E-1" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Owned%3CT%3E-1" 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-1" 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-1" 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-Owned%3CT%3E-1" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Owned%3CT%3E-1" 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-1" 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-1" 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%3C!%3E-for-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-From%3C!%3E-for-Owned%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<!> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-4" 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-4" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: !) -> 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-Owned%3CT%3E-1" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Owned%3CT%3E-1" 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-3" 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-3" 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-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Owned%3CT%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-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-Owned%3CT%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-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Owned%3CT%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-Owned%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Owned%3CT%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> |
