<!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 `replace` fn in crate `std`."><meta name="keywords" content="rust, rustlang, rust-lang, replace"><title>std::mem::replace - 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><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></head><body class="rustdoc fn"><!--[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><div class="sidebar-elems"><p class='location'><a href='../index.html'>std</a>::<wbr><a href='index.html'>mem</a></p><script>window.sidebarCurrent = {name: 'replace', ty: 'fn', 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"><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='in-band'>Function <a href='../index.html'>std</a>::<wbr><a href='index.html'>mem</a>::<wbr><a class="fn" href=''>replace</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/mem.rs.html#693-696' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn replace<T>(dest: <a class="primitive" href="../primitive.reference.html">&mut </a>T, src: T) -> T</pre><div class='docblock'><p>Moves <code>src</code> into the referenced <code>dest</code>, returning the previous <code>dest</code> value.</p>
<p>Neither value is dropped.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<p>A simple example:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">v</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">i32</span><span class="op">></span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">1</span>, <span class="number">2</span>];
<span class="kw">let</span> <span class="ident">old_v</span> <span class="op">=</span> <span class="ident">mem</span>::<span class="ident">replace</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">v</span>, <span class="macro">vec</span><span class="macro">!</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">2</span>, <span class="ident">old_v</span>.<span class="ident">len</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">3</span>, <span class="ident">v</span>.<span class="ident">len</span>());<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Amem%3B%0A%0Alet%20mut%20v%3A%20Vec%3Ci32%3E%20%3D%20vec!%5B1%2C%202%5D%3B%0A%0Alet%20old_v%20%3D%20mem%3A%3Areplace(%26mut%20v%2C%20vec!%5B3%2C%204%2C%205%5D)%3B%0Aassert_eq!(2%2C%20old_v.len())%3B%0Aassert_eq!(3%2C%20v.len())%3B%0A%7D">Run</a></pre>
<p><code>replace</code> allows consumption of a struct field by replacing it with another value.
Without <code>replace</code> you can run into issues like these:</p>
<div class='information'><div class='tooltip compile_fail'>ⓘ<span class='tooltiptext'>This example deliberately fails to compile</span></div></div><pre class="rust rust-example-rendered compile_fail">
<span class="kw">struct</span> <span class="ident">Buffer</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="ident">buf</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> }
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Buffer</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">get_and_reset</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="comment">// error: cannot move out of dereference of `&mut`-pointer</span>
<span class="kw">let</span> <span class="ident">buf</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">buf</span>;
<span class="self">self</span>.<span class="ident">buf</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">new</span>();
<span class="ident">buf</span>
}
}<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Astruct%20Buffer%3CT%3E%20%7B%20buf%3A%20Vec%3CT%3E%20%7D%0A%0Aimpl%3CT%3E%20Buffer%3CT%3E%20%7B%0A%20%20%20%20fn%20get_and_reset(%26mut%20self)%20-%3E%20Vec%3CT%3E%20%7B%0A%20%20%20%20%20%20%20%20%2F%2F%20error%3A%20cannot%20move%20out%20of%20dereference%20of%20%60%26mut%60-pointer%0A%20%20%20%20%20%20%20%20let%20buf%20%3D%20self.buf%3B%0A%20%20%20%20%20%20%20%20self.buf%20%3D%20Vec%3A%3Anew()%3B%0A%20%20%20%20%20%20%20%20buf%0A%20%20%20%20%7D%0A%7D%0A%7D">Run</a></pre>
<p>Note that <code>T</code> does not necessarily implement <a href="../../std/clone/trait.Clone.html"><code>Clone</code></a>, so it can't even clone and reset
<code>self.buf</code>. But <code>replace</code> can be used to disassociate the original value of <code>self.buf</code> from
<code>self</code>, allowing it to be returned:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>;
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Buffer</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">get_and_reset</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">mem</span>::<span class="ident">replace</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">buf</span>, <span class="ident">Vec</span>::<span class="ident">new</span>())
}
}<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Ballow(dead_code)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Amem%3B%0A%0Astruct%20Buffer%3CT%3E%20%7B%20buf%3A%20Vec%3CT%3E%20%7D%0Aimpl%3CT%3E%20Buffer%3CT%3E%20%7B%0A%20%20%20%20fn%20get_and_reset(%26mut%20self)%20-%3E%20Vec%3CT%3E%20%7B%0A%20%20%20%20%20%20%20%20mem%3A%3Areplace(%26mut%20self.buf%2C%20Vec%3A%3Anew())%0A%20%20%20%20%7D%0A%7D%0A%7D">Run</a></pre>
</div></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 = "std";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
4e2dbb669434a7691662cb2f0ad38972
>
files
>
13625
