28 lines
9.8 KiB
HTML
28 lines
9.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `PointerExt` trait in crate `rawpointer`."><meta name="keywords" content="rust, rustlang, rust-lang, PointerExt"><title>rawpointer::PointerExt - 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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><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">☰</div><a href='../rawpointer/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait PointerExt</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.offset">offset</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.dec">dec</a><a href="#method.inc">inc</a><a href="#method.post_dec">post_dec</a><a href="#method.post_inc">post_inc</a><a href="#method.pre_dec">pre_dec</a><a href="#method.pre_inc">pre_inc</a><a href="#method.stride_offset">stride_offset</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>rawpointer</a></p><script>window.sidebarCurrent = {name: 'PointerExt', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/rawpointer/lib.rs.html#25-83' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>rawpointer</a>::<wbr><a class="trait" href=''>PointerExt</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait PointerExt: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> {
|
||
unsafe fn <a href='#tymethod.offset' class='fnname'>offset</a>(self, i: isize) -> Self;
|
||
|
||
unsafe fn <a href='#method.pre_inc' class='fnname'>pre_inc</a>(&mut self) -> Self { ... }
|
||
<div class='item-spacer'></div> unsafe fn <a href='#method.post_inc' class='fnname'>post_inc</a>(&mut self) -> Self { ... }
|
||
<div class='item-spacer'></div> unsafe fn <a href='#method.pre_dec' class='fnname'>pre_dec</a>(&mut self) -> Self { ... }
|
||
<div class='item-spacer'></div> unsafe fn <a href='#method.post_dec' class='fnname'>post_dec</a>(&mut self) -> Self { ... }
|
||
<div class='item-spacer'></div> unsafe fn <a href='#method.inc' class='fnname'>inc</a>(&mut self) { ... }
|
||
<div class='item-spacer'></div> unsafe fn <a href='#method.dec' class='fnname'>dec</a>(&mut self) { ... }
|
||
<div class='item-spacer'></div> unsafe fn <a href='#method.stride_offset' class='fnname'>stride_offset</a>(self, s: isize, index: usize) -> Self { ... }
|
||
}</pre></div><div class='docblock'><p>Extension methods for raw 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.offset' class='method'><code id='offset.v'>unsafe fn <a href='#tymethod.offset' class='fnname'>offset</a>(self, i: isize) -> Self</code></h3></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.pre_inc' class='method'><code id='pre_inc.v'>unsafe fn <a href='#method.pre_inc' class='fnname'>pre_inc</a>(&mut self) -> Self</code></h3><div class='docblock'><p>Increment the pointer by 1, and return its new value.</p>
|
||
<p>Equivalent to the C idiom <code>++ptr</code>.</p>
|
||
</div><h3 id='method.post_inc' class='method'><code id='post_inc.v'>unsafe fn <a href='#method.post_inc' class='fnname'>post_inc</a>(&mut self) -> Self</code></h3><div class='docblock'><p>Increment the pointer by 1, but return its old value.</p>
|
||
<p>Equivalent to the C idiom <code>ptr++</code>.</p>
|
||
</div><h3 id='method.pre_dec' class='method'><code id='pre_dec.v'>unsafe fn <a href='#method.pre_dec' class='fnname'>pre_dec</a>(&mut self) -> Self</code></h3><div class='docblock'><p>Decrement the pointer by 1, and return its new value.</p>
|
||
<p>Equivalent to the C idiom <code>--ptr</code>.</p>
|
||
</div><h3 id='method.post_dec' class='method'><code id='post_dec.v'>unsafe fn <a href='#method.post_dec' class='fnname'>post_dec</a>(&mut self) -> Self</code></h3><div class='docblock'><p>Decrement the pointer by 1, but return its old value.</p>
|
||
<p>Equivalent to the C idiom <code>ptr--</code>.</p>
|
||
</div><h3 id='method.inc' class='method'><code id='inc.v'>unsafe fn <a href='#method.inc' class='fnname'>inc</a>(&mut self)</code></h3><div class='docblock'><p>Increment by 1</p>
|
||
</div><h3 id='method.dec' class='method'><code id='dec.v'>unsafe fn <a href='#method.dec' class='fnname'>dec</a>(&mut self)</code></h3><div class='docblock'><p>Decrement by 1</p>
|
||
</div><h3 id='method.stride_offset' class='method'><code id='stride_offset.v'>unsafe fn <a href='#method.stride_offset' class='fnname'>stride_offset</a>(self, s: isize, index: usize) -> Self</code></h3><div class='docblock'><p>Offset the pointer by <code>s</code> multiplied by <code>index</code>.</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-PointerExt' class='impl'><code class='in-band'>impl<T> PointerExt for *const T</code><a href='#impl-PointerExt' class='anchor'></a><a class='srclink' href='../src/rawpointer/lib.rs.html#85-90' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.offset' class="method hidden"><code id='offset.v-1'>unsafe fn <a href='#method.offset' class='fnname'>offset</a>(self, i: isize) -> Self</code><a class='srclink' href='../src/rawpointer/lib.rs.html#87-89' title='goto source code'>[src]</a></h4></div><h3 id='impl-PointerExt-1' class='impl'><code class='in-band'>impl<T> PointerExt for *mut T</code><a href='#impl-PointerExt-1' class='anchor'></a><a class='srclink' href='../src/rawpointer/lib.rs.html#92-97' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.offset-1' class="method hidden"><code id='offset.v-2'>unsafe fn <a href='#method.offset-1' class='fnname'>offset</a>(self, i: isize) -> Self</code><a class='srclink' href='../src/rawpointer/lib.rs.html#94-96' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/rawpointer/trait.PointerExt.js">
|
||
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "rawpointer";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |