<!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 `IndexMut` trait in crate `core`.">
<meta name="keywords" content="rust, rustlang, rust-lang, IndexMut">
<title>core::ops::IndexMut - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
<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">
<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 IndexMut</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>core</a>::<wbr><a href='index.html'>ops</a></p><script>window.sidebarCurrent = {name: 'IndexMut', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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'>ops</a>::<wbr><a class="trait" href=''>IndexMut</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/ops.rs.html#2080-2084' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'><div class="docblock attributes">#[lang = "index_mut"]
</div>pub trait IndexMut<Idx: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>: <a class="trait" href="../../core/ops/trait.Index.html" title="trait core::ops::Index">Index</a><Idx> {
fn <a href='#tymethod.index_mut' class='fnname'>index_mut</a>(&mut self, index: Idx) -> &mut Self::<a class="trait" href="../../core/ops/trait.Index.html" title="trait core::ops::Index">Output</a>;
}</pre><div class='docblock'><p>The <code>IndexMut</code> trait is used to specify the functionality of indexing
operations like <code>container[index]</code> when used in a mutable context.</p>
<p><code>container[index]</code> is actually syntactic sugar for
<code>*container.index_mut(index)</code>, but only when used as a mutable value. If
an immutable value is requested, the <a href="../../std/ops/trait.Index.html"><code>Index</code></a> trait is used instead. This
allows nice things such as <code>v[index] = value</code> if <code>value</code> implements <a href="../../std/marker/trait.Copy.html"><code>Copy</code></a>.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<p>A very simple implementation of a <code>Balance</code> struct that has two sides, where
each can be indexed mutably and immutably.</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::{<span class="ident">Index</span>,<span class="ident">IndexMut</span>};
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">enum</span> <span class="ident">Side</span> {
<span class="ident">Left</span>,
<span class="ident">Right</span>,
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>)]</span>
<span class="kw">enum</span> <span class="ident">Weight</span> {
<span class="ident">Kilogram</span>(<span class="ident">f32</span>),
<span class="ident">Pound</span>(<span class="ident">f32</span>),
}
<span class="kw">struct</span> <span class="ident">Balance</span> {
<span class="kw">pub</span> <span class="ident">left</span>: <span class="ident">Weight</span>,
<span class="kw">pub</span> <span class="ident">right</span>:<span class="ident">Weight</span>,
}
<span class="kw">impl</span> <span class="ident">Index</span><span class="op"><</span><span class="ident">Side</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Balance</span> {
<span class="kw">type</span> <span class="ident">Output</span> <span class="op">=</span> <span class="ident">Weight</span>;
<span class="kw">fn</span> <span class="ident">index</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="self">self</span>, <span class="ident">index</span>: <span class="ident">Side</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Weight</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Accessing {:?}-side of balance immutably"</span>, <span class="ident">index</span>);
<span class="kw">match</span> <span class="ident">index</span> {
<span class="ident">Side</span>::<span class="ident">Left</span> <span class="op">=></span> <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">left</span>,
<span class="ident">Side</span>::<span class="ident">Right</span> <span class="op">=></span> <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">right</span>,
}
}
}
<span class="kw">impl</span> <span class="ident">IndexMut</span><span class="op"><</span><span class="ident">Side</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Balance</span> {
<span class="kw">fn</span> <span class="ident">index_mut</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">index</span>: <span class="ident">Side</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">Weight</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Accessing {:?}-side of balance mutably"</span>, <span class="ident">index</span>);
<span class="kw">match</span> <span class="ident">index</span> {
<span class="ident">Side</span>::<span class="ident">Left</span> <span class="op">=></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">left</span>,
<span class="ident">Side</span>::<span class="ident">Right</span> <span class="op">=></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">right</span>,
}
}
}
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">balance</span> <span class="op">=</span> <span class="ident">Balance</span> {
<span class="ident">right</span>: <span class="ident">Weight</span>::<span class="ident">Kilogram</span>(<span class="number">2.5</span>),
<span class="ident">left</span>: <span class="ident">Weight</span>::<span class="ident">Pound</span>(<span class="number">1.5</span>),
};
<span class="comment">// In this case balance[Side::Right] is sugar for</span>
<span class="comment">// *balance.index(Side::Right), since we are only reading</span>
<span class="comment">// balance[Side::Right], not writing it.</span>
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">balance</span>[<span class="ident">Side</span>::<span class="ident">Right</span>],<span class="ident">Weight</span>::<span class="ident">Kilogram</span>(<span class="number">2.5</span>));
<span class="comment">// However in this case balance[Side::Left] is sugar for</span>
<span class="comment">// *balance.index_mut(Side::Left), since we are writing</span>
<span class="comment">// balance[Side::Left].</span>
<span class="ident">balance</span>[<span class="ident">Side</span>::<span class="ident">Left</span>] <span class="op">=</span> <span class="ident">Weight</span>::<span class="ident">Kilogram</span>(<span class="number">3.0</span>);
}<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=use%20std%3A%3Aops%3A%3A%7BIndex%2CIndexMut%7D%3B%0A%0A%23%5Bderive(Debug)%5D%0Aenum%20Side%20%7B%0A%20%20%20%20Left%2C%0A%20%20%20%20Right%2C%0A%7D%0A%0A%23%5Bderive(Debug%2C%20PartialEq)%5D%0Aenum%20Weight%20%7B%0A%20%20%20%20Kilogram(f32)%2C%0A%20%20%20%20Pound(f32)%2C%0A%7D%0A%0Astruct%20Balance%20%7B%0A%20%20%20%20pub%20left%3A%20Weight%2C%0A%20%20%20%20pub%20right%3AWeight%2C%0A%7D%0A%0Aimpl%20Index%3CSide%3E%20for%20Balance%20%7B%0A%20%20%20%20type%20Output%20%3D%20Weight%3B%0A%0A%20%20%20%20fn%20index%3C'a%3E(%26'a%20self%2C%20index%3A%20Side)%20-%3E%20%26'a%20Weight%20%7B%0A%20%20%20%20%20%20%20%20println!(%22Accessing%20%7B%3A%3F%7D-side%20of%20balance%20immutably%22%2C%20index)%3B%0A%20%20%20%20%20%20%20%20match%20index%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20Side%3A%3ALeft%20%3D%3E%20%26self.left%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20Side%3A%3ARight%20%3D%3E%20%26self.right%2C%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%7D%0A%0Aimpl%20IndexMut%3CSide%3E%20for%20Balance%20%7B%0A%20%20%20%20fn%20index_mut%3C'a%3E(%26'a%20mut%20self%2C%20index%3A%20Side)%20-%3E%20%26'a%20mut%20Weight%20%7B%0A%20%20%20%20%20%20%20%20println!(%22Accessing%20%7B%3A%3F%7D-side%20of%20balance%20mutably%22%2C%20index)%3B%0A%20%20%20%20%20%20%20%20match%20index%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20Side%3A%3ALeft%20%3D%3E%20%26mut%20self.left%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20Side%3A%3ARight%20%3D%3E%20%26mut%20self.right%2C%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%7D%0A%0Afn%20main()%20%7B%0A%20%20%20%20let%20mut%20balance%20%3D%20Balance%20%7B%0A%20%20%20%20%20%20%20%20right%3A%20Weight%3A%3AKilogram(2.5)%2C%0A%20%20%20%20%20%20%20%20left%3A%20Weight%3A%3APound(1.5)%2C%0A%20%20%20%20%7D%3B%0A%0A%20%20%20%20%2F%2F%20In%20this%20case%20balance%5BSide%3A%3ARight%5D%20is%20sugar%20for%0A%20%20%20%20%2F%2F%20*balance.index(Side%3A%3ARight)%2C%20since%20we%20are%20only%20reading%0A%20%20%20%20%2F%2F%20balance%5BSide%3A%3ARight%5D%2C%20not%20writing%20it.%0A%20%20%20%20assert_eq!(balance%5BSide%3A%3ARight%5D%2CWeight%3A%3AKilogram(2.5))%3B%0A%0A%20%20%20%20%2F%2F%20However%20in%20this%20case%20balance%5BSide%3A%3ALeft%5D%20is%20sugar%20for%0A%20%20%20%20%2F%2F%20*balance.index_mut(Side%3A%3ALeft)%2C%20since%20we%20are%20writing%0A%20%20%20%20%2F%2F%20balance%5BSide%3A%3ALeft%5D.%0A%20%20%20%20balance%5BSide%3A%3ALeft%5D%20%3D%20Weight%3A%3AKilogram(3.0)%3B%0A%7D%0A">Run</a></pre>
</div>
<h2 id='required-methods'>Required Methods</h2>
<div class='methods'>
<h3 id='tymethod.index_mut' class='method'><span id='index_mut.v' class='invisible'><code>fn <a href='#tymethod.index_mut' class='fnname'>index_mut</a>(&mut self, index: Idx) -> &mut Self::<a class="trait" href="../../core/ops/trait.Index.html" title="trait core::ops::Index">Output</a></code></span></h3><div class='docblock'><p>The method for the mutable indexing (<code>container[index]</code>) operation</p>
</div></div>
<h2 id='implementors'>Implementors</h2>
<ul class='item-list' id='implementors-list'>
<li><code>impl<T, I> IndexMut<I> for [T] <span class="where fmt-newline">where<br> I: <a class="trait" href="../../core/slice/trait.SliceIndex.html" title="trait core::slice::SliceIndex">SliceIndex</a><[T]>, </span></code></li>
<li><code>impl IndexMut<<a class="struct" href="../../core/ops/struct.Range.html" title="struct core::ops::Range">Range</a><usize>> for str</code></li>
<li><code>impl IndexMut<<a class="struct" href="../../core/ops/struct.RangeTo.html" title="struct core::ops::RangeTo">RangeTo</a><usize>> for str</code></li>
<li><code>impl IndexMut<<a class="struct" href="../../core/ops/struct.RangeFrom.html" title="struct core::ops::RangeFrom">RangeFrom</a><usize>> for str</code></li>
<li><code>impl IndexMut<<a class="struct" href="../../core/ops/struct.RangeFull.html" title="struct core::ops::RangeFull">RangeFull</a>> for str</code></li>
<li><code>impl IndexMut<<a class="struct" href="../../core/ops/struct.RangeInclusive.html" title="struct core::ops::RangeInclusive">RangeInclusive</a><usize>> for str</code></li>
<li><code>impl IndexMut<<a class="struct" href="../../core/ops/struct.RangeToInclusive.html" title="struct core::ops::RangeToInclusive">RangeToInclusive</a><usize>> for str</code></li>
</ul><script type="text/javascript" async
src="../../implementors/core/ops/trait.IndexMut.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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
564935689ab5527f955e5449ded02799
>
files
>
1778
