<!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 `ptr` mod in crate `std`."> <meta name="keywords" content="rust, rustlang, rust-lang, ptr"> <title>std::ptr - 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="../../main.css" id="themeStyle"> <script src="../../storage.js"></script> <link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"> </head> <body class="rustdoc mod"> <!--[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='../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a> <p class='location'>Module ptr</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>std</a></p><script>window.sidebarCurrent = {name: 'ptr', ty: 'mod', 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"> <input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"> </div> </form> </nav> <section id='main' class="content"> <h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>std</a>::<wbr><a class="mod" href=''>ptr</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><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/core/lib.rs.html#143' title='goto source code'>[src]</a></span></h1> <div class='docblock'><p>Raw, unsafe pointers, <code>*const T</code>, and <code>*mut T</code>.</p> <p><em><a href="../../std/primitive.pointer.html">See also the pointer primitive types</a>.</em></p> </div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2> <table> <tr class=' module-item'> <td><a class="struct" href="struct.NonNull.html" title='struct std::ptr::NonNull'>NonNull</a></td> <td class='docblock-short'> <p><code>*mut T</code> but non-zero and covariant.</p> </td> </tr> <tr class='unstable module-item'> <td><a class="struct" href="struct.Unique.html" title='struct std::ptr::Unique'>Unique</a></td> <td class='docblock-short'> [<div class='stab unstable'>Experimental</div>] <p>A wrapper around a raw non-null <code>*mut T</code> that indicates that the possessor of this wrapper owns the referent. Useful for building abstractions like <code>Box<T></code>, <code>Vec<T></code>, <code>String</code>, and <code>HashMap<K, V></code>.</p> </td> </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2> <table> <tr class=' module-item'> <td><a class="fn" href="fn.copy.html" title='fn std::ptr::copy'>copy</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Copies <code>count * size_of<T></code> bytes from <code>src</code> to <code>dst</code>. The source and destination may overlap.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.copy_nonoverlapping.html" title='fn std::ptr::copy_nonoverlapping'>copy_nonoverlapping</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Copies <code>count * size_of<T></code> bytes from <code>src</code> to <code>dst</code>. The source and destination may <em>not</em> overlap.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.drop_in_place.html" title='fn std::ptr::drop_in_place'>drop_in_place</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Executes the destructor (if any) of the pointed-to value.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.eq.html" title='fn std::ptr::eq'>eq</a></td> <td class='docblock-short'> <p>Compare raw pointers for equality.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.null.html" title='fn std::ptr::null'>null</a></td> <td class='docblock-short'> <p>Creates a null raw pointer.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.null_mut.html" title='fn std::ptr::null_mut'>null_mut</a></td> <td class='docblock-short'> <p>Creates a null mutable raw pointer.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.read.html" title='fn std::ptr::read'>read</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Reads the value from <code>src</code> without moving it. This leaves the memory in <code>src</code> unchanged.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.read_unaligned.html" title='fn std::ptr::read_unaligned'>read_unaligned</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Reads the value from <code>src</code> without moving it. This leaves the memory in <code>src</code> unchanged.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.read_volatile.html" title='fn std::ptr::read_volatile'>read_volatile</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Performs a volatile read of the value from <code>src</code> without moving it. This leaves the memory in <code>src</code> unchanged.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.replace.html" title='fn std::ptr::replace'>replace</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Replaces the value at <code>dest</code> with <code>src</code>, returning the old value, without dropping either.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.swap.html" title='fn std::ptr::swap'>swap</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Swaps the values at two mutable locations of the same type, without deinitializing either.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.write.html" title='fn std::ptr::write'>write</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Overwrites a memory location with the given value without reading or dropping the old value.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.write_bytes.html" title='fn std::ptr::write_bytes'>write_bytes</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Invokes memset on the specified pointer, setting <code>count * size_of::<T>()</code> bytes of memory starting at <code>dst</code> to <code>val</code>.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.write_unaligned.html" title='fn std::ptr::write_unaligned'>write_unaligned</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Overwrites a memory location with the given value without reading or dropping the old value.</p> </td> </tr> <tr class=' module-item'> <td><a class="fn" href="fn.write_volatile.html" title='fn std::ptr::write_volatile'>write_volatile</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> <p>Performs a volatile write of a memory location with the given value without reading or dropping the old value.</p> </td> </tr> <tr class='unstable module-item'> <td><a class="fn" href="fn.swap_nonoverlapping.html" title='fn std::ptr::swap_nonoverlapping'>swap_nonoverlapping</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td> <td class='docblock-short'> [<div class='stab unstable'>Experimental</div>] <p>Swaps a sequence of values at two mutable locations of the same type.</p> </td> </tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2> <table> <tr class='unstable deprecated module-item'> <td><a class="type" href="type.Shared.html" title='type std::ptr::Shared'>Shared</a></td> <td class='docblock-short'> [<div class='stab deprecated'>Deprecated</div>] [<div class='stab unstable'>Experimental</div>] <p>Previous name of <code>NonNull</code>.</p> </td> </tr></table></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> </div> </div> </aside> <script> window.rootPath = "../../"; window.currentCrate = "std"; </script> <script src="../../main.js"></script> <script defer src="../../search-index.js"></script> </body> </html>