| <!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| </pre><pre class="rust"><code><span class="comment">// We *mostly* avoid unsafe code, but `map::core::raw` allows it to use `RawTable` buckets. |
| </span><span class="attribute">#![deny(unsafe_code)] |
| #![warn(rust_2018_idioms)] |
| #![doc(html_root_url = <span class="string">"https://docs.rs/indexmap/1/"</span>)] |
| #![no_std] |
| |
| </span><span class="doccomment">//! [`IndexMap`] is a hash table where the iteration order of the key-value |
| //! pairs is independent of the hash values of the keys. |
| //! |
| //! [`IndexSet`] is a corresponding hash set using the same implementation and |
| //! with similar properties. |
| //! |
| //! [`IndexMap`]: map/struct.IndexMap.html |
| //! [`IndexSet`]: set/struct.IndexSet.html |
| //! |
| //! |
| //! ### Feature Highlights |
| //! |
| //! [`IndexMap`] and [`IndexSet`] are drop-in compatible with the std `HashMap` |
| //! and `HashSet`, but they also have some features of note: |
| //! |
| //! - The ordering semantics (see their documentation for details) |
| //! - Sorting methods and the [`.pop()`][IndexMap::pop] methods. |
| //! - The [`Equivalent`] trait, which offers more flexible equality definitions |
| //! between borrowed and owned versions of keys. |
| //! - The [`MutableKeys`][map::MutableKeys] trait, which gives opt-in mutable |
| //! access to hash map keys. |
| //! |
| //! ### Alternate Hashers |
| //! |
| //! [`IndexMap`] and [`IndexSet`] have a default hasher type `S = RandomState`, |
| //! just like the standard `HashMap` and `HashSet`, which is resistant to |
| //! HashDoS attacks but not the most performant. Type aliases can make it easier |
| //! to use alternate hashers: |
| //! |
| //! ``` |
| //! use fnv::FnvBuildHasher; |
| //! use fxhash::FxBuildHasher; |
| //! use indexmap::{IndexMap, IndexSet}; |
| //! |
| //! type FnvIndexMap<K, V> = IndexMap<K, V, FnvBuildHasher>; |
| //! type FnvIndexSet<T> = IndexSet<T, FnvBuildHasher>; |
| //! |
| //! type FxIndexMap<K, V> = IndexMap<K, V, FxBuildHasher>; |
| //! type FxIndexSet<T> = IndexSet<T, FxBuildHasher>; |
| //! |
| //! let std: IndexSet<i32> = (0..100).collect(); |
| //! let fnv: FnvIndexSet<i32> = (0..100).collect(); |
| //! let fx: FxIndexSet<i32> = (0..100).collect(); |
| //! assert_eq!(std, fnv); |
| //! assert_eq!(std, fx); |
| //! ``` |
| //! |
| //! ### Rust Version |
| //! |
| //! This version of indexmap requires Rust 1.56 or later. |
| //! |
| //! The indexmap 1.x release series will use a carefully considered version |
| //! upgrade policy, where in a later 1.x version, we will raise the minimum |
| //! required Rust version. |
| //! |
| //! ## No Standard Library Targets |
| //! |
| //! This crate supports being built without `std`, requiring |
| //! `alloc` instead. This is enabled automatically when it is detected that |
| //! `std` is not available. There is no crate feature to enable/disable to |
| //! trigger this. It can be tested by building for a std-less target. |
| //! |
| //! - Creating maps and sets using [`new`][IndexMap::new] and |
| //! [`with_capacity`][IndexMap::with_capacity] is unavailable without `std`. |
| //! Use methods [`IndexMap::default`][def], |
| //! [`with_hasher`][IndexMap::with_hasher], |
| //! [`with_capacity_and_hasher`][IndexMap::with_capacity_and_hasher] instead. |
| //! A no-std compatible hasher will be needed as well, for example |
| //! from the crate `twox-hash`. |
| //! - Macros [`indexmap!`] and [`indexset!`] are unavailable without `std`. |
| //! |
| //! [def]: map/struct.IndexMap.html#impl-Default |
| |
| </span><span class="kw">extern crate </span>alloc; |
| |
| <span class="attribute">#[cfg(has_std)] |
| #[macro_use] |
| </span><span class="kw">extern crate </span>std; |
| |
| <span class="kw">use </span>alloc::vec::{<span class="self">self</span>, Vec}; |
| |
| <span class="kw">mod </span>arbitrary; |
| <span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>macros; |
| <span class="kw">mod </span>equivalent; |
| <span class="kw">mod </span>mutable_keys; |
| <span class="attribute">#[cfg(feature = <span class="string">"serde"</span>)] |
| </span><span class="kw">mod </span>serde; |
| <span class="attribute">#[cfg(feature = <span class="string">"serde"</span>)] |
| </span><span class="kw">pub mod </span>serde_seq; |
| <span class="kw">mod </span>util; |
| |
| <span class="kw">pub mod </span>map; |
| <span class="kw">pub mod </span>set; |
| |
| <span class="comment">// Placed after `map` and `set` so new `rayon` methods on the types |
| // are documented after the "normal" methods. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"rayon"</span>)] |
| </span><span class="kw">mod </span>rayon; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"rustc-rayon"</span>)] |
| </span><span class="kw">mod </span>rustc; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::equivalent::Equivalent; |
| <span class="kw">pub use </span><span class="kw">crate</span>::map::IndexMap; |
| <span class="kw">pub use </span><span class="kw">crate</span>::set::IndexSet; |
| |
| <span class="comment">// shared private items |
| |
| </span><span class="doccomment">/// Hash value newtype. Not larger than usize, since anything larger |
| /// isn't used for selecting position anyway. |
| </span><span class="attribute">#[derive(Clone, Copy, Debug, PartialEq)] |
| </span><span class="kw">struct </span>HashValue(usize); |
| |
| <span class="kw">impl </span>HashValue { |
| <span class="attribute">#[inline(always)] |
| </span><span class="kw">fn </span>get(<span class="self">self</span>) -> u64 { |
| <span class="self">self</span>.<span class="number">0 </span><span class="kw">as </span>u64 |
| } |
| } |
| |
| <span class="attribute">#[derive(Copy, Debug)] |
| </span><span class="kw">struct </span>Bucket<K, V> { |
| hash: HashValue, |
| key: K, |
| value: V, |
| } |
| |
| <span class="kw">impl</span><K, V> Clone <span class="kw">for </span>Bucket<K, V> |
| <span class="kw">where |
| </span>K: Clone, |
| V: Clone, |
| { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| Bucket { |
| hash: <span class="self">self</span>.hash, |
| key: <span class="self">self</span>.key.clone(), |
| value: <span class="self">self</span>.value.clone(), |
| } |
| } |
| |
| <span class="kw">fn </span>clone_from(<span class="kw-2">&mut </span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) { |
| <span class="self">self</span>.hash = other.hash; |
| <span class="self">self</span>.key.clone_from(<span class="kw-2">&</span>other.key); |
| <span class="self">self</span>.value.clone_from(<span class="kw-2">&</span>other.value); |
| } |
| } |
| |
| <span class="kw">impl</span><K, V> Bucket<K, V> { |
| <span class="comment">// field accessors -- used for `f` instead of closures in `.map(f)` |
| </span><span class="kw">fn </span>key_ref(<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>.key |
| } |
| <span class="kw">fn </span>value_ref(<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>.value |
| } |
| <span class="kw">fn </span>value_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>V { |
| <span class="kw-2">&mut </span><span class="self">self</span>.value |
| } |
| <span class="kw">fn </span>key(<span class="self">self</span>) -> K { |
| <span class="self">self</span>.key |
| } |
| <span class="kw">fn </span>value(<span class="self">self</span>) -> V { |
| <span class="self">self</span>.value |
| } |
| <span class="kw">fn </span>key_value(<span class="self">self</span>) -> (K, V) { |
| (<span class="self">self</span>.key, <span class="self">self</span>.value) |
| } |
| <span class="kw">fn </span>refs(<span class="kw-2">&</span><span class="self">self</span>) -> (<span class="kw-2">&</span>K, <span class="kw-2">&</span>V) { |
| (<span class="kw-2">&</span><span class="self">self</span>.key, <span class="kw-2">&</span><span class="self">self</span>.value) |
| } |
| <span class="kw">fn </span>ref_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> (<span class="kw-2">&</span>K, <span class="kw-2">&mut </span>V) { |
| (<span class="kw-2">&</span><span class="self">self</span>.key, <span class="kw-2">&mut </span><span class="self">self</span>.value) |
| } |
| <span class="kw">fn </span>muts(<span class="kw-2">&mut </span><span class="self">self</span>) -> (<span class="kw-2">&mut </span>K, <span class="kw-2">&mut </span>V) { |
| (<span class="kw-2">&mut </span><span class="self">self</span>.key, <span class="kw-2">&mut </span><span class="self">self</span>.value) |
| } |
| } |
| |
| <span class="kw">trait </span>Entries { |
| <span class="kw">type </span>Entry; |
| <span class="kw">fn </span>into_entries(<span class="self">self</span>) -> Vec<<span class="self">Self</span>::Entry>; |
| <span class="kw">fn </span>as_entries(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[<span class="self">Self</span>::Entry]; |
| <span class="kw">fn </span>as_entries_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>[<span class="self">Self</span>::Entry]; |
| <span class="kw">fn </span>with_entries<F>(<span class="kw-2">&mut </span><span class="self">self</span>, f: F) |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&mut </span>[<span class="self">Self</span>::Entry]); |
| } |
| </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> |
