forked from pola-rs/polars
/
trait.Pointer.html
17 lines (17 loc) · 9.19 KB
/
trait.Pointer.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<!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 trait for either `Owned` or `Shared` pointers."><meta name="keywords" content="rust, rustlang, rust-lang, Pointer"><title>crossbeam_epoch::Pointer - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../crossbeam_epoch/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait Pointer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_usize">from_usize</a><a href="#tymethod.into_usize">into_usize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">crossbeam_epoch</a></p><div id="sidebar-vars" data-name="Pointer" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">crossbeam_epoch</a>::<wbr><a class="trait" href="">Pointer</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/crossbeam_epoch/atomic.rs.html#912-923" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Pointer<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../crossbeam_epoch/trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> {
fn <a href="#tymethod.into_usize" class="fnname">into_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
<div class="item-spacer"></div> unsafe fn <a href="#tymethod.from_usize" class="fnname">from_usize</a>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self;
}</pre></div><div class="docblock"><p>A trait for either <code>Owned</code> or <code>Shared</code> pointers.</p>
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.into_usize" class="method"><code>fn <a href="#tymethod.into_usize" class="fnname">into_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../src/crossbeam_epoch/atomic.rs.html#914" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns the machine representation of the pointer.</p>
</div><h3 id="tymethod.from_usize" class="method"><code>unsafe fn <a href="#tymethod.from_usize" class="fnname">from_usize</a>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class="srclink" href="../src/crossbeam_epoch/atomic.rs.html#922" title="goto source code">[src]</a></h3><div class="docblock"><p>Returns a new pointer pointing to the tagged pointer <code>data</code>.</p>
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
<p>The given <code>data</code> should have been created by <code>Pointer::into_usize()</code>, and one <code>data</code> should
not be converted back by <code>Pointer::from_usize()</code> multiple times.</p>
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-Pointer%3CT%3E" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../crossbeam_epoch/trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> <a class="trait" href="../crossbeam_epoch/trait.Pointer.html" title="trait crossbeam_epoch::Pointer">Pointer</a><T> for <a class="struct" href="../crossbeam_epoch/struct.Owned.html" title="struct crossbeam_epoch::Owned">Owned</a><T></code><a href="#impl-Pointer%3CT%3E" class="anchor"></a><a class="srclink" href="../src/crossbeam_epoch/atomic.rs.html#936-957" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into_usize" class="method hidden"><code>fn <a href="#method.into_usize" class="fnname">into_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../src/crossbeam_epoch/atomic.rs.html#938-942" title="goto source code">[src]</a></h4><h4 id="method.from_usize" class="method"><code>unsafe fn <a href="#method.from_usize" class="fnname">from_usize</a>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class="srclink" href="../src/crossbeam_epoch/atomic.rs.html#950-956" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a new pointer pointing to the tagged pointer <code>data</code>.</p>
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
<p>Panics if the data is zero in debug mode.</p>
</div></div><h3 id="impl-Pointer%3CT%3E-1" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../crossbeam_epoch/trait.Pointable.html" title="trait crossbeam_epoch::Pointable">Pointable</a>> <a class="trait" href="../crossbeam_epoch/trait.Pointer.html" title="trait crossbeam_epoch::Pointer">Pointer</a><T> for <a class="struct" href="../crossbeam_epoch/struct.Shared.html" title="struct crossbeam_epoch::Shared">Shared</a><'_, T></code><a href="#impl-Pointer%3CT%3E-1" class="anchor"></a><a class="srclink" href="../src/crossbeam_epoch/atomic.rs.html#1195-1208" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into_usize-1" class="method hidden"><code>fn <a href="#method.into_usize-1" class="fnname">into_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class="srclink" href="../src/crossbeam_epoch/atomic.rs.html#1197-1199" title="goto source code">[src]</a></h4><h4 id="method.from_usize-1" class="method hidden"><code>unsafe fn <a href="#method.from_usize-1" class="fnname">from_usize</a>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class="srclink" href="../src/crossbeam_epoch/atomic.rs.html#1202-1207" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/crossbeam_epoch/trait.Pointer.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="crossbeam_epoch" data-search-js="../search-index.js"></div>
<script src="../main.js"></script></body></html>