<!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 `BorrowMut` trait in crate `core`."> <meta name="keywords" content="rust, rustlang, rust-lang, BorrowMut"> <title>core::borrow::BorrowMut - 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 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='../../core/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a> <p class='location'>Trait BorrowMut</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.borrow_mut">borrow_mut</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>core</a>::<wbr><a href='index.html'>borrow</a></p><script>window.sidebarCurrent = {name: 'BorrowMut', 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"> <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'>Trait <a href='../index.html'>core</a>::<wbr><a href='index.html'>borrow</a>::<wbr><a class="trait" href=''>BorrowMut</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/borrow.rs.html#64-82' title='goto source code'>[src]</a></span></h1> <pre class='rust trait'>pub trait BorrowMut<Borrowed: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>: <a class="trait" href="../../core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><Borrowed> { fn <a href='#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> &mut Borrowed; }</pre><div class='docblock'><p>A trait for mutably borrowing data.</p> <p>Similar to <code>Borrow</code>, but for mutable borrows.</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.borrow_mut' class='method'><span id='borrow_mut.v' class='invisible'><code>fn <a href='#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> &mut Borrowed</code></span></h3><div class='docblock'><p>Mutably borrows from an owned value.</p> <h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1> <pre class="rust rust-example-rendered"> <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">borrow</span>::<span class="ident">BorrowMut</span>; <span class="kw">fn</span> <span class="ident">check</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">BorrowMut</span><span class="op"><</span>[<span class="ident">i32</span>]<span class="op">>></span>(<span class="kw-2">mut</span> <span class="ident">v</span>: <span class="ident">T</span>) { <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>], <span class="ident">v</span>.<span class="ident">borrow_mut</span>()); } <span class="kw">let</span> <span class="ident">v</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="number">3</span>]; <span class="ident">check</span>(<span class="ident">v</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%3Aborrow%3A%3ABorrowMut%3B%0A%0Afn%20check%3CT%3A%20BorrowMut%3C%5Bi32%5D%3E%3E(mut%20v%3A%20T)%20%7B%0A%20%20%20%20assert_eq!(%26mut%20%5B1%2C%202%2C%203%5D%2C%20v.borrow_mut())%3B%0A%7D%0A%0Alet%20v%20%3D%20vec!%5B1%2C%202%2C%203%5D%3B%0A%0Acheck(v)%3B%0A%7D">Run</a></pre> </div></div> <h2 id='implementors' class='small-section-header'> Implementors<a href='#implementors' class='anchor'></a> </h2> <ul class='item-list' id='implementors-list'> <li><div class='out-of-band'><a class='srclink' href='../../src/core/borrow.rs.html#90-92' title='goto source code'>[src]</a></div><code>impl<T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> BorrowMut<T> for T</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/borrow.rs.html#105-107' title='goto source code'>[src]</a></div><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> BorrowMut<T> for &'a mut T</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 0]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 1]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 2]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 3]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 4]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 5]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 6]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 7]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 8]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 9]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 10]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 11]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 12]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 13]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 14]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 15]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 16]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 17]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 18]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 19]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 20]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 21]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 22]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 23]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 24]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 25]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 26]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 27]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 28]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 29]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 30]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 31]</code></li> <li><div class='out-of-band'><a class='srclink' href='../../src/core/array.rs.html#145-149' title='goto source code'>[src]</a></div><code>impl<T> BorrowMut<[T]> for [T; 32]</code></li> </ul><script type="text/javascript" async src="../../implementors/core/borrow/trait.BorrowMut.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> </div> </div> </aside> <script> window.rootPath = "../../"; window.currentCrate = "core"; </script> <script src="../../main.js"></script> <script defer src="../../search-index.js"></script> </body> </html>