| <!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 `lib/la-arena/src/map.rs`."><title>map.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="la_arena" data-themes="" data-resource-suffix="" data-rustdoc-version="1.91.1 (ed61e7d7e 2025-11-07)" data-channel="1.91.1" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">la_arena/</div>map.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::iter::Enumerate; |
| <a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::marker::PhantomData; |
| <a href=#3 id=3 data-nosnippet>3</a> |
| <a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span><span class="kw">crate</span>::Idx; |
| <a href=#5 id=5 data-nosnippet>5</a> |
| <a href=#6 id=6 data-nosnippet>6</a><span class="doccomment">/// A map from arena indexes to some other type. |
| <a href=#7 id=7 data-nosnippet>7</a>/// Space requirement is O(highest index). |
| <a href=#8 id=8 data-nosnippet>8</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] |
| <a href=#9 id=9 data-nosnippet>9</a></span><span class="kw">pub struct </span>ArenaMap<IDX, V> { |
| <a href=#10 id=10 data-nosnippet>10</a> v: Vec<<span class="prelude-ty">Option</span><V>>, |
| <a href=#11 id=11 data-nosnippet>11</a> _ty: PhantomData<IDX>, |
| <a href=#12 id=12 data-nosnippet>12</a>} |
| <a href=#13 id=13 data-nosnippet>13</a> |
| <a href=#14 id=14 data-nosnippet>14</a><span class="kw">impl</span><T, V> ArenaMap<Idx<T>, V> { |
| <a href=#15 id=15 data-nosnippet>15</a> <span class="doccomment">/// Creates a new empty map. |
| <a href=#16 id=16 data-nosnippet>16</a> </span><span class="kw">pub const fn </span>new() -> <span class="self">Self </span>{ |
| <a href=#17 id=17 data-nosnippet>17</a> <span class="self">Self </span>{ v: Vec::new(), _ty: PhantomData } |
| <a href=#18 id=18 data-nosnippet>18</a> } |
| <a href=#19 id=19 data-nosnippet>19</a> |
| <a href=#20 id=20 data-nosnippet>20</a> <span class="doccomment">/// Create a new empty map with specific capacity. |
| <a href=#21 id=21 data-nosnippet>21</a> </span><span class="kw">pub fn </span>with_capacity(capacity: usize) -> <span class="self">Self </span>{ |
| <a href=#22 id=22 data-nosnippet>22</a> <span class="self">Self </span>{ v: Vec::with_capacity(capacity), _ty: PhantomData } |
| <a href=#23 id=23 data-nosnippet>23</a> } |
| <a href=#24 id=24 data-nosnippet>24</a> |
| <a href=#25 id=25 data-nosnippet>25</a> <span class="doccomment">/// Reserves capacity for at least additional more elements to be inserted in the map. |
| <a href=#26 id=26 data-nosnippet>26</a> </span><span class="kw">pub fn </span>reserve(<span class="kw-2">&mut </span><span class="self">self</span>, additional: usize) { |
| <a href=#27 id=27 data-nosnippet>27</a> <span class="self">self</span>.v.reserve(additional); |
| <a href=#28 id=28 data-nosnippet>28</a> } |
| <a href=#29 id=29 data-nosnippet>29</a> |
| <a href=#30 id=30 data-nosnippet>30</a> <span class="doccomment">/// Clears the map, removing all elements. |
| <a href=#31 id=31 data-nosnippet>31</a> </span><span class="kw">pub fn </span>clear(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#32 id=32 data-nosnippet>32</a> <span class="self">self</span>.v.clear(); |
| <a href=#33 id=33 data-nosnippet>33</a> } |
| <a href=#34 id=34 data-nosnippet>34</a> |
| <a href=#35 id=35 data-nosnippet>35</a> <span class="doccomment">/// Shrinks the capacity of the map as much as possible. |
| <a href=#36 id=36 data-nosnippet>36</a> </span><span class="kw">pub fn </span>shrink_to_fit(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#37 id=37 data-nosnippet>37</a> <span class="kw">let </span>min_len = <span class="self">self</span>.v.iter().rposition(|slot| slot.is_some()).map_or(<span class="number">0</span>, |i| i + <span class="number">1</span>); |
| <a href=#38 id=38 data-nosnippet>38</a> <span class="self">self</span>.v.truncate(min_len); |
| <a href=#39 id=39 data-nosnippet>39</a> <span class="self">self</span>.v.shrink_to_fit(); |
| <a href=#40 id=40 data-nosnippet>40</a> } |
| <a href=#41 id=41 data-nosnippet>41</a> |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="doccomment">/// Returns whether the map contains a value for the specified index. |
| <a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">pub fn </span>contains_idx(<span class="kw-2">&</span><span class="self">self</span>, idx: Idx<T>) -> bool { |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="macro">matches!</span>(<span class="self">self</span>.v.get(<span class="self">Self</span>::to_idx(idx)), <span class="prelude-val">Some</span>(<span class="prelude-val">Some</span>(<span class="kw">_</span>))) |
| <a href=#45 id=45 data-nosnippet>45</a> } |
| <a href=#46 id=46 data-nosnippet>46</a> |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="doccomment">/// Removes an index from the map, returning the value at the index if the index was previously in the map. |
| <a href=#48 id=48 data-nosnippet>48</a> </span><span class="kw">pub fn </span>remove(<span class="kw-2">&mut </span><span class="self">self</span>, idx: Idx<T>) -> <span class="prelude-ty">Option</span><V> { |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="self">self</span>.v.get_mut(<span class="self">Self</span>::to_idx(idx))<span class="question-mark">?</span>.take() |
| <a href=#50 id=50 data-nosnippet>50</a> } |
| <a href=#51 id=51 data-nosnippet>51</a> |
| <a href=#52 id=52 data-nosnippet>52</a> <span class="doccomment">/// Inserts a value associated with a given arena index into the map. |
| <a href=#53 id=53 data-nosnippet>53</a> /// |
| <a href=#54 id=54 data-nosnippet>54</a> /// If the map did not have this index present, None is returned. |
| <a href=#55 id=55 data-nosnippet>55</a> /// Otherwise, the value is updated, and the old value is returned. |
| <a href=#56 id=56 data-nosnippet>56</a> </span><span class="kw">pub fn </span>insert(<span class="kw-2">&mut </span><span class="self">self</span>, idx: Idx<T>, t: V) -> <span class="prelude-ty">Option</span><V> { |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="kw">let </span>idx = <span class="self">Self</span>::to_idx(idx); |
| <a href=#58 id=58 data-nosnippet>58</a> |
| <a href=#59 id=59 data-nosnippet>59</a> <span class="self">self</span>.v.resize_with((idx + <span class="number">1</span>).max(<span class="self">self</span>.v.len()), || <span class="prelude-val">None</span>); |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="self">self</span>.v[idx].replace(t) |
| <a href=#61 id=61 data-nosnippet>61</a> } |
| <a href=#62 id=62 data-nosnippet>62</a> |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="doccomment">/// Returns a reference to the value associated with the provided index |
| <a href=#64 id=64 data-nosnippet>64</a> /// if it is present. |
| <a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">pub fn </span>get(<span class="kw-2">&</span><span class="self">self</span>, idx: Idx<T>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>V> { |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="self">self</span>.v.get(<span class="self">Self</span>::to_idx(idx)).and_then(|it| it.as_ref()) |
| <a href=#67 id=67 data-nosnippet>67</a> } |
| <a href=#68 id=68 data-nosnippet>68</a> |
| <a href=#69 id=69 data-nosnippet>69</a> <span class="doccomment">/// Returns a mutable reference to the value associated with the provided index |
| <a href=#70 id=70 data-nosnippet>70</a> /// if it is present. |
| <a href=#71 id=71 data-nosnippet>71</a> </span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>, idx: Idx<T>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&mut </span>V> { |
| <a href=#72 id=72 data-nosnippet>72</a> <span class="self">self</span>.v.get_mut(<span class="self">Self</span>::to_idx(idx)).and_then(|it| it.as_mut()) |
| <a href=#73 id=73 data-nosnippet>73</a> } |
| <a href=#74 id=74 data-nosnippet>74</a> |
| <a href=#75 id=75 data-nosnippet>75</a> <span class="doccomment">/// Returns an iterator over the values in the map. |
| <a href=#76 id=76 data-nosnippet>76</a> </span><span class="kw">pub fn </span>values(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl </span>DoubleEndedIterator<Item = <span class="kw-2">&</span>V> { |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="self">self</span>.v.iter().filter_map(|o| o.as_ref()) |
| <a href=#78 id=78 data-nosnippet>78</a> } |
| <a href=#79 id=79 data-nosnippet>79</a> |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="doccomment">/// Returns an iterator over mutable references to the values in the map. |
| <a href=#81 id=81 data-nosnippet>81</a> </span><span class="kw">pub fn </span>values_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw">impl </span>DoubleEndedIterator<Item = <span class="kw-2">&mut </span>V> { |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="self">self</span>.v.iter_mut().filter_map(|o| o.as_mut()) |
| <a href=#83 id=83 data-nosnippet>83</a> } |
| <a href=#84 id=84 data-nosnippet>84</a> |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="doccomment">/// Returns an iterator over the arena indexes and values in the map. |
| <a href=#86 id=86 data-nosnippet>86</a> </span><span class="kw">pub fn </span>iter(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl </span>DoubleEndedIterator<Item = (Idx<T>, <span class="kw-2">&</span>V)> { |
| <a href=#87 id=87 data-nosnippet>87</a> <span class="self">self</span>.v.iter().enumerate().filter_map(|(idx, o)| <span class="prelude-val">Some</span>((<span class="self">Self</span>::from_idx(idx), o.as_ref()<span class="question-mark">?</span>))) |
| <a href=#88 id=88 data-nosnippet>88</a> } |
| <a href=#89 id=89 data-nosnippet>89</a> |
| <a href=#90 id=90 data-nosnippet>90</a> <span class="doccomment">/// Returns an iterator over the arena indexes and values in the map. |
| <a href=#91 id=91 data-nosnippet>91</a> </span><span class="kw">pub fn </span>iter_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw">impl </span>Iterator<Item = (Idx<T>, <span class="kw-2">&mut </span>V)> { |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="self">self</span>.v |
| <a href=#93 id=93 data-nosnippet>93</a> .iter_mut() |
| <a href=#94 id=94 data-nosnippet>94</a> .enumerate() |
| <a href=#95 id=95 data-nosnippet>95</a> .filter_map(|(idx, o)| <span class="prelude-val">Some</span>((<span class="self">Self</span>::from_idx(idx), o.as_mut()<span class="question-mark">?</span>))) |
| <a href=#96 id=96 data-nosnippet>96</a> } |
| <a href=#97 id=97 data-nosnippet>97</a> |
| <a href=#98 id=98 data-nosnippet>98</a> <span class="doccomment">/// Gets the given key's corresponding entry in the map for in-place manipulation. |
| <a href=#99 id=99 data-nosnippet>99</a> </span><span class="kw">pub fn </span>entry(<span class="kw-2">&mut </span><span class="self">self</span>, idx: Idx<T>) -> Entry<<span class="lifetime">'_</span>, Idx<T>, V> { |
| <a href=#100 id=100 data-nosnippet>100</a> <span class="kw">let </span>idx = <span class="self">Self</span>::to_idx(idx); |
| <a href=#101 id=101 data-nosnippet>101</a> <span class="self">self</span>.v.resize_with((idx + <span class="number">1</span>).max(<span class="self">self</span>.v.len()), || <span class="prelude-val">None</span>); |
| <a href=#102 id=102 data-nosnippet>102</a> <span class="kw">match </span><span class="kw-2">&mut </span><span class="self">self</span>.v[idx] { |
| <a href=#103 id=103 data-nosnippet>103</a> slot @ <span class="prelude-val">Some</span>(<span class="kw">_</span>) => Entry::Occupied(OccupiedEntry { slot, _ty: PhantomData }), |
| <a href=#104 id=104 data-nosnippet>104</a> slot @ <span class="prelude-val">None </span>=> Entry::Vacant(VacantEntry { slot, _ty: PhantomData }), |
| <a href=#105 id=105 data-nosnippet>105</a> } |
| <a href=#106 id=106 data-nosnippet>106</a> } |
| <a href=#107 id=107 data-nosnippet>107</a> |
| <a href=#108 id=108 data-nosnippet>108</a> <span class="kw">fn </span>to_idx(idx: Idx<T>) -> usize { |
| <a href=#109 id=109 data-nosnippet>109</a> u32::from(idx.into_raw()) <span class="kw">as </span>usize |
| <a href=#110 id=110 data-nosnippet>110</a> } |
| <a href=#111 id=111 data-nosnippet>111</a> |
| <a href=#112 id=112 data-nosnippet>112</a> <span class="kw">fn </span>from_idx(idx: usize) -> Idx<T> { |
| <a href=#113 id=113 data-nosnippet>113</a> Idx::from_raw((idx <span class="kw">as </span>u32).into()) |
| <a href=#114 id=114 data-nosnippet>114</a> } |
| <a href=#115 id=115 data-nosnippet>115</a>} |
| <a href=#116 id=116 data-nosnippet>116</a> |
| <a href=#117 id=117 data-nosnippet>117</a><span class="kw">impl</span><T, V> std::ops::Index<Idx<V>> <span class="kw">for </span>ArenaMap<Idx<V>, T> { |
| <a href=#118 id=118 data-nosnippet>118</a> <span class="kw">type </span>Output = T; |
| <a href=#119 id=119 data-nosnippet>119</a> <span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>, idx: Idx<V>) -> <span class="kw-2">&</span>T { |
| <a href=#120 id=120 data-nosnippet>120</a> <span class="self">self</span>.v[<span class="self">Self</span>::to_idx(idx)].as_ref().unwrap() |
| <a href=#121 id=121 data-nosnippet>121</a> } |
| <a href=#122 id=122 data-nosnippet>122</a>} |
| <a href=#123 id=123 data-nosnippet>123</a> |
| <a href=#124 id=124 data-nosnippet>124</a><span class="kw">impl</span><T, V> std::ops::IndexMut<Idx<V>> <span class="kw">for </span>ArenaMap<Idx<V>, T> { |
| <a href=#125 id=125 data-nosnippet>125</a> <span class="kw">fn </span>index_mut(<span class="kw-2">&mut </span><span class="self">self</span>, idx: Idx<V>) -> <span class="kw-2">&mut </span>T { |
| <a href=#126 id=126 data-nosnippet>126</a> <span class="self">self</span>.v[<span class="self">Self</span>::to_idx(idx)].as_mut().unwrap() |
| <a href=#127 id=127 data-nosnippet>127</a> } |
| <a href=#128 id=128 data-nosnippet>128</a>} |
| <a href=#129 id=129 data-nosnippet>129</a> |
| <a href=#130 id=130 data-nosnippet>130</a><span class="kw">impl</span><T, V> Default <span class="kw">for </span>ArenaMap<Idx<V>, T> { |
| <a href=#131 id=131 data-nosnippet>131</a> <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <a href=#132 id=132 data-nosnippet>132</a> <span class="self">Self</span>::new() |
| <a href=#133 id=133 data-nosnippet>133</a> } |
| <a href=#134 id=134 data-nosnippet>134</a>} |
| <a href=#135 id=135 data-nosnippet>135</a> |
| <a href=#136 id=136 data-nosnippet>136</a><span class="kw">impl</span><T, V> Extend<(Idx<V>, T)> <span class="kw">for </span>ArenaMap<Idx<V>, T> { |
| <a href=#137 id=137 data-nosnippet>137</a> <span class="kw">fn </span>extend<I: IntoIterator<Item = (Idx<V>, T)>>(<span class="kw-2">&mut </span><span class="self">self</span>, iter: I) { |
| <a href=#138 id=138 data-nosnippet>138</a> iter.into_iter().for_each(<span class="kw">move </span>|(k, v)| { |
| <a href=#139 id=139 data-nosnippet>139</a> <span class="self">self</span>.insert(k, v); |
| <a href=#140 id=140 data-nosnippet>140</a> }); |
| <a href=#141 id=141 data-nosnippet>141</a> } |
| <a href=#142 id=142 data-nosnippet>142</a>} |
| <a href=#143 id=143 data-nosnippet>143</a> |
| <a href=#144 id=144 data-nosnippet>144</a><span class="kw">impl</span><T, V> FromIterator<(Idx<V>, T)> <span class="kw">for </span>ArenaMap<Idx<V>, T> { |
| <a href=#145 id=145 data-nosnippet>145</a> <span class="kw">fn </span>from_iter<I: IntoIterator<Item = (Idx<V>, T)>>(iter: I) -> <span class="self">Self </span>{ |
| <a href=#146 id=146 data-nosnippet>146</a> <span class="kw">let </span><span class="kw-2">mut </span>this = <span class="self">Self</span>::new(); |
| <a href=#147 id=147 data-nosnippet>147</a> this.extend(iter); |
| <a href=#148 id=148 data-nosnippet>148</a> this |
| <a href=#149 id=149 data-nosnippet>149</a> } |
| <a href=#150 id=150 data-nosnippet>150</a>} |
| <a href=#151 id=151 data-nosnippet>151</a> |
| <a href=#152 id=152 data-nosnippet>152</a><span class="kw">pub struct </span>ArenaMapIter<IDX, V> { |
| <a href=#153 id=153 data-nosnippet>153</a> iter: Enumerate<std::vec::IntoIter<<span class="prelude-ty">Option</span><V>>>, |
| <a href=#154 id=154 data-nosnippet>154</a> _ty: PhantomData<IDX>, |
| <a href=#155 id=155 data-nosnippet>155</a>} |
| <a href=#156 id=156 data-nosnippet>156</a> |
| <a href=#157 id=157 data-nosnippet>157</a><span class="kw">impl</span><T, V> IntoIterator <span class="kw">for </span>ArenaMap<Idx<T>, V> { |
| <a href=#158 id=158 data-nosnippet>158</a> <span class="kw">type </span>Item = (Idx<T>, V); |
| <a href=#159 id=159 data-nosnippet>159</a> |
| <a href=#160 id=160 data-nosnippet>160</a> <span class="kw">type </span>IntoIter = ArenaMapIter<Idx<T>, V>; |
| <a href=#161 id=161 data-nosnippet>161</a> |
| <a href=#162 id=162 data-nosnippet>162</a> <span class="kw">fn </span>into_iter(<span class="self">self</span>) -> <span class="self">Self</span>::IntoIter { |
| <a href=#163 id=163 data-nosnippet>163</a> <span class="kw">let </span>iter = <span class="self">self</span>.v.into_iter().enumerate(); |
| <a href=#164 id=164 data-nosnippet>164</a> <span class="self">Self</span>::IntoIter { iter, _ty: PhantomData } |
| <a href=#165 id=165 data-nosnippet>165</a> } |
| <a href=#166 id=166 data-nosnippet>166</a>} |
| <a href=#167 id=167 data-nosnippet>167</a> |
| <a href=#168 id=168 data-nosnippet>168</a><span class="kw">impl</span><T, V> ArenaMapIter<Idx<T>, V> { |
| <a href=#169 id=169 data-nosnippet>169</a> <span class="kw">fn </span>mapper((idx, o): (usize, <span class="prelude-ty">Option</span><V>)) -> <span class="prelude-ty">Option</span><(Idx<T>, V)> { |
| <a href=#170 id=170 data-nosnippet>170</a> <span class="prelude-val">Some</span>((ArenaMap::<Idx<T>, V>::from_idx(idx), o<span class="question-mark">?</span>)) |
| <a href=#171 id=171 data-nosnippet>171</a> } |
| <a href=#172 id=172 data-nosnippet>172</a>} |
| <a href=#173 id=173 data-nosnippet>173</a> |
| <a href=#174 id=174 data-nosnippet>174</a><span class="kw">impl</span><T, V> Iterator <span class="kw">for </span>ArenaMapIter<Idx<T>, V> { |
| <a href=#175 id=175 data-nosnippet>175</a> <span class="kw">type </span>Item = (Idx<T>, V); |
| <a href=#176 id=176 data-nosnippet>176</a> |
| <a href=#177 id=177 data-nosnippet>177</a> <span class="attr">#[inline] |
| <a href=#178 id=178 data-nosnippet>178</a> </span><span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <a href=#179 id=179 data-nosnippet>179</a> <span class="kw">for </span>next <span class="kw">in </span><span class="self">self</span>.iter.by_ref() { |
| <a href=#180 id=180 data-nosnippet>180</a> <span class="kw">match </span><span class="self">Self</span>::mapper(next) { |
| <a href=#181 id=181 data-nosnippet>181</a> <span class="prelude-val">Some</span>(r) => <span class="kw">return </span><span class="prelude-val">Some</span>(r), |
| <a href=#182 id=182 data-nosnippet>182</a> <span class="prelude-val">None </span>=> <span class="kw">continue</span>, |
| <a href=#183 id=183 data-nosnippet>183</a> } |
| <a href=#184 id=184 data-nosnippet>184</a> } |
| <a href=#185 id=185 data-nosnippet>185</a> |
| <a href=#186 id=186 data-nosnippet>186</a> <span class="prelude-val">None |
| <a href=#187 id=187 data-nosnippet>187</a> </span>} |
| <a href=#188 id=188 data-nosnippet>188</a> |
| <a href=#189 id=189 data-nosnippet>189</a> <span class="attr">#[inline] |
| <a href=#190 id=190 data-nosnippet>190</a> </span><span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) { |
| <a href=#191 id=191 data-nosnippet>191</a> <span class="self">self</span>.iter.size_hint() |
| <a href=#192 id=192 data-nosnippet>192</a> } |
| <a href=#193 id=193 data-nosnippet>193</a>} |
| <a href=#194 id=194 data-nosnippet>194</a> |
| <a href=#195 id=195 data-nosnippet>195</a><span class="kw">impl</span><T, V> DoubleEndedIterator <span class="kw">for </span>ArenaMapIter<Idx<T>, V> { |
| <a href=#196 id=196 data-nosnippet>196</a> <span class="attr">#[inline] |
| <a href=#197 id=197 data-nosnippet>197</a> </span><span class="kw">fn </span>next_back(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <a href=#198 id=198 data-nosnippet>198</a> <span class="kw">while let </span><span class="prelude-val">Some</span>(next_back) = <span class="self">self</span>.iter.next_back() { |
| <a href=#199 id=199 data-nosnippet>199</a> <span class="kw">match </span><span class="self">Self</span>::mapper(next_back) { |
| <a href=#200 id=200 data-nosnippet>200</a> <span class="prelude-val">Some</span>(r) => <span class="kw">return </span><span class="prelude-val">Some</span>(r), |
| <a href=#201 id=201 data-nosnippet>201</a> <span class="prelude-val">None </span>=> <span class="kw">continue</span>, |
| <a href=#202 id=202 data-nosnippet>202</a> } |
| <a href=#203 id=203 data-nosnippet>203</a> } |
| <a href=#204 id=204 data-nosnippet>204</a> |
| <a href=#205 id=205 data-nosnippet>205</a> <span class="prelude-val">None |
| <a href=#206 id=206 data-nosnippet>206</a> </span>} |
| <a href=#207 id=207 data-nosnippet>207</a>} |
| <a href=#208 id=208 data-nosnippet>208</a> |
| <a href=#209 id=209 data-nosnippet>209</a><span class="doccomment">/// A view into a single entry in a map, which may either be vacant or occupied. |
| <a href=#210 id=210 data-nosnippet>210</a>/// |
| <a href=#211 id=211 data-nosnippet>211</a>/// This `enum` is constructed from the [`entry`] method on [`ArenaMap`]. |
| <a href=#212 id=212 data-nosnippet>212</a>/// |
| <a href=#213 id=213 data-nosnippet>213</a>/// [`entry`]: ArenaMap::entry |
| <a href=#214 id=214 data-nosnippet>214</a></span><span class="kw">pub enum </span>Entry<<span class="lifetime">'a</span>, IDX, V> { |
| <a href=#215 id=215 data-nosnippet>215</a> <span class="doccomment">/// A vacant entry. |
| <a href=#216 id=216 data-nosnippet>216</a> </span>Vacant(VacantEntry<<span class="lifetime">'a</span>, IDX, V>), |
| <a href=#217 id=217 data-nosnippet>217</a> <span class="doccomment">/// An occupied entry. |
| <a href=#218 id=218 data-nosnippet>218</a> </span>Occupied(OccupiedEntry<<span class="lifetime">'a</span>, IDX, V>), |
| <a href=#219 id=219 data-nosnippet>219</a>} |
| <a href=#220 id=220 data-nosnippet>220</a> |
| <a href=#221 id=221 data-nosnippet>221</a><span class="kw">impl</span><<span class="lifetime">'a</span>, IDX, V> Entry<<span class="lifetime">'a</span>, IDX, V> { |
| <a href=#222 id=222 data-nosnippet>222</a> <span class="doccomment">/// Ensures a value is in the entry by inserting the default if empty, and returns a mutable reference to |
| <a href=#223 id=223 data-nosnippet>223</a> /// the value in the entry. |
| <a href=#224 id=224 data-nosnippet>224</a> </span><span class="kw">pub fn </span>or_insert(<span class="self">self</span>, default: V) -> <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>V { |
| <a href=#225 id=225 data-nosnippet>225</a> <span class="kw">match </span><span class="self">self </span>{ |
| <a href=#226 id=226 data-nosnippet>226</a> <span class="self">Self</span>::Vacant(ent) => ent.insert(default), |
| <a href=#227 id=227 data-nosnippet>227</a> <span class="self">Self</span>::Occupied(ent) => ent.into_mut(), |
| <a href=#228 id=228 data-nosnippet>228</a> } |
| <a href=#229 id=229 data-nosnippet>229</a> } |
| <a href=#230 id=230 data-nosnippet>230</a> |
| <a href=#231 id=231 data-nosnippet>231</a> <span class="doccomment">/// Ensures a value is in the entry by inserting the result of the default function if empty, and returns |
| <a href=#232 id=232 data-nosnippet>232</a> /// a mutable reference to the value in the entry. |
| <a href=#233 id=233 data-nosnippet>233</a> </span><span class="kw">pub fn </span>or_insert_with<F: FnOnce() -> V>(<span class="self">self</span>, default: F) -> <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>V { |
| <a href=#234 id=234 data-nosnippet>234</a> <span class="kw">match </span><span class="self">self </span>{ |
| <a href=#235 id=235 data-nosnippet>235</a> <span class="self">Self</span>::Vacant(ent) => ent.insert(default()), |
| <a href=#236 id=236 data-nosnippet>236</a> <span class="self">Self</span>::Occupied(ent) => ent.into_mut(), |
| <a href=#237 id=237 data-nosnippet>237</a> } |
| <a href=#238 id=238 data-nosnippet>238</a> } |
| <a href=#239 id=239 data-nosnippet>239</a> |
| <a href=#240 id=240 data-nosnippet>240</a> <span class="doccomment">/// Provides in-place mutable access to an occupied entry before any potential inserts into the map. |
| <a href=#241 id=241 data-nosnippet>241</a> </span><span class="kw">pub fn </span>and_modify<F: FnOnce(<span class="kw-2">&mut </span>V)>(<span class="kw-2">mut </span><span class="self">self</span>, f: F) -> <span class="self">Self </span>{ |
| <a href=#242 id=242 data-nosnippet>242</a> <span class="kw">if let </span><span class="self">Self</span>::Occupied(ent) = <span class="kw-2">&mut </span><span class="self">self </span>{ |
| <a href=#243 id=243 data-nosnippet>243</a> f(ent.get_mut()); |
| <a href=#244 id=244 data-nosnippet>244</a> } |
| <a href=#245 id=245 data-nosnippet>245</a> <span class="self">self |
| <a href=#246 id=246 data-nosnippet>246</a> </span>} |
| <a href=#247 id=247 data-nosnippet>247</a>} |
| <a href=#248 id=248 data-nosnippet>248</a> |
| <a href=#249 id=249 data-nosnippet>249</a><span class="kw">impl</span><<span class="lifetime">'a</span>, IDX, V> Entry<<span class="lifetime">'a</span>, IDX, V> |
| <a href=#250 id=250 data-nosnippet>250</a><span class="kw">where |
| <a href=#251 id=251 data-nosnippet>251</a> </span>V: Default, |
| <a href=#252 id=252 data-nosnippet>252</a>{ |
| <a href=#253 id=253 data-nosnippet>253</a> <span class="doccomment">/// Ensures a value is in the entry by inserting the default value if empty, and returns a mutable reference |
| <a href=#254 id=254 data-nosnippet>254</a> /// to the value in the entry. |
| <a href=#255 id=255 data-nosnippet>255</a> </span><span class="comment">// BUG this clippy lint is a false positive |
| <a href=#256 id=256 data-nosnippet>256</a> </span><span class="attr">#[allow(clippy::unwrap_or_default)] |
| <a href=#257 id=257 data-nosnippet>257</a> </span><span class="kw">pub fn </span>or_default(<span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>V { |
| <a href=#258 id=258 data-nosnippet>258</a> <span class="self">self</span>.or_insert_with(Default::default) |
| <a href=#259 id=259 data-nosnippet>259</a> } |
| <a href=#260 id=260 data-nosnippet>260</a>} |
| <a href=#261 id=261 data-nosnippet>261</a> |
| <a href=#262 id=262 data-nosnippet>262</a><span class="doccomment">/// A view into an vacant entry in a [`ArenaMap`]. It is part of the [`Entry`] enum. |
| <a href=#263 id=263 data-nosnippet>263</a></span><span class="kw">pub struct </span>VacantEntry<<span class="lifetime">'a</span>, IDX, V> { |
| <a href=#264 id=264 data-nosnippet>264</a> slot: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="prelude-ty">Option</span><V>, |
| <a href=#265 id=265 data-nosnippet>265</a> _ty: PhantomData<IDX>, |
| <a href=#266 id=266 data-nosnippet>266</a>} |
| <a href=#267 id=267 data-nosnippet>267</a> |
| <a href=#268 id=268 data-nosnippet>268</a><span class="kw">impl</span><<span class="lifetime">'a</span>, IDX, V> VacantEntry<<span class="lifetime">'a</span>, IDX, V> { |
| <a href=#269 id=269 data-nosnippet>269</a> <span class="doccomment">/// Sets the value of the entry with the `VacantEntry`’s key, and returns a mutable reference to it. |
| <a href=#270 id=270 data-nosnippet>270</a> </span><span class="kw">pub fn </span>insert(<span class="self">self</span>, value: V) -> <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>V { |
| <a href=#271 id=271 data-nosnippet>271</a> <span class="self">self</span>.slot.insert(value) |
| <a href=#272 id=272 data-nosnippet>272</a> } |
| <a href=#273 id=273 data-nosnippet>273</a>} |
| <a href=#274 id=274 data-nosnippet>274</a> |
| <a href=#275 id=275 data-nosnippet>275</a><span class="doccomment">/// A view into an occupied entry in a [`ArenaMap`]. It is part of the [`Entry`] enum. |
| <a href=#276 id=276 data-nosnippet>276</a></span><span class="kw">pub struct </span>OccupiedEntry<<span class="lifetime">'a</span>, IDX, V> { |
| <a href=#277 id=277 data-nosnippet>277</a> slot: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="prelude-ty">Option</span><V>, |
| <a href=#278 id=278 data-nosnippet>278</a> _ty: PhantomData<IDX>, |
| <a href=#279 id=279 data-nosnippet>279</a>} |
| <a href=#280 id=280 data-nosnippet>280</a> |
| <a href=#281 id=281 data-nosnippet>281</a><span class="kw">impl</span><<span class="lifetime">'a</span>, IDX, V> OccupiedEntry<<span class="lifetime">'a</span>, IDX, V> { |
| <a href=#282 id=282 data-nosnippet>282</a> <span class="doccomment">/// Gets a reference to the value in the entry. |
| <a href=#283 id=283 data-nosnippet>283</a> </span><span class="kw">pub fn </span>get(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>V { |
| <a href=#284 id=284 data-nosnippet>284</a> <span class="self">self</span>.slot.as_ref().expect(<span class="string">"Occupied"</span>) |
| <a href=#285 id=285 data-nosnippet>285</a> } |
| <a href=#286 id=286 data-nosnippet>286</a> |
| <a href=#287 id=287 data-nosnippet>287</a> <span class="doccomment">/// Gets a mutable reference to the value in the entry. |
| <a href=#288 id=288 data-nosnippet>288</a> </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 { |
| <a href=#289 id=289 data-nosnippet>289</a> <span class="self">self</span>.slot.as_mut().expect(<span class="string">"Occupied"</span>) |
| <a href=#290 id=290 data-nosnippet>290</a> } |
| <a href=#291 id=291 data-nosnippet>291</a> |
| <a href=#292 id=292 data-nosnippet>292</a> <span class="doccomment">/// Converts the entry into a mutable reference to its value. |
| <a href=#293 id=293 data-nosnippet>293</a> </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 { |
| <a href=#294 id=294 data-nosnippet>294</a> <span class="self">self</span>.slot.as_mut().expect(<span class="string">"Occupied"</span>) |
| <a href=#295 id=295 data-nosnippet>295</a> } |
| <a href=#296 id=296 data-nosnippet>296</a> |
| <a href=#297 id=297 data-nosnippet>297</a> <span class="doccomment">/// Sets the value of the entry with the `OccupiedEntry`’s key, and returns the entry’s old value. |
| <a href=#298 id=298 data-nosnippet>298</a> </span><span class="kw">pub fn </span>insert(<span class="kw-2">&mut </span><span class="self">self</span>, value: V) -> V { |
| <a href=#299 id=299 data-nosnippet>299</a> <span class="self">self</span>.slot.replace(value).expect(<span class="string">"Occupied"</span>) |
| <a href=#300 id=300 data-nosnippet>300</a> } |
| <a href=#301 id=301 data-nosnippet>301</a> |
| <a href=#302 id=302 data-nosnippet>302</a> <span class="doccomment">/// Takes the value of the entry out of the map, and returns it. |
| <a href=#303 id=303 data-nosnippet>303</a> </span><span class="kw">pub fn </span>remove(<span class="self">self</span>) -> V { |
| <a href=#304 id=304 data-nosnippet>304</a> <span class="self">self</span>.slot.take().expect(<span class="string">"Occupied"</span>) |
| <a href=#305 id=305 data-nosnippet>305</a> } |
| <a href=#306 id=306 data-nosnippet>306</a>}</code></pre></div></section></main></body></html> |
