| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/indexmap-1.9.3/src/map/core/raw.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>raw.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../../normalize.css"><link rel="stylesheet" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../../ayu.css" disabled><link rel="stylesheet" href="../../../../dark.css" disabled><link rel="stylesheet" href="../../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../../storage.js"></script><script defer src="../../../../source-script.js"></script><script defer src="../../../../source-files.js"></script><script defer src="../../../../main.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../../indexmap/index.html"><div class="logo-container"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../indexmap/index.html"><img class="rust-logo" src="../../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| </pre><pre class="rust"><code><span class="attribute">#![allow(unsafe_code)] |
| </span><span class="doccomment">//! This module encapsulates the `unsafe` access to `hashbrown::raw::RawTable`, |
| //! mostly in dealing with its bucket "pointers". |
| |
| </span><span class="kw">use super</span>::{equivalent, Bucket, Entry, HashValue, IndexMapCore, VacantEntry}; |
| <span class="kw">use </span>core::fmt; |
| <span class="kw">use </span>core::mem::replace; |
| <span class="kw">use </span>hashbrown::raw::RawTable; |
| |
| <span class="kw">type </span>RawBucket = hashbrown::raw::Bucket<usize>; |
| |
| <span class="doccomment">/// Inserts many entries into a raw table without reallocating. |
| /// |
| /// ***Panics*** if there is not sufficient capacity already. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>insert_bulk_no_grow<K, V>(indices: <span class="kw-2">&mut </span>RawTable<usize>, entries: <span class="kw-2">&</span>[Bucket<K, V>]) { |
| <span class="macro">assert!</span>(indices.capacity() - indices.len() >= entries.len()); |
| <span class="kw">for </span>entry <span class="kw">in </span>entries { |
| <span class="comment">// SAFETY: we asserted that sufficient capacity exists for all entries. |
| </span><span class="kw">unsafe </span>{ |
| indices.insert_no_grow(entry.hash.get(), indices.len()); |
| } |
| } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>DebugIndices<<span class="lifetime">'a</span>>(<span class="kw">pub </span><span class="kw-2">&</span><span class="lifetime">'a </span>RawTable<usize>); |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>DebugIndices<<span class="lifetime">'_</span>> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="comment">// SAFETY: we're not letting any of the buckets escape this function |
| </span><span class="kw">let </span>indices = <span class="kw">unsafe </span>{ <span class="self">self</span>.<span class="number">0</span>.iter().map(|raw_bucket| raw_bucket.read()) }; |
| f.debug_list().entries(indices).finish() |
| } |
| } |
| |
| <span class="kw">impl</span><K, V> IndexMapCore<K, V> { |
| <span class="doccomment">/// Sweep the whole table to erase indices start..end |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>erase_indices_sweep(<span class="kw-2">&mut </span><span class="self">self</span>, start: usize, end: usize) { |
| <span class="comment">// SAFETY: we're not letting any of the buckets escape this function |
| </span><span class="kw">unsafe </span>{ |
| <span class="kw">let </span>offset = end - start; |
| <span class="kw">for </span>bucket <span class="kw">in </span><span class="self">self</span>.indices.iter() { |
| <span class="kw">let </span>i = bucket.read(); |
| <span class="kw">if </span>i >= end { |
| bucket.write(i - offset); |
| } <span class="kw">else if </span>i >= start { |
| <span class="self">self</span>.indices.erase(bucket); |
| } |
| } |
| } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>entry(<span class="kw-2">&mut </span><span class="self">self</span>, hash: HashValue, key: K) -> Entry<<span class="lifetime">'_</span>, K, V> |
| <span class="kw">where |
| </span>K: Eq, |
| { |
| <span class="kw">let </span>eq = equivalent(<span class="kw-2">&</span>key, <span class="kw-2">&</span><span class="self">self</span>.entries); |
| <span class="kw">match </span><span class="self">self</span>.indices.find(hash.get(), eq) { |
| <span class="comment">// SAFETY: The entry is created with a live raw bucket, at the same time |
| // we have a &mut reference to the map, so it can not be modified further. |
| </span><span class="prelude-val">Some</span>(raw_bucket) => Entry::Occupied(OccupiedEntry { |
| map: <span class="self">self</span>, |
| raw_bucket, |
| key, |
| }), |
| <span class="prelude-val">None </span>=> Entry::Vacant(VacantEntry { |
| map: <span class="self">self</span>, |
| hash, |
| key, |
| }), |
| } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>indices_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw">impl </span>Iterator<Item = <span class="kw-2">&mut </span>usize> { |
| <span class="comment">// SAFETY: we're not letting any of the buckets escape this function, |
| // only the item references that are appropriately bound to `&mut self`. |
| </span><span class="kw">unsafe </span>{ <span class="self">self</span>.indices.iter().map(|bucket| bucket.as_mut()) } |
| } |
| |
| <span class="doccomment">/// Return the raw bucket for the given index |
| </span><span class="kw">fn </span>find_index(<span class="kw-2">&</span><span class="self">self</span>, index: usize) -> RawBucket { |
| <span class="comment">// We'll get a "nice" bounds-check from indexing `self.entries`, |
| // and then we expect to find it in the table as well. |
| </span><span class="kw">let </span>hash = <span class="self">self</span>.entries[index].hash.get(); |
| <span class="self">self</span>.indices |
| .find(hash, <span class="kw">move </span>|<span class="kw-2">&</span>i| i == index) |
| .expect(<span class="string">"index not found"</span>) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>swap_indices(<span class="kw-2">&mut </span><span class="self">self</span>, a: usize, b: usize) { |
| <span class="comment">// SAFETY: Can't take two `get_mut` references from one table, so we |
| // must use raw buckets to do the swap. This is still safe because we |
| // are locally sure they won't dangle, and we write them individually. |
| </span><span class="kw">unsafe </span>{ |
| <span class="kw">let </span>raw_bucket_a = <span class="self">self</span>.find_index(a); |
| <span class="kw">let </span>raw_bucket_b = <span class="self">self</span>.find_index(b); |
| raw_bucket_a.write(b); |
| raw_bucket_b.write(a); |
| } |
| <span class="self">self</span>.entries.swap(a, b); |
| } |
| } |
| |
| <span class="doccomment">/// A view into an occupied entry in a `IndexMap`. |
| /// It is part of the [`Entry`] enum. |
| /// |
| /// [`Entry`]: enum.Entry.html |
| </span><span class="comment">// SAFETY: The lifetime of the map reference also constrains the raw bucket, |
| // which is essentially a raw pointer into the map indices. |
| </span><span class="kw">pub struct </span>OccupiedEntry<<span class="lifetime">'a</span>, K, V> { |
| map: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>IndexMapCore<K, V>, |
| raw_bucket: RawBucket, |
| key: K, |
| } |
| |
| <span class="comment">// `hashbrown::raw::Bucket` is only `Send`, not `Sync`. |
| // SAFETY: `&self` only accesses the bucket to read it. |
| </span><span class="kw">unsafe impl</span><K: Sync, V: Sync> Sync <span class="kw">for </span>OccupiedEntry<<span class="lifetime">'_</span>, K, V> {} |
| |
| <span class="comment">// The parent module also adds methods that don't threaten the unsafe encapsulation. |
| </span><span class="kw">impl</span><<span class="lifetime">'a</span>, K, V> OccupiedEntry<<span class="lifetime">'a</span>, K, V> { |
| <span class="doccomment">/// Gets a reference to the entry's key in the map. |
| /// |
| /// Note that this is not the key that was used to find the entry. There may be an observable |
| /// difference if the key type has any distinguishing features outside of `Hash` and `Eq`, like |
| /// extra fields or the memory address of an allocation. |
| </span><span class="kw">pub fn </span>key(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>K { |
| <span class="kw-2">&</span><span class="self">self</span>.map.entries[<span class="self">self</span>.index()].key |
| } |
| |
| <span class="doccomment">/// Gets a reference to the entry's value in the map. |
| </span><span class="kw">pub fn </span>get(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>V { |
| <span class="kw-2">&</span><span class="self">self</span>.map.entries[<span class="self">self</span>.index()].value |
| } |
| |
| <span class="doccomment">/// Gets a mutable reference to the entry's value in the map. |
| /// |
| /// If you need a reference which may outlive the destruction of the |
| /// `Entry` value, see `into_mut`. |
| </span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>V { |
| <span class="kw">let </span>index = <span class="self">self</span>.index(); |
| <span class="kw-2">&mut </span><span class="self">self</span>.map.entries[index].value |
| } |
| |
| <span class="doccomment">/// Put the new key in the occupied entry's key slot |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>replace_key(<span class="self">self</span>) -> K { |
| <span class="kw">let </span>index = <span class="self">self</span>.index(); |
| <span class="kw">let </span>old_key = <span class="kw-2">&mut </span><span class="self">self</span>.map.entries[index].key; |
| replace(old_key, <span class="self">self</span>.key) |
| } |
| |
| <span class="doccomment">/// Return the index of the key-value pair |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>index(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="comment">// SAFETY: we have &mut map keep keeping the bucket stable |
| </span><span class="kw">unsafe </span>{ <span class="self">self</span>.raw_bucket.read() } |
| } |
| |
| <span class="doccomment">/// Converts into a mutable reference to the entry's value in the map, |
| /// with a lifetime bound to the map itself. |
| </span><span class="kw">pub fn </span>into_mut(<span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>V { |
| <span class="kw">let </span>index = <span class="self">self</span>.index(); |
| <span class="kw-2">&mut </span><span class="self">self</span>.map.entries[index].value |
| } |
| |
| <span class="doccomment">/// Remove and return the key, value pair stored in the map for this entry |
| /// |
| /// Like `Vec::swap_remove`, the pair is removed by swapping it with the |
| /// last element of the map and popping it off. **This perturbs |
| /// the position of what used to be the last element!** |
| /// |
| /// Computes in **O(1)** time (average). |
| </span><span class="kw">pub fn </span>swap_remove_entry(<span class="self">self</span>) -> (K, V) { |
| <span class="comment">// SAFETY: This is safe because it can only happen once (self is consumed) |
| // and map.indices have not been modified since entry construction |
| </span><span class="kw">let </span>index = <span class="kw">unsafe </span>{ <span class="self">self</span>.map.indices.remove(<span class="self">self</span>.raw_bucket) }; |
| <span class="self">self</span>.map.swap_remove_finish(index) |
| } |
| |
| <span class="doccomment">/// Remove and return the key, value pair stored in the map for this entry |
| /// |
| /// Like `Vec::remove`, the pair is removed by shifting all of the |
| /// elements that follow it, preserving their relative order. |
| /// **This perturbs the index of all of those elements!** |
| /// |
| /// Computes in **O(n)** time (average). |
| </span><span class="kw">pub fn </span>shift_remove_entry(<span class="self">self</span>) -> (K, V) { |
| <span class="comment">// SAFETY: This is safe because it can only happen once (self is consumed) |
| // and map.indices have not been modified since entry construction |
| </span><span class="kw">let </span>index = <span class="kw">unsafe </span>{ <span class="self">self</span>.map.indices.remove(<span class="self">self</span>.raw_bucket) }; |
| <span class="self">self</span>.map.shift_remove_finish(index) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="indexmap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
