| <!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 `crates/intern/src/intern.rs`."><title>intern.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-77263533.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="intern" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.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-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-ffcac47a.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">intern/</div>intern.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="doccomment">//! Interning of single values. |
| <a href=#2 id=2 data-nosnippet>2</a>//! |
| <a href=#3 id=3 data-nosnippet>3</a>//! Interning supports two modes: GC and non-GC. |
| <a href=#4 id=4 data-nosnippet>4</a>//! |
| <a href=#5 id=5 data-nosnippet>5</a>//! In non-GC mode, you create [`Interned`]s, and can create `Copy` handles to them |
| <a href=#6 id=6 data-nosnippet>6</a>//! that can still be upgraded back to [`Interned`] ([`InternedRef`]) via [`Interned::as_ref`]. |
| <a href=#7 id=7 data-nosnippet>7</a>//! Generally, letting the [`InternedRef`] to outlive the [`Interned`] is a soundness bug and can |
| <a href=#8 id=8 data-nosnippet>8</a>//! lead to UB. When all [`Interned`]s of some value are dropped, the value is freed (newer interns |
| <a href=#9 id=9 data-nosnippet>9</a>//! may re-create it, not necessarily in the same place). |
| <a href=#10 id=10 data-nosnippet>10</a>//! |
| <a href=#11 id=11 data-nosnippet>11</a>//! In GC mode, you generally operate on [`InternedRef`]s. They are `Copy` and comfortable. To intern |
| <a href=#12 id=12 data-nosnippet>12</a>//! a value you call [`Interned::new_gc`], which returns an [`InternedRef`]. Having all [`Interned`]s |
| <a href=#13 id=13 data-nosnippet>13</a>//! of some value be dropped will *not* immediately free the value. Instead, a mark-and-sweep GC can |
| <a href=#14 id=14 data-nosnippet>14</a>//! be initiated, which will free all values which have no live [`Interned`]s. |
| <a href=#15 id=15 data-nosnippet>15</a>//! |
| <a href=#16 id=16 data-nosnippet>16</a>//! Generally, in GC mode, you operate on [`InternedRef`], but when you need to store some long-term |
| <a href=#17 id=17 data-nosnippet>17</a>//! value (e.g. a Salsa query output), you convert it to an [`Interned`]. This ensures that an eventual |
| <a href=#18 id=18 data-nosnippet>18</a>//! GC will not free it as long as it is alive. |
| <a href=#19 id=19 data-nosnippet>19</a>//! |
| <a href=#20 id=20 data-nosnippet>20</a>//! Making mistakes is hard due to GC [`InternedRef`] wrappers not implementing `salsa::Update`, meaning |
| <a href=#21 id=21 data-nosnippet>21</a>//! Salsa will ensure you do not store them in queries or Salsa-interneds. However it's still *possible* |
| <a href=#22 id=22 data-nosnippet>22</a>//! without unsafe code (for example, by storing them in a `static`), which is why triggering GC is unsafe. |
| <a href=#23 id=23 data-nosnippet>23</a>//! |
| <a href=#24 id=24 data-nosnippet>24</a>//! For more information about GC see [`crate::gc`]. |
| <a href=#25 id=25 data-nosnippet>25</a> |
| <a href=#26 id=26 data-nosnippet>26</a></span><span class="kw">use </span>std::{ |
| <a href=#27 id=27 data-nosnippet>27</a> fmt::{<span class="self">self</span>, Debug, Display}, |
| <a href=#28 id=28 data-nosnippet>28</a> hash::{BuildHasher, Hash, Hasher}, |
| <a href=#29 id=29 data-nosnippet>29</a> ops::Deref, |
| <a href=#30 id=30 data-nosnippet>30</a> ptr, |
| <a href=#31 id=31 data-nosnippet>31</a> sync::OnceLock, |
| <a href=#32 id=32 data-nosnippet>32</a>}; |
| <a href=#33 id=33 data-nosnippet>33</a> |
| <a href=#34 id=34 data-nosnippet>34</a><span class="kw">use </span>dashmap::{DashMap, SharedValue}; |
| <a href=#35 id=35 data-nosnippet>35</a><span class="kw">use </span>hashbrown::raw::RawTable; |
| <a href=#36 id=36 data-nosnippet>36</a><span class="kw">use </span>rustc_hash::FxBuildHasher; |
| <a href=#37 id=37 data-nosnippet>37</a><span class="kw">use </span>triomphe::{Arc, ArcBorrow}; |
| <a href=#38 id=38 data-nosnippet>38</a> |
| <a href=#39 id=39 data-nosnippet>39</a><span class="kw">type </span>InternMap<T> = DashMap<Arc<T>, (), FxBuildHasher>; |
| <a href=#40 id=40 data-nosnippet>40</a><span class="kw">type </span>Guard<T> = dashmap::RwLockWriteGuard<<span class="lifetime">'static</span>, RawTable<(Arc<T>, SharedValue<()>)>>; |
| <a href=#41 id=41 data-nosnippet>41</a> |
| <a href=#42 id=42 data-nosnippet>42</a><span class="kw">pub struct </span>Interned<T: Internable> { |
| <a href=#43 id=43 data-nosnippet>43</a> arc: Arc<T>, |
| <a href=#44 id=44 data-nosnippet>44</a>} |
| <a href=#45 id=45 data-nosnippet>45</a> |
| <a href=#46 id=46 data-nosnippet>46</a><span class="kw">impl</span><T: Internable> Interned<T> { |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="attr">#[inline] |
| <a href=#48 id=48 data-nosnippet>48</a> </span><span class="kw">pub fn </span>new(obj: T) -> <span class="self">Self </span>{ |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="kw">const </span>{ <span class="macro">assert!</span>(!T::USE_GC) }; |
| <a href=#50 id=50 data-nosnippet>50</a> |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="kw">let </span>storage = T::storage().get(); |
| <a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>(<span class="kw-2">mut </span>shard, hash) = <span class="self">Self</span>::select(storage, <span class="kw-2">&</span>obj); |
| <a href=#53 id=53 data-nosnippet>53</a> <span class="comment">// Atomically, |
| <a href=#54 id=54 data-nosnippet>54</a> // - check if `obj` is already in the map |
| <a href=#55 id=55 data-nosnippet>55</a> // - if so, clone its `Arc` and return it |
| <a href=#56 id=56 data-nosnippet>56</a> // - if not, box it up, insert it, and return a clone |
| <a href=#57 id=57 data-nosnippet>57</a> // This needs to be atomic (locking the shard) to avoid races with other thread, which could |
| <a href=#58 id=58 data-nosnippet>58</a> // insert the same object between us looking it up and inserting it. |
| <a href=#59 id=59 data-nosnippet>59</a> </span><span class="kw">let </span>bucket = <span class="kw">match </span>shard.find_or_find_insert_slot( |
| <a href=#60 id=60 data-nosnippet>60</a> hash, |
| <a href=#61 id=61 data-nosnippet>61</a> |(other, <span class="kw">_</span>)| <span class="kw-2">**</span>other == obj, |
| <a href=#62 id=62 data-nosnippet>62</a> |(x, <span class="kw">_</span>)| <span class="self">Self</span>::hash(storage, x), |
| <a href=#63 id=63 data-nosnippet>63</a> ) { |
| <a href=#64 id=64 data-nosnippet>64</a> <span class="prelude-val">Ok</span>(bucket) => bucket, |
| <a href=#65 id=65 data-nosnippet>65</a> <span class="comment">// SAFETY: The slot came from `find_or_find_insert_slot()`, and the table wasn't modified since then. |
| <a href=#66 id=66 data-nosnippet>66</a> </span><span class="prelude-val">Err</span>(insert_slot) => <span class="kw">unsafe </span>{ |
| <a href=#67 id=67 data-nosnippet>67</a> shard.insert_in_slot(hash, insert_slot, (Arc::new(obj), SharedValue::new(()))) |
| <a href=#68 id=68 data-nosnippet>68</a> }, |
| <a href=#69 id=69 data-nosnippet>69</a> }; |
| <a href=#70 id=70 data-nosnippet>70</a> <span class="comment">// SAFETY: We just retrieved/inserted this bucket. |
| <a href=#71 id=71 data-nosnippet>71</a> </span><span class="kw">unsafe </span>{ <span class="self">Self </span>{ arc: bucket.as_ref().<span class="number">0</span>.clone() } } |
| <a href=#72 id=72 data-nosnippet>72</a> } |
| <a href=#73 id=73 data-nosnippet>73</a> |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="attr">#[inline] |
| <a href=#75 id=75 data-nosnippet>75</a> </span><span class="kw">pub fn </span>new_gc<<span class="lifetime">'a</span>>(obj: T) -> InternedRef<<span class="lifetime">'a</span>, T> { |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="kw">const </span>{ <span class="macro">assert!</span>(T::USE_GC) }; |
| <a href=#77 id=77 data-nosnippet>77</a> |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="kw">let </span>storage = T::storage().get(); |
| <a href=#79 id=79 data-nosnippet>79</a> <span class="kw">let </span>(<span class="kw-2">mut </span>shard, hash) = <span class="self">Self</span>::select(storage, <span class="kw-2">&</span>obj); |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="comment">// Atomically, |
| <a href=#81 id=81 data-nosnippet>81</a> // - check if `obj` is already in the map |
| <a href=#82 id=82 data-nosnippet>82</a> // - if so, clone its `Arc` and return it |
| <a href=#83 id=83 data-nosnippet>83</a> // - if not, box it up, insert it, and return a clone |
| <a href=#84 id=84 data-nosnippet>84</a> // This needs to be atomic (locking the shard) to avoid races with other thread, which could |
| <a href=#85 id=85 data-nosnippet>85</a> // insert the same object between us looking it up and inserting it. |
| <a href=#86 id=86 data-nosnippet>86</a> </span><span class="kw">let </span>bucket = <span class="kw">match </span>shard.find_or_find_insert_slot( |
| <a href=#87 id=87 data-nosnippet>87</a> hash, |
| <a href=#88 id=88 data-nosnippet>88</a> |(other, <span class="kw">_</span>)| <span class="kw-2">**</span>other == obj, |
| <a href=#89 id=89 data-nosnippet>89</a> |(x, <span class="kw">_</span>)| <span class="self">Self</span>::hash(storage, x), |
| <a href=#90 id=90 data-nosnippet>90</a> ) { |
| <a href=#91 id=91 data-nosnippet>91</a> <span class="prelude-val">Ok</span>(bucket) => bucket, |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="comment">// SAFETY: The slot came from `find_or_find_insert_slot()`, and the table wasn't modified since then. |
| <a href=#93 id=93 data-nosnippet>93</a> </span><span class="prelude-val">Err</span>(insert_slot) => <span class="kw">unsafe </span>{ |
| <a href=#94 id=94 data-nosnippet>94</a> shard.insert_in_slot(hash, insert_slot, (Arc::new(obj), SharedValue::new(()))) |
| <a href=#95 id=95 data-nosnippet>95</a> }, |
| <a href=#96 id=96 data-nosnippet>96</a> }; |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="comment">// SAFETY: We just retrieved/inserted this bucket. |
| <a href=#98 id=98 data-nosnippet>98</a> </span><span class="kw">unsafe </span>{ InternedRef { arc: Arc::borrow_arc(<span class="kw-2">&</span>bucket.as_ref().<span class="number">0</span>) } } |
| <a href=#99 id=99 data-nosnippet>99</a> } |
| <a href=#100 id=100 data-nosnippet>100</a> |
| <a href=#101 id=101 data-nosnippet>101</a> <span class="attr">#[inline] |
| <a href=#102 id=102 data-nosnippet>102</a> </span><span class="kw">fn </span>select(storage: <span class="kw-2">&</span><span class="lifetime">'static </span>InternMap<T>, obj: <span class="kw-2">&</span>T) -> (Guard<T>, u64) { |
| <a href=#103 id=103 data-nosnippet>103</a> <span class="kw">let </span>hash = <span class="self">Self</span>::hash(storage, obj); |
| <a href=#104 id=104 data-nosnippet>104</a> <span class="kw">let </span>shard_idx = storage.determine_shard(hash <span class="kw">as </span>usize); |
| <a href=#105 id=105 data-nosnippet>105</a> <span class="kw">let </span>shard = <span class="kw-2">&</span>storage.shards()[shard_idx]; |
| <a href=#106 id=106 data-nosnippet>106</a> (shard.write(), hash) |
| <a href=#107 id=107 data-nosnippet>107</a> } |
| <a href=#108 id=108 data-nosnippet>108</a> |
| <a href=#109 id=109 data-nosnippet>109</a> <span class="attr">#[inline] |
| <a href=#110 id=110 data-nosnippet>110</a> </span><span class="kw">fn </span>hash(storage: <span class="kw-2">&</span><span class="lifetime">'static </span>InternMap<T>, obj: <span class="kw-2">&</span>T) -> u64 { |
| <a href=#111 id=111 data-nosnippet>111</a> storage.hasher().hash_one(obj) |
| <a href=#112 id=112 data-nosnippet>112</a> } |
| <a href=#113 id=113 data-nosnippet>113</a> |
| <a href=#114 id=114 data-nosnippet>114</a> <span class="doccomment">/// # Safety |
| <a href=#115 id=115 data-nosnippet>115</a> /// |
| <a href=#116 id=116 data-nosnippet>116</a> /// The pointer should originate from an `Interned` or an `InternedRef`. |
| <a href=#117 id=117 data-nosnippet>117</a> </span><span class="attr">#[inline] |
| <a href=#118 id=118 data-nosnippet>118</a> </span><span class="kw">pub unsafe fn </span>from_raw(ptr: <span class="kw-2">*const </span>T) -> <span class="self">Self </span>{ |
| <a href=#119 id=119 data-nosnippet>119</a> <span class="comment">// SAFETY: Our precondition. |
| <a href=#120 id=120 data-nosnippet>120</a> </span><span class="self">Self </span>{ arc: <span class="kw">unsafe </span>{ Arc::from_raw(ptr) } } |
| <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> <span class="attr">#[inline] |
| <a href=#124 id=124 data-nosnippet>124</a> </span><span class="kw">pub fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> InternedRef<<span class="lifetime">'_</span>, T> { |
| <a href=#125 id=125 data-nosnippet>125</a> InternedRef { arc: <span class="self">self</span>.arc.borrow_arc() } |
| <a href=#126 id=126 data-nosnippet>126</a> } |
| <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><span class="kw">impl</span><T: Internable> Drop <span class="kw">for </span>Interned<T> { |
| <a href=#130 id=130 data-nosnippet>130</a> <span class="attr">#[inline] |
| <a href=#131 id=131 data-nosnippet>131</a> </span><span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#132 id=132 data-nosnippet>132</a> <span class="comment">// When the last `Ref` is dropped, remove the object from the global map. |
| <a href=#133 id=133 data-nosnippet>133</a> </span><span class="kw">if </span>!T::USE_GC && Arc::count(<span class="kw-2">&</span><span class="self">self</span>.arc) == <span class="number">2 </span>{ |
| <a href=#134 id=134 data-nosnippet>134</a> <span class="comment">// Only `self` and the global map point to the object. |
| <a href=#135 id=135 data-nosnippet>135</a> |
| <a href=#136 id=136 data-nosnippet>136</a> </span><span class="self">self</span>.drop_slow(); |
| <a href=#137 id=137 data-nosnippet>137</a> } |
| <a href=#138 id=138 data-nosnippet>138</a> } |
| <a href=#139 id=139 data-nosnippet>139</a>} |
| <a href=#140 id=140 data-nosnippet>140</a> |
| <a href=#141 id=141 data-nosnippet>141</a><span class="kw">impl</span><T: Internable> Interned<T> { |
| <a href=#142 id=142 data-nosnippet>142</a> <span class="attr">#[cold] |
| <a href=#143 id=143 data-nosnippet>143</a> </span><span class="kw">fn </span>drop_slow(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#144 id=144 data-nosnippet>144</a> <span class="kw">let </span>storage = T::storage().get(); |
| <a href=#145 id=145 data-nosnippet>145</a> <span class="kw">let </span>(<span class="kw-2">mut </span>shard, hash) = <span class="self">Self</span>::select(storage, <span class="kw-2">&</span><span class="self">self</span>.arc); |
| <a href=#146 id=146 data-nosnippet>146</a> |
| <a href=#147 id=147 data-nosnippet>147</a> <span class="kw">if </span>Arc::count(<span class="kw-2">&</span><span class="self">self</span>.arc) != <span class="number">2 </span>{ |
| <a href=#148 id=148 data-nosnippet>148</a> <span class="comment">// Another thread has interned another copy |
| <a href=#149 id=149 data-nosnippet>149</a> </span><span class="kw">return</span>; |
| <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> shard.remove_entry(hash, |(other, <span class="kw">_</span>)| <span class="kw-2">**</span>other == <span class="kw-2">**</span><span class="self">self</span>); |
| <a href=#153 id=153 data-nosnippet>153</a> |
| <a href=#154 id=154 data-nosnippet>154</a> <span class="comment">// Shrink the backing storage if the shard is less than 50% occupied. |
| <a href=#155 id=155 data-nosnippet>155</a> </span><span class="kw">if </span>shard.len() * <span class="number">2 </span>< shard.capacity() { |
| <a href=#156 id=156 data-nosnippet>156</a> <span class="kw">let </span>len = shard.len(); |
| <a href=#157 id=157 data-nosnippet>157</a> shard.shrink_to(len, |(x, <span class="kw">_</span>)| <span class="self">Self</span>::hash(storage, x)); |
| <a href=#158 id=158 data-nosnippet>158</a> } |
| <a href=#159 id=159 data-nosnippet>159</a> } |
| <a href=#160 id=160 data-nosnippet>160</a>} |
| <a href=#161 id=161 data-nosnippet>161</a> |
| <a href=#162 id=162 data-nosnippet>162</a><span class="doccomment">/// Compares interned `Ref`s using pointer equality. |
| <a href=#163 id=163 data-nosnippet>163</a></span><span class="kw">impl</span><T: Internable> PartialEq <span class="kw">for </span>Interned<T> { |
| <a href=#164 id=164 data-nosnippet>164</a> <span class="comment">// NOTE: No `?Sized` because `ptr_eq` doesn't work right with trait objects. |
| <a href=#165 id=165 data-nosnippet>165</a> |
| <a href=#166 id=166 data-nosnippet>166</a> </span><span class="attr">#[inline] |
| <a href=#167 id=167 data-nosnippet>167</a> </span><span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> bool { |
| <a href=#168 id=168 data-nosnippet>168</a> Arc::ptr_eq(<span class="kw-2">&</span><span class="self">self</span>.arc, <span class="kw-2">&</span>other.arc) |
| <a href=#169 id=169 data-nosnippet>169</a> } |
| <a href=#170 id=170 data-nosnippet>170</a>} |
| <a href=#171 id=171 data-nosnippet>171</a> |
| <a href=#172 id=172 data-nosnippet>172</a><span class="kw">impl</span><T: Internable> Eq <span class="kw">for </span>Interned<T> {} |
| <a href=#173 id=173 data-nosnippet>173</a> |
| <a href=#174 id=174 data-nosnippet>174</a><span class="kw">impl</span><T: Internable> Hash <span class="kw">for </span>Interned<T> { |
| <a href=#175 id=175 data-nosnippet>175</a> <span class="attr">#[inline] |
| <a href=#176 id=176 data-nosnippet>176</a> </span><span class="kw">fn </span>hash<H: Hasher>(<span class="kw-2">&</span><span class="self">self</span>, state: <span class="kw-2">&mut </span>H) { |
| <a href=#177 id=177 data-nosnippet>177</a> state.write_usize(<span class="self">self</span>.arc.as_ptr().addr()) |
| <a href=#178 id=178 data-nosnippet>178</a> } |
| <a href=#179 id=179 data-nosnippet>179</a>} |
| <a href=#180 id=180 data-nosnippet>180</a> |
| <a href=#181 id=181 data-nosnippet>181</a><span class="kw">impl</span><T: Internable> AsRef<T> <span class="kw">for </span>Interned<T> { |
| <a href=#182 id=182 data-nosnippet>182</a> <span class="attr">#[inline] |
| <a href=#183 id=183 data-nosnippet>183</a> </span><span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>T { |
| <a href=#184 id=184 data-nosnippet>184</a> <span class="self">self |
| <a href=#185 id=185 data-nosnippet>185</a> </span>} |
| <a href=#186 id=186 data-nosnippet>186</a>} |
| <a href=#187 id=187 data-nosnippet>187</a> |
| <a href=#188 id=188 data-nosnippet>188</a><span class="kw">impl</span><T: Internable> Deref <span class="kw">for </span>Interned<T> { |
| <a href=#189 id=189 data-nosnippet>189</a> <span class="kw">type </span>Target = T; |
| <a href=#190 id=190 data-nosnippet>190</a> |
| <a href=#191 id=191 data-nosnippet>191</a> <span class="attr">#[inline] |
| <a href=#192 id=192 data-nosnippet>192</a> </span><span class="kw">fn </span>deref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="self">Self</span>::Target { |
| <a href=#193 id=193 data-nosnippet>193</a> <span class="kw-2">&</span><span class="self">self</span>.arc |
| <a href=#194 id=194 data-nosnippet>194</a> } |
| <a href=#195 id=195 data-nosnippet>195</a>} |
| <a href=#196 id=196 data-nosnippet>196</a> |
| <a href=#197 id=197 data-nosnippet>197</a><span class="kw">impl</span><T: Internable> Clone <span class="kw">for </span>Interned<T> { |
| <a href=#198 id=198 data-nosnippet>198</a> <span class="attr">#[inline] |
| <a href=#199 id=199 data-nosnippet>199</a> </span><span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| <a href=#200 id=200 data-nosnippet>200</a> <span class="self">Self </span>{ arc: <span class="self">self</span>.arc.clone() } |
| <a href=#201 id=201 data-nosnippet>201</a> } |
| <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><span class="kw">impl</span><T: Debug + Internable> Debug <span class="kw">for </span>Interned<T> { |
| <a href=#205 id=205 data-nosnippet>205</a> <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 { |
| <a href=#206 id=206 data-nosnippet>206</a> <T <span class="kw">as </span>Debug>::fmt(<span class="kw-2">&**</span><span class="self">self</span>, f) |
| <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> |
| <a href=#210 id=210 data-nosnippet>210</a><span class="kw">impl</span><T: Display + Internable> Display <span class="kw">for </span>Interned<T> { |
| <a href=#211 id=211 data-nosnippet>211</a> <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 { |
| <a href=#212 id=212 data-nosnippet>212</a> <T <span class="kw">as </span>Display>::fmt(<span class="kw-2">&**</span><span class="self">self</span>, f) |
| <a href=#213 id=213 data-nosnippet>213</a> } |
| <a href=#214 id=214 data-nosnippet>214</a>} |
| <a href=#215 id=215 data-nosnippet>215</a> |
| <a href=#216 id=216 data-nosnippet>216</a><span class="attr">#[repr(transparent)] |
| <a href=#217 id=217 data-nosnippet>217</a></span><span class="kw">pub struct </span>InternedRef<<span class="lifetime">'a</span>, T> { |
| <a href=#218 id=218 data-nosnippet>218</a> arc: ArcBorrow<<span class="lifetime">'a</span>, T>, |
| <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>, T: Internable> InternedRef<<span class="lifetime">'a</span>, T> { |
| <a href=#222 id=222 data-nosnippet>222</a> <span class="attr">#[inline] |
| <a href=#223 id=223 data-nosnippet>223</a> </span><span class="kw">pub fn </span>as_raw(<span class="self">self</span>) -> <span class="kw-2">*const </span>T { |
| <a href=#224 id=224 data-nosnippet>224</a> <span class="comment">// Not `ptr::from_ref(&*self.arc)`, because we need to keep the provenance. |
| <a href=#225 id=225 data-nosnippet>225</a> </span><span class="self">self</span>.arc.with_arc(|arc| Arc::as_ptr(arc)) |
| <a href=#226 id=226 data-nosnippet>226</a> } |
| <a href=#227 id=227 data-nosnippet>227</a> |
| <a href=#228 id=228 data-nosnippet>228</a> <span class="doccomment">/// # Safety |
| <a href=#229 id=229 data-nosnippet>229</a> /// |
| <a href=#230 id=230 data-nosnippet>230</a> /// The pointer needs to originate from `Interned` or `InternedRef`. |
| <a href=#231 id=231 data-nosnippet>231</a> </span><span class="attr">#[inline] |
| <a href=#232 id=232 data-nosnippet>232</a> </span><span class="kw">pub unsafe fn </span>from_raw(ptr: <span class="kw-2">*const </span>T) -> <span class="self">Self </span>{ |
| <a href=#233 id=233 data-nosnippet>233</a> <span class="comment">// SAFETY: Our precondition. |
| <a href=#234 id=234 data-nosnippet>234</a> </span><span class="self">Self </span>{ arc: <span class="kw">unsafe </span>{ ArcBorrow::from_ptr(ptr) } } |
| <a href=#235 id=235 data-nosnippet>235</a> } |
| <a href=#236 id=236 data-nosnippet>236</a> |
| <a href=#237 id=237 data-nosnippet>237</a> <span class="attr">#[inline] |
| <a href=#238 id=238 data-nosnippet>238</a> </span><span class="kw">pub fn </span>to_owned(<span class="self">self</span>) -> Interned<T> { |
| <a href=#239 id=239 data-nosnippet>239</a> Interned { arc: <span class="self">self</span>.arc.clone_arc() } |
| <a href=#240 id=240 data-nosnippet>240</a> } |
| <a href=#241 id=241 data-nosnippet>241</a> |
| <a href=#242 id=242 data-nosnippet>242</a> <span class="attr">#[inline] |
| <a href=#243 id=243 data-nosnippet>243</a> </span><span class="kw">pub fn </span>get(<span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'a </span>T { |
| <a href=#244 id=244 data-nosnippet>244</a> <span class="self">self</span>.arc.get() |
| <a href=#245 id=245 data-nosnippet>245</a> } |
| <a href=#246 id=246 data-nosnippet>246</a> |
| <a href=#247 id=247 data-nosnippet>247</a> <span class="doccomment">/// # Safety |
| <a href=#248 id=248 data-nosnippet>248</a> /// |
| <a href=#249 id=249 data-nosnippet>249</a> /// You have to make sure the data is not referenced after the refcount reaches zero; beware the interning |
| <a href=#250 id=250 data-nosnippet>250</a> /// map also keeps a reference to the value. |
| <a href=#251 id=251 data-nosnippet>251</a> </span><span class="attr">#[inline] |
| <a href=#252 id=252 data-nosnippet>252</a> </span><span class="kw">pub unsafe fn </span>decrement_refcount(<span class="self">self</span>) { |
| <a href=#253 id=253 data-nosnippet>253</a> <span class="comment">// SAFETY: Our precondition. |
| <a href=#254 id=254 data-nosnippet>254</a> </span><span class="kw">unsafe </span>{ drop(Arc::from_raw(<span class="self">self</span>.as_raw())) } |
| <a href=#255 id=255 data-nosnippet>255</a> } |
| <a href=#256 id=256 data-nosnippet>256</a> |
| <a href=#257 id=257 data-nosnippet>257</a> <span class="attr">#[inline] |
| <a href=#258 id=258 data-nosnippet>258</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>strong_count(<span class="self">self</span>) -> usize { |
| <a href=#259 id=259 data-nosnippet>259</a> ArcBorrow::strong_count(<span class="kw-2">&</span><span class="self">self</span>.arc) |
| <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">/// **Available only on GC mode**. |
| <a href=#263 id=263 data-nosnippet>263</a> /// |
| <a href=#264 id=264 data-nosnippet>264</a> /// Changes the attached lifetime, as in GC mode, the lifetime is more kind of a lint to prevent misuse |
| <a href=#265 id=265 data-nosnippet>265</a> /// than actual soundness check. |
| <a href=#266 id=266 data-nosnippet>266</a> </span><span class="attr">#[inline] |
| <a href=#267 id=267 data-nosnippet>267</a> </span><span class="kw">pub fn </span>change_lifetime<<span class="lifetime">'b</span>>(<span class="self">self</span>) -> InternedRef<<span class="lifetime">'b</span>, T> { |
| <a href=#268 id=268 data-nosnippet>268</a> <span class="kw">const </span>{ <span class="macro">assert!</span>(T::USE_GC) }; |
| <a href=#269 id=269 data-nosnippet>269</a> <span class="comment">// SAFETY: The lifetime on `InternedRef` is essentially advisory only for GCed types. |
| <a href=#270 id=270 data-nosnippet>270</a> </span><span class="kw">unsafe </span>{ std::mem::transmute::<InternedRef<<span class="lifetime">'a</span>, T>, InternedRef<<span class="lifetime">'b</span>, T>>(<span class="self">self</span>) } |
| <a href=#271 id=271 data-nosnippet>271</a> } |
| <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><span class="kw">impl</span><T> Clone <span class="kw">for </span>InternedRef<<span class="lifetime">'_</span>, T> { |
| <a href=#275 id=275 data-nosnippet>275</a> <span class="attr">#[inline] |
| <a href=#276 id=276 data-nosnippet>276</a> </span><span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| <a href=#277 id=277 data-nosnippet>277</a> <span class="kw-2">*</span><span class="self">self |
| <a href=#278 id=278 data-nosnippet>278</a> </span>} |
| <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><T> Copy <span class="kw">for </span>InternedRef<<span class="lifetime">'_</span>, T> {} |
| <a href=#282 id=282 data-nosnippet>282</a> |
| <a href=#283 id=283 data-nosnippet>283</a><span class="kw">impl</span><T: Hash> Hash <span class="kw">for </span>InternedRef<<span class="lifetime">'_</span>, T> { |
| <a href=#284 id=284 data-nosnippet>284</a> <span class="attr">#[inline] |
| <a href=#285 id=285 data-nosnippet>285</a> </span><span class="kw">fn </span>hash<H: Hasher>(<span class="kw-2">&</span><span class="self">self</span>, state: <span class="kw-2">&mut </span>H) { |
| <a href=#286 id=286 data-nosnippet>286</a> <span class="kw">let </span>ptr = ptr::from_ref::<T>(<span class="kw-2">&*</span><span class="self">self</span>.arc); |
| <a href=#287 id=287 data-nosnippet>287</a> state.write_usize(ptr.addr()); |
| <a href=#288 id=288 data-nosnippet>288</a> } |
| <a href=#289 id=289 data-nosnippet>289</a>} |
| <a href=#290 id=290 data-nosnippet>290</a> |
| <a href=#291 id=291 data-nosnippet>291</a><span class="kw">impl</span><T: PartialEq> PartialEq <span class="kw">for </span>InternedRef<<span class="lifetime">'_</span>, T> { |
| <a href=#292 id=292 data-nosnippet>292</a> <span class="attr">#[inline] |
| <a href=#293 id=293 data-nosnippet>293</a> </span><span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> bool { |
| <a href=#294 id=294 data-nosnippet>294</a> ArcBorrow::ptr_eq(<span class="kw-2">&</span><span class="self">self</span>.arc, <span class="kw-2">&</span>other.arc) |
| <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> |
| <a href=#298 id=298 data-nosnippet>298</a><span class="kw">impl</span><T: Eq> Eq <span class="kw">for </span>InternedRef<<span class="lifetime">'_</span>, T> {} |
| <a href=#299 id=299 data-nosnippet>299</a> |
| <a href=#300 id=300 data-nosnippet>300</a><span class="kw">impl</span><T> Deref <span class="kw">for </span>InternedRef<<span class="lifetime">'_</span>, T> { |
| <a href=#301 id=301 data-nosnippet>301</a> <span class="kw">type </span>Target = T; |
| <a href=#302 id=302 data-nosnippet>302</a> |
| <a href=#303 id=303 data-nosnippet>303</a> <span class="attr">#[inline] |
| <a href=#304 id=304 data-nosnippet>304</a> </span><span class="kw">fn </span>deref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="self">Self</span>::Target { |
| <a href=#305 id=305 data-nosnippet>305</a> <span class="kw-2">&</span><span class="self">self</span>.arc |
| <a href=#306 id=306 data-nosnippet>306</a> } |
| <a href=#307 id=307 data-nosnippet>307</a>} |
| <a href=#308 id=308 data-nosnippet>308</a> |
| <a href=#309 id=309 data-nosnippet>309</a><span class="kw">impl</span><T: Debug> Debug <span class="kw">for </span>InternedRef<<span class="lifetime">'_</span>, T> { |
| <a href=#310 id=310 data-nosnippet>310</a> <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 { |
| <a href=#311 id=311 data-nosnippet>311</a> (<span class="kw-2">*</span><span class="self">self</span>.arc).fmt(f) |
| <a href=#312 id=312 data-nosnippet>312</a> } |
| <a href=#313 id=313 data-nosnippet>313</a>} |
| <a href=#314 id=314 data-nosnippet>314</a> |
| <a href=#315 id=315 data-nosnippet>315</a><span class="kw">impl</span><T: Display> Display <span class="kw">for </span>InternedRef<<span class="lifetime">'_</span>, T> { |
| <a href=#316 id=316 data-nosnippet>316</a> <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 { |
| <a href=#317 id=317 data-nosnippet>317</a> (<span class="kw-2">*</span><span class="self">self</span>.arc).fmt(f) |
| <a href=#318 id=318 data-nosnippet>318</a> } |
| <a href=#319 id=319 data-nosnippet>319</a>} |
| <a href=#320 id=320 data-nosnippet>320</a> |
| <a href=#321 id=321 data-nosnippet>321</a><span class="kw">pub struct </span>InternStorage<T: <span class="question-mark">?</span>Sized> { |
| <a href=#322 id=322 data-nosnippet>322</a> map: OnceLock<InternMap<T>>, |
| <a href=#323 id=323 data-nosnippet>323</a>} |
| <a href=#324 id=324 data-nosnippet>324</a> |
| <a href=#325 id=325 data-nosnippet>325</a><span class="attr">#[allow( |
| <a href=#326 id=326 data-nosnippet>326</a> clippy::new_without_default, |
| <a href=#327 id=327 data-nosnippet>327</a> reason = <span class="string">"this a const fn, so it can't be default yet. See <https://github.com/rust-lang/rust/issues/63065>" |
| <a href=#328 id=328 data-nosnippet>328</a></span>)] |
| <a href=#329 id=329 data-nosnippet>329</a></span><span class="kw">impl</span><T: <span class="question-mark">?</span>Sized> InternStorage<T> { |
| <a href=#330 id=330 data-nosnippet>330</a> <span class="kw">pub const fn </span>new() -> <span class="self">Self </span>{ |
| <a href=#331 id=331 data-nosnippet>331</a> <span class="self">Self </span>{ map: OnceLock::new() } |
| <a href=#332 id=332 data-nosnippet>332</a> } |
| <a href=#333 id=333 data-nosnippet>333</a>} |
| <a href=#334 id=334 data-nosnippet>334</a> |
| <a href=#335 id=335 data-nosnippet>335</a><span class="kw">impl</span><T: Internable + <span class="question-mark">?</span>Sized> InternStorage<T> { |
| <a href=#336 id=336 data-nosnippet>336</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>InternMap<T> { |
| <a href=#337 id=337 data-nosnippet>337</a> <span class="self">self</span>.map.get_or_init(|| DashMap::with_capacity_and_hasher(<span class="number">1024</span>, Default::default())) |
| <a href=#338 id=338 data-nosnippet>338</a> } |
| <a href=#339 id=339 data-nosnippet>339</a>} |
| <a href=#340 id=340 data-nosnippet>340</a> |
| <a href=#341 id=341 data-nosnippet>341</a><span class="kw">pub trait </span>Internable: Hash + Eq + Send + Sync + <span class="lifetime">'static </span>{ |
| <a href=#342 id=342 data-nosnippet>342</a> <span class="kw">const </span>USE_GC: bool; |
| <a href=#343 id=343 data-nosnippet>343</a> |
| <a href=#344 id=344 data-nosnippet>344</a> <span class="kw">fn </span>storage() -> <span class="kw-2">&</span><span class="lifetime">'static </span>InternStorage<<span class="self">Self</span>>; |
| <a href=#345 id=345 data-nosnippet>345</a>} |
| <a href=#346 id=346 data-nosnippet>346</a> |
| <a href=#347 id=347 data-nosnippet>347</a><span class="doccomment">/// Implements `Internable` for a given list of types, making them usable with `Interned`. |
| <a href=#348 id=348 data-nosnippet>348</a></span><span class="attr">#[macro_export] |
| <a href=#349 id=349 data-nosnippet>349</a>#[doc(hidden)] |
| <a href=#350 id=350 data-nosnippet>350</a></span><span class="macro">macro_rules!</span> _impl_internable { |
| <a href=#351 id=351 data-nosnippet>351</a> ( gc; $(<span class="macro-nonterminal">$t</span>:ty),+ $(,)<span class="question-mark">? </span>) => { $( |
| <a href=#352 id=352 data-nosnippet>352</a> <span class="kw">impl </span><span class="macro-nonterminal">$crate::Internable </span><span class="kw">for </span><span class="macro-nonterminal">$t </span>{ |
| <a href=#353 id=353 data-nosnippet>353</a> <span class="kw">const </span>USE_GC: bool = <span class="bool-val">true</span>; |
| <a href=#354 id=354 data-nosnippet>354</a> |
| <a href=#355 id=355 data-nosnippet>355</a> <span class="kw">fn </span>storage() -> <span class="kw-2">&</span><span class="lifetime">'static </span><span class="macro-nonterminal">$crate::InternStorage</span><<span class="self">Self</span>> { |
| <a href=#356 id=356 data-nosnippet>356</a> <span class="kw">static </span>STORAGE: <span class="macro-nonterminal">$crate::InternStorage</span><<span class="macro-nonterminal">$t</span>> = <span class="macro-nonterminal">$crate::InternStorage::new</span>(); |
| <a href=#357 id=357 data-nosnippet>357</a> <span class="kw-2">&</span>STORAGE |
| <a href=#358 id=358 data-nosnippet>358</a> } |
| <a href=#359 id=359 data-nosnippet>359</a> } |
| <a href=#360 id=360 data-nosnippet>360</a> )+ }; |
| <a href=#361 id=361 data-nosnippet>361</a> ( $(<span class="macro-nonterminal">$t</span>:ty),+ $(,)<span class="question-mark">? </span>) => { $( |
| <a href=#362 id=362 data-nosnippet>362</a> <span class="kw">impl </span><span class="macro-nonterminal">$crate::Internable </span><span class="kw">for </span><span class="macro-nonterminal">$t </span>{ |
| <a href=#363 id=363 data-nosnippet>363</a> <span class="kw">const </span>USE_GC: bool = <span class="bool-val">false</span>; |
| <a href=#364 id=364 data-nosnippet>364</a> |
| <a href=#365 id=365 data-nosnippet>365</a> <span class="kw">fn </span>storage() -> <span class="kw-2">&</span><span class="lifetime">'static </span><span class="macro-nonterminal">$crate::InternStorage</span><<span class="self">Self</span>> { |
| <a href=#366 id=366 data-nosnippet>366</a> <span class="kw">static </span>STORAGE: <span class="macro-nonterminal">$crate::InternStorage</span><<span class="macro-nonterminal">$t</span>> = <span class="macro-nonterminal">$crate::InternStorage::new</span>(); |
| <a href=#367 id=367 data-nosnippet>367</a> <span class="kw-2">&</span>STORAGE |
| <a href=#368 id=368 data-nosnippet>368</a> } |
| <a href=#369 id=369 data-nosnippet>369</a> } |
| <a href=#370 id=370 data-nosnippet>370</a> )+ }; |
| <a href=#371 id=371 data-nosnippet>371</a>} |
| <a href=#372 id=372 data-nosnippet>372</a><span class="kw">pub use </span><span class="kw">crate</span>::_impl_internable <span class="kw">as </span>impl_internable; |
| </code></pre></div></section></main></body></html> |
