rtic/2/api/indexmap/set/trait.MutableValues.html
2024-12-06 13:35:18 +00:00

37 lines
No EOL
13 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Opt-in mutable access to `IndexSet` values."><title>MutableValues in indexmap::set - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="indexmap" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../indexmap/index.html">indexmap</a><span class="version">2.7.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Mutable<wbr>Values</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Value" title="Value">Value</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.get_full_mut2" title="get_full_mut2">get_full_mut2</a></li><li><a href="#tymethod.get_index_mut2" title="get_index_mut2">get_index_mut2</a></li><li><a href="#tymethod.retain2" title="retain2">retain2</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In indexmap::<wbr>set</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">indexmap</a>::<wbr><a href="index.html">set</a></span><h1>Trait <span class="trait">MutableValues</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/indexmap/set/mutable.rs.html#20-46">source</a> </span></div><pre class="rust item-decl"><code>pub trait MutableValues: Sealed {
type <a href="#associatedtype.Value" class="associatedtype">Value</a>;
// Required methods
fn <a href="#tymethod.get_full_mut2" class="fn">get_full_mut2</a>&lt;Q&gt;(
&amp;mut self,
value: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.reference.html">&amp;Q</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;(<a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.usize.html">usize</a>, &amp;mut Self::<a class="associatedtype" href="trait.MutableValues.html#associatedtype.Value" title="type indexmap::set::MutableValues::Value">Value</a>)&gt;
<span class="where">where Q: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a>&lt;Self::<a class="associatedtype" href="trait.MutableValues.html#associatedtype.Value" title="type indexmap::set::MutableValues::Value">Value</a>&gt;</span>;
<span class="item-spacer"></span> fn <a href="#tymethod.get_index_mut2" class="fn">get_index_mut2</a>(&amp;mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;mut Self::<a class="associatedtype" href="trait.MutableValues.html#associatedtype.Value" title="type indexmap::set::MutableValues::Value">Value</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.retain2" class="fn">retain2</a>&lt;F&gt;(&amp;mut self, keep: F)
<span class="where">where F: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;mut Self::<a class="associatedtype" href="trait.MutableValues.html#associatedtype.Value" title="type indexmap::set::MutableValues::Value">Value</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.bool.html">bool</a></span>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Opt-in mutable access to <a href="struct.IndexSet.html" title="struct indexmap::set::IndexSet"><code>IndexSet</code></a> values.</p>
<p>These methods expose <code>&amp;mut T</code>, mutable references to the value as it is stored
in the set.
You are allowed to modify the values in the set <strong>if the modification
does not change the values hash and equality</strong>.</p>
<p>If values are modified erroneously, you can no longer look them up.
This is sound (memory safe) but a logical error hazard (just like
implementing <code>PartialEq</code>, <code>Eq</code>, or <code>Hash</code> incorrectly would be).</p>
<p><code>use</code> this trait to enable its methods for <code>IndexSet</code>.</p>
<p>This trait is sealed and cannot be implemented for types outside this crate.</p>
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Value" class="method"><a class="src rightside" href="../../src/indexmap/set/mutable.rs.html#21">source</a><h4 class="code-header">type <a href="#associatedtype.Value" class="associatedtype">Value</a></h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.get_full_mut2" class="method"><a class="src rightside" href="../../src/indexmap/set/mutable.rs.html#26-28">source</a><h4 class="code-header">fn <a href="#tymethod.get_full_mut2" class="fn">get_full_mut2</a>&lt;Q&gt;(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.reference.html">&amp;Q</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;(<a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.usize.html">usize</a>, &amp;mut Self::<a class="associatedtype" href="trait.MutableValues.html#associatedtype.Value" title="type indexmap::set::MutableValues::Value">Value</a>)&gt;<div class="where">where
Q: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../trait.Equivalent.html" title="trait indexmap::Equivalent">Equivalent</a>&lt;Self::<a class="associatedtype" href="trait.MutableValues.html#associatedtype.Value" title="type indexmap::set::MutableValues::Value">Value</a>&gt;,</div></h4></section></summary><div class="docblock"><p>Return item index and mutable reference to the value</p>
<p>Computes in <strong>O(1)</strong> time (average).</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.get_index_mut2" class="method"><a class="src rightside" href="../../src/indexmap/set/mutable.rs.html#35">source</a><h4 class="code-header">fn <a href="#tymethod.get_index_mut2" class="fn">get_index_mut2</a>(&amp;mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;mut Self::<a class="associatedtype" href="trait.MutableValues.html#associatedtype.Value" title="type indexmap::set::MutableValues::Value">Value</a>&gt;</h4></section></summary><div class="docblock"><p>Return mutable reference to the value at an index.</p>
<p>Valid indices are <code>0 &lt;= index &lt; self.len()</code>.</p>
<p>Computes in <strong>O(1)</strong> time.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.retain2" class="method"><a class="src rightside" href="../../src/indexmap/set/mutable.rs.html#43-45">source</a><h4 class="code-header">fn <a href="#tymethod.retain2" class="fn">retain2</a>&lt;F&gt;(&amp;mut self, keep: F)<div class="where">where
F: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;mut Self::<a class="associatedtype" href="trait.MutableValues.html#associatedtype.Value" title="type indexmap::set::MutableValues::Value">Value</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Scan through each value in the set and keep those where the
closure <code>keep</code> returns <code>true</code>.</p>
<p>The values are visited in order, and remaining values keep their order.</p>
<p>Computes in <strong>O(n)</strong> time (average).</p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.83.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-MutableValues-for-IndexSet%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/indexmap/set/mutable.rs.html#51-80">source</a><a href="#impl-MutableValues-for-IndexSet%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S&gt; <a class="trait" href="trait.MutableValues.html" title="trait indexmap::set::MutableValues">MutableValues</a> for <a class="struct" href="struct.IndexSet.html" title="struct indexmap::set::IndexSet">IndexSet</a>&lt;T, S&gt;<div class="where">where
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,</div></h3></section></summary><div class="docblock"><p>Opt-in mutable access to <a href="struct.IndexSet.html" title="struct indexmap::set::IndexSet"><code>IndexSet</code></a> values.</p>
<p>See <a href="trait.MutableValues.html" title="trait indexmap::set::MutableValues"><code>MutableValues</code></a> for more information.</p>
</div><div class="impl-items"><section id="associatedtype.Value-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/indexmap/set/mutable.rs.html#55">source</a><a href="#associatedtype.Value-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Value" class="associatedtype">Value</a> = T</h4></section></div></details></div><script src="../../trait.impl/indexmap/set/mutable/trait.MutableValues.js" async></script></section></div></main></body></html>