blob: 7ed94579367acb760908307e09e85cd38aa05a1d [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Extension methods for raw pointers"><meta name="keywords" content="rust, rustlang, rust-lang, PointerExt"><title>PointerExt in rawpointer - 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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../rawpointer/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="../rawpointer/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">PointerExt</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.offset">offset</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.dec">dec</a></li><li><a href="#method.inc">inc</a></li><li><a href="#method.post_dec">post_dec</a></li><li><a href="#method.post_inc">post_inc</a></li><li><a href="#method.pre_dec">pre_dec</a></li><li><a href="#method.pre_inc">pre_inc</a></li><li><a href="#method.stride_offset">stride_offset</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-PointerExt-for-*const%20T">*const T</a></li><li><a href="#impl-PointerExt-for-*mut%20T">*mut T</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rawpointer</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">Trait <a href="index.html">rawpointer</a>::<wbr><a class="trait" href="#">PointerExt</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/rawpointer/lib.rs.html#25-83">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>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: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.isize.html">isize</a>) -&gt; Self;
unsafe fn <a href="#method.pre_inc" class="fnname">pre_inc</a>(&amp;mut self) -&gt; Self { ... }
<span class="item-spacer"></span> unsafe fn <a href="#method.post_inc" class="fnname">post_inc</a>(&amp;mut self) -&gt; Self { ... }
<span class="item-spacer"></span> unsafe fn <a href="#method.pre_dec" class="fnname">pre_dec</a>(&amp;mut self) -&gt; Self { ... }
<span class="item-spacer"></span> unsafe fn <a href="#method.post_dec" class="fnname">post_dec</a>(&amp;mut self) -&gt; Self { ... }
<span class="item-spacer"></span> unsafe fn <a href="#method.inc" class="fnname">inc</a>(&amp;mut self) { ... }
<span class="item-spacer"></span> unsafe fn <a href="#method.dec" class="fnname">dec</a>(&amp;mut self) { ... }
<span class="item-spacer"></span> unsafe fn <a href="#method.stride_offset" class="fnname">stride_offset</a>(self, s: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.isize.html">isize</a>, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>) -&gt; Self { ... }
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension methods for raw pointers</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><section id="tymethod.offset" class="method has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#26">source</a><h4 class="code-header">unsafe fn <a href="#tymethod.offset" class="fnname">offset</a>(self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.isize.html">isize</a>) -&gt; Self</h4></section></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.pre_inc" class="method has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#32-35">source</a><h4 class="code-header">unsafe fn <a href="#method.pre_inc" class="fnname">pre_inc</a>(&amp;mut self) -&gt; Self</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.post_inc" class="method has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#41-45">source</a><h4 class="code-header">unsafe fn <a href="#method.post_inc" class="fnname">post_inc</a>(&amp;mut self) -&gt; Self</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.pre_dec" class="method has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#51-54">source</a><h4 class="code-header">unsafe fn <a href="#method.pre_dec" class="fnname">pre_dec</a>(&amp;mut self) -&gt; Self</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.post_dec" class="method has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#60-64">source</a><h4 class="code-header">unsafe fn <a href="#method.post_dec" class="fnname">post_dec</a>(&amp;mut self) -&gt; Self</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.inc" class="method has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#68-70">source</a><h4 class="code-header">unsafe fn <a href="#method.inc" class="fnname">inc</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Increment by 1</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.dec" class="method has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#74-76">source</a><h4 class="code-header">unsafe fn <a href="#method.dec" class="fnname">dec</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Decrement by 1</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.stride_offset" class="method has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#80-82">source</a><h4 class="code-header">unsafe fn <a href="#method.stride_offset" class="fnname">stride_offset</a>(self, s: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.isize.html">isize</a>, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Offset the pointer by <code>s</code> multiplied by <code>index</code>.</p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-PointerExt-for-*const%20T" class="impl has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#85-90">source</a><a href="#impl-PointerExt-for-*const%20T" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.PointerExt.html" title="trait rawpointer::PointerExt">PointerExt</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.pointer.html">*const T</a></h3></section></summary><div class="impl-items"><section id="method.offset" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#87-89">source</a><a href="#method.offset" class="anchor"></a><h4 class="code-header">unsafe fn <a href="#tymethod.offset" class="fnname">offset</a>(self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.isize.html">isize</a>) -&gt; Self</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-PointerExt-for-*mut%20T" class="impl has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#92-97">source</a><a href="#impl-PointerExt-for-*mut%20T" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.PointerExt.html" title="trait rawpointer::PointerExt">PointerExt</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.pointer.html">*mut T</a></h3></section></summary><div class="impl-items"><section id="method.offset-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/rawpointer/lib.rs.html#94-96">source</a><a href="#method.offset-1" class="anchor"></a><h4 class="code-header">unsafe fn <a href="#tymethod.offset" class="fnname">offset</a>(self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.isize.html">isize</a>) -&gt; Self</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../implementors/rawpointer/trait.PointerExt.js" data-ignore-extern-crates="core" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="rawpointer" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>