| <!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/span/src/lib.rs`."><title>lib.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-84e720fa.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="span" data-themes="" data-resource-suffix="" data-rustdoc-version="1.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.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-fd3af306.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.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><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">span/</div>lib.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">//! File and span related types. |
| <a href=#2 id=2 data-nosnippet>2</a></span><span class="kw">use </span>std::fmt::{<span class="self">self</span>, Write}; |
| <a href=#3 id=3 data-nosnippet>3</a> |
| <a href=#4 id=4 data-nosnippet>4</a><span class="kw">mod </span>ast_id; |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">mod </span>hygiene; |
| <a href=#6 id=6 data-nosnippet>6</a><span class="kw">mod </span>map; |
| <a href=#7 id=7 data-nosnippet>7</a> |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">pub use </span><span class="self">self</span>::{ |
| <a href=#9 id=9 data-nosnippet>9</a> ast_id::{ |
| <a href=#10 id=10 data-nosnippet>10</a> AstIdMap, AstIdNode, ErasedFileAstId, FIXUP_ERASED_FILE_AST_ID_MARKER, FileAstId, |
| <a href=#11 id=11 data-nosnippet>11</a> ROOT_ERASED_FILE_AST_ID, |
| <a href=#12 id=12 data-nosnippet>12</a> }, |
| <a href=#13 id=13 data-nosnippet>13</a> hygiene::{SyntaxContext, Transparency}, |
| <a href=#14 id=14 data-nosnippet>14</a> map::{RealSpanMap, SpanMap}, |
| <a href=#15 id=15 data-nosnippet>15</a>}; |
| <a href=#16 id=16 data-nosnippet>16</a> |
| <a href=#17 id=17 data-nosnippet>17</a><span class="kw">pub use </span>syntax::Edition; |
| <a href=#18 id=18 data-nosnippet>18</a><span class="kw">pub use </span>text_size::{TextRange, TextSize}; |
| <a href=#19 id=19 data-nosnippet>19</a><span class="kw">pub use </span>vfs::FileId; |
| <a href=#20 id=20 data-nosnippet>20</a> |
| <a href=#21 id=21 data-nosnippet>21</a><span class="kw">pub type </span>Span = SpanData<SyntaxContext>; |
| <a href=#22 id=22 data-nosnippet>22</a> |
| <a href=#23 id=23 data-nosnippet>23</a><span class="kw">impl </span>Span { |
| <a href=#24 id=24 data-nosnippet>24</a> <span class="kw">pub fn </span>cover(<span class="self">self</span>, other: Span) -> Span { |
| <a href=#25 id=25 data-nosnippet>25</a> <span class="kw">if </span><span class="self">self</span>.anchor != other.anchor { |
| <a href=#26 id=26 data-nosnippet>26</a> <span class="kw">return </span><span class="self">self</span>; |
| <a href=#27 id=27 data-nosnippet>27</a> } |
| <a href=#28 id=28 data-nosnippet>28</a> <span class="kw">let </span>range = <span class="self">self</span>.range.cover(other.range); |
| <a href=#29 id=29 data-nosnippet>29</a> Span { range, ..<span class="self">self </span>} |
| <a href=#30 id=30 data-nosnippet>30</a> } |
| <a href=#31 id=31 data-nosnippet>31</a>} |
| <a href=#32 id=32 data-nosnippet>32</a> |
| <a href=#33 id=33 data-nosnippet>33</a><span class="doccomment">/// Spans represent a region of code, used by the IDE to be able link macro inputs and outputs |
| <a href=#34 id=34 data-nosnippet>34</a>/// together. Positions in spans are relative to some [`SpanAnchor`] to make them more incremental |
| <a href=#35 id=35 data-nosnippet>35</a>/// friendly. |
| <a href=#36 id=36 data-nosnippet>36</a></span><span class="attr">#[derive(Clone, Copy, PartialEq, Eq, Hash)] |
| <a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub struct </span>SpanData<Ctx> { |
| <a href=#38 id=38 data-nosnippet>38</a> <span class="doccomment">/// The text range of this span, relative to the anchor. |
| <a href=#39 id=39 data-nosnippet>39</a> /// We need the anchor for incrementality, as storing absolute ranges will require |
| <a href=#40 id=40 data-nosnippet>40</a> /// recomputation on every change in a file at all times. |
| <a href=#41 id=41 data-nosnippet>41</a> </span><span class="kw">pub </span>range: TextRange, |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="doccomment">/// The anchor this span is relative to. |
| <a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">pub </span>anchor: SpanAnchor, |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="doccomment">/// The syntax context of the span. |
| <a href=#45 id=45 data-nosnippet>45</a> </span><span class="kw">pub </span>ctx: Ctx, |
| <a href=#46 id=46 data-nosnippet>46</a>} |
| <a href=#47 id=47 data-nosnippet>47</a> |
| <a href=#48 id=48 data-nosnippet>48</a><span class="kw">impl</span><Ctx: fmt::Debug> fmt::Debug <span class="kw">for </span>SpanData<Ctx> { |
| <a href=#49 id=49 data-nosnippet>49</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=#50 id=50 data-nosnippet>50</a> <span class="kw">if </span>f.alternate() { |
| <a href=#51 id=51 data-nosnippet>51</a> fmt::Debug::fmt(<span class="kw-2">&</span><span class="self">self</span>.anchor.file_id.file_id().index(), f)<span class="question-mark">?</span>; |
| <a href=#52 id=52 data-nosnippet>52</a> f.write_char(<span class="string">':'</span>)<span class="question-mark">?</span>; |
| <a href=#53 id=53 data-nosnippet>53</a> <span class="macro">write!</span>(f, <span class="string">"{:#?}"</span>, <span class="self">self</span>.anchor.ast_id)<span class="question-mark">?</span>; |
| <a href=#54 id=54 data-nosnippet>54</a> f.write_char(<span class="string">'@'</span>)<span class="question-mark">?</span>; |
| <a href=#55 id=55 data-nosnippet>55</a> fmt::Debug::fmt(<span class="kw-2">&</span><span class="self">self</span>.range, f)<span class="question-mark">?</span>; |
| <a href=#56 id=56 data-nosnippet>56</a> f.write_char(<span class="string">'#'</span>)<span class="question-mark">?</span>; |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="self">self</span>.ctx.fmt(f) |
| <a href=#58 id=58 data-nosnippet>58</a> } <span class="kw">else </span>{ |
| <a href=#59 id=59 data-nosnippet>59</a> f.debug_struct(<span class="string">"SpanData"</span>) |
| <a href=#60 id=60 data-nosnippet>60</a> .field(<span class="string">"range"</span>, <span class="kw-2">&</span><span class="self">self</span>.range) |
| <a href=#61 id=61 data-nosnippet>61</a> .field(<span class="string">"anchor"</span>, <span class="kw-2">&</span><span class="self">self</span>.anchor) |
| <a href=#62 id=62 data-nosnippet>62</a> .field(<span class="string">"ctx"</span>, <span class="kw-2">&</span><span class="self">self</span>.ctx) |
| <a href=#63 id=63 data-nosnippet>63</a> .finish() |
| <a href=#64 id=64 data-nosnippet>64</a> } |
| <a href=#65 id=65 data-nosnippet>65</a> } |
| <a href=#66 id=66 data-nosnippet>66</a>} |
| <a href=#67 id=67 data-nosnippet>67</a> |
| <a href=#68 id=68 data-nosnippet>68</a><span class="kw">impl</span><Ctx: Copy> SpanData<Ctx> { |
| <a href=#69 id=69 data-nosnippet>69</a> <span class="kw">pub fn </span>eq_ignoring_ctx(<span class="self">self</span>, other: <span class="self">Self</span>) -> bool { |
| <a href=#70 id=70 data-nosnippet>70</a> <span class="self">self</span>.anchor == other.anchor && <span class="self">self</span>.range == other.range |
| <a href=#71 id=71 data-nosnippet>71</a> } |
| <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="kw">impl </span>fmt::Display <span class="kw">for </span>Span { |
| <a href=#75 id=75 data-nosnippet>75</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=#76 id=76 data-nosnippet>76</a> fmt::Debug::fmt(<span class="kw-2">&</span><span class="self">self</span>.anchor.file_id.file_id().index(), f)<span class="question-mark">?</span>; |
| <a href=#77 id=77 data-nosnippet>77</a> f.write_char(<span class="string">':'</span>)<span class="question-mark">?</span>; |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="macro">write!</span>(f, <span class="string">"{:#?}"</span>, <span class="self">self</span>.anchor.ast_id)<span class="question-mark">?</span>; |
| <a href=#79 id=79 data-nosnippet>79</a> f.write_char(<span class="string">'@'</span>)<span class="question-mark">?</span>; |
| <a href=#80 id=80 data-nosnippet>80</a> fmt::Debug::fmt(<span class="kw-2">&</span><span class="self">self</span>.range, f)<span class="question-mark">?</span>; |
| <a href=#81 id=81 data-nosnippet>81</a> f.write_char(<span class="string">'#'</span>)<span class="question-mark">?</span>; |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="self">self</span>.ctx.fmt(f) |
| <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> |
| <a href=#86 id=86 data-nosnippet>86</a><span class="attr">#[derive(Copy, Clone, PartialEq, Eq, Hash)] |
| <a href=#87 id=87 data-nosnippet>87</a></span><span class="kw">pub struct </span>SpanAnchor { |
| <a href=#88 id=88 data-nosnippet>88</a> <span class="kw">pub </span>file_id: EditionedFileId, |
| <a href=#89 id=89 data-nosnippet>89</a> <span class="kw">pub </span>ast_id: ErasedFileAstId, |
| <a href=#90 id=90 data-nosnippet>90</a>} |
| <a href=#91 id=91 data-nosnippet>91</a> |
| <a href=#92 id=92 data-nosnippet>92</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>SpanAnchor { |
| <a href=#93 id=93 data-nosnippet>93</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=#94 id=94 data-nosnippet>94</a> f.debug_tuple(<span class="string">"SpanAnchor"</span>).field(<span class="kw-2">&</span><span class="self">self</span>.file_id).field(<span class="kw-2">&</span><span class="self">self</span>.ast_id).finish() |
| <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> |
| <a href=#98 id=98 data-nosnippet>98</a><span class="doccomment">/// A [`FileId`] and [`Edition`] bundled up together. |
| <a href=#99 id=99 data-nosnippet>99</a>/// The MSB is reserved for `HirFileId` encoding, more upper bits are used to then encode the edition. |
| <a href=#100 id=100 data-nosnippet>100</a></span><span class="attr">#[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)] |
| <a href=#101 id=101 data-nosnippet>101</a></span><span class="kw">pub struct </span>EditionedFileId(u32); |
| <a href=#102 id=102 data-nosnippet>102</a> |
| <a href=#103 id=103 data-nosnippet>103</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>EditionedFileId { |
| <a href=#104 id=104 data-nosnippet>104</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=#105 id=105 data-nosnippet>105</a> f.debug_tuple(<span class="string">"EditionedFileId"</span>) |
| <a href=#106 id=106 data-nosnippet>106</a> .field(<span class="kw-2">&</span><span class="self">self</span>.file_id().index()) |
| <a href=#107 id=107 data-nosnippet>107</a> .field(<span class="kw-2">&</span><span class="self">self</span>.edition()) |
| <a href=#108 id=108 data-nosnippet>108</a> .finish() |
| <a href=#109 id=109 data-nosnippet>109</a> } |
| <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">impl </span>From<EditionedFileId> <span class="kw">for </span>FileId { |
| <a href=#113 id=113 data-nosnippet>113</a> <span class="kw">fn </span>from(value: EditionedFileId) -> <span class="self">Self </span>{ |
| <a href=#114 id=114 data-nosnippet>114</a> value.file_id() |
| <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> |
| <a href=#118 id=118 data-nosnippet>118</a><span class="kw">const _</span>: () = <span class="macro">assert!</span>( |
| <a href=#119 id=119 data-nosnippet>119</a> EditionedFileId::RESERVED_HIGH_BITS |
| <a href=#120 id=120 data-nosnippet>120</a> + EditionedFileId::EDITION_BITS |
| <a href=#121 id=121 data-nosnippet>121</a> + EditionedFileId::FILE_ID_BITS |
| <a href=#122 id=122 data-nosnippet>122</a> == u32::BITS |
| <a href=#123 id=123 data-nosnippet>123</a>); |
| <a href=#124 id=124 data-nosnippet>124</a><span class="kw">const _</span>: () = <span class="macro">assert!</span>( |
| <a href=#125 id=125 data-nosnippet>125</a> EditionedFileId::RESERVED_MASK ^ EditionedFileId::EDITION_MASK ^ EditionedFileId::FILE_ID_MASK |
| <a href=#126 id=126 data-nosnippet>126</a> == <span class="number">0xFFFF_FFFF |
| <a href=#127 id=127 data-nosnippet>127</a></span>); |
| <a href=#128 id=128 data-nosnippet>128</a> |
| <a href=#129 id=129 data-nosnippet>129</a><span class="kw">impl </span>EditionedFileId { |
| <a href=#130 id=130 data-nosnippet>130</a> <span class="kw">pub const </span>RESERVED_MASK: u32 = <span class="number">0x8000_0000</span>; |
| <a href=#131 id=131 data-nosnippet>131</a> <span class="kw">pub const </span>EDITION_MASK: u32 = <span class="number">0x7F80_0000</span>; |
| <a href=#132 id=132 data-nosnippet>132</a> <span class="kw">pub const </span>FILE_ID_MASK: u32 = <span class="number">0x007F_FFFF</span>; |
| <a href=#133 id=133 data-nosnippet>133</a> |
| <a href=#134 id=134 data-nosnippet>134</a> <span class="kw">pub const </span>MAX_FILE_ID: u32 = <span class="self">Self</span>::FILE_ID_MASK; |
| <a href=#135 id=135 data-nosnippet>135</a> |
| <a href=#136 id=136 data-nosnippet>136</a> <span class="kw">pub const </span>RESERVED_HIGH_BITS: u32 = <span class="self">Self</span>::RESERVED_MASK.count_ones(); |
| <a href=#137 id=137 data-nosnippet>137</a> <span class="kw">pub const </span>FILE_ID_BITS: u32 = <span class="self">Self</span>::FILE_ID_MASK.count_ones(); |
| <a href=#138 id=138 data-nosnippet>138</a> <span class="kw">pub const </span>EDITION_BITS: u32 = <span class="self">Self</span>::EDITION_MASK.count_ones(); |
| <a href=#139 id=139 data-nosnippet>139</a> |
| <a href=#140 id=140 data-nosnippet>140</a> <span class="kw">pub const fn </span>current_edition(file_id: FileId) -> <span class="self">Self </span>{ |
| <a href=#141 id=141 data-nosnippet>141</a> <span class="self">Self</span>::new(file_id, Edition::CURRENT) |
| <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">pub const fn </span>new(file_id: FileId, edition: Edition) -> <span class="self">Self </span>{ |
| <a href=#145 id=145 data-nosnippet>145</a> <span class="kw">let </span>file_id = file_id.index(); |
| <a href=#146 id=146 data-nosnippet>146</a> <span class="kw">let </span>edition = edition <span class="kw">as </span>u32; |
| <a href=#147 id=147 data-nosnippet>147</a> <span class="macro">assert!</span>(file_id <= <span class="self">Self</span>::MAX_FILE_ID); |
| <a href=#148 id=148 data-nosnippet>148</a> <span class="self">Self</span>(file_id | (edition << <span class="self">Self</span>::FILE_ID_BITS)) |
| <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> <span class="kw">pub fn </span>from_raw(u32: u32) -> <span class="self">Self </span>{ |
| <a href=#152 id=152 data-nosnippet>152</a> <span class="macro">assert!</span>(u32 & <span class="self">Self</span>::RESERVED_MASK == <span class="number">0</span>); |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="macro">assert!</span>((u32 & <span class="self">Self</span>::EDITION_MASK) >> <span class="self">Self</span>::FILE_ID_BITS <= Edition::LATEST <span class="kw">as </span>u32); |
| <a href=#154 id=154 data-nosnippet>154</a> <span class="self">Self</span>(u32) |
| <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">pub const fn </span>as_u32(<span class="self">self</span>) -> u32 { |
| <a href=#158 id=158 data-nosnippet>158</a> <span class="self">self</span>.<span class="number">0 |
| <a href=#159 id=159 data-nosnippet>159</a> </span>} |
| <a href=#160 id=160 data-nosnippet>160</a> |
| <a href=#161 id=161 data-nosnippet>161</a> <span class="kw">pub const fn </span>file_id(<span class="self">self</span>) -> FileId { |
| <a href=#162 id=162 data-nosnippet>162</a> FileId::from_raw(<span class="self">self</span>.<span class="number">0 </span>& <span class="self">Self</span>::FILE_ID_MASK) |
| <a href=#163 id=163 data-nosnippet>163</a> } |
| <a href=#164 id=164 data-nosnippet>164</a> |
| <a href=#165 id=165 data-nosnippet>165</a> <span class="kw">pub const fn </span>unpack(<span class="self">self</span>) -> (FileId, Edition) { |
| <a href=#166 id=166 data-nosnippet>166</a> (<span class="self">self</span>.file_id(), <span class="self">self</span>.edition()) |
| <a href=#167 id=167 data-nosnippet>167</a> } |
| <a href=#168 id=168 data-nosnippet>168</a> |
| <a href=#169 id=169 data-nosnippet>169</a> <span class="kw">pub const fn </span>edition(<span class="self">self</span>) -> Edition { |
| <a href=#170 id=170 data-nosnippet>170</a> <span class="kw">let </span>edition = (<span class="self">self</span>.<span class="number">0 </span>& <span class="self">Self</span>::EDITION_MASK) >> <span class="self">Self</span>::FILE_ID_BITS; |
| <a href=#171 id=171 data-nosnippet>171</a> <span class="macro">debug_assert!</span>(edition <= Edition::LATEST <span class="kw">as </span>u32); |
| <a href=#172 id=172 data-nosnippet>172</a> <span class="kw">unsafe </span>{ std::mem::transmute(edition <span class="kw">as </span>u8) } |
| <a href=#173 id=173 data-nosnippet>173</a> } |
| <a href=#174 id=174 data-nosnippet>174</a>} |
| <a href=#175 id=175 data-nosnippet>175</a> |
| <a href=#176 id=176 data-nosnippet>176</a><span class="attr">#[cfg(not(feature = <span class="string">"salsa"</span>))] |
| <a href=#177 id=177 data-nosnippet>177</a></span><span class="kw">mod </span>salsa { |
| <a href=#178 id=178 data-nosnippet>178</a> <span class="attr">#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)] |
| <a href=#179 id=179 data-nosnippet>179</a> </span><span class="kw">pub struct </span>Id(u32); |
| <a href=#180 id=180 data-nosnippet>180</a>} |
| <a href=#181 id=181 data-nosnippet>181</a> |
| <a href=#182 id=182 data-nosnippet>182</a><span class="doccomment">/// Input to the analyzer is a set of files, where each file is identified by |
| <a href=#183 id=183 data-nosnippet>183</a>/// `FileId` and contains source code. However, another source of source code in |
| <a href=#184 id=184 data-nosnippet>184</a>/// Rust are macros: each macro can be thought of as producing a "temporary |
| <a href=#185 id=185 data-nosnippet>185</a>/// file". To assign an id to such a file, we use the id of the macro call that |
| <a href=#186 id=186 data-nosnippet>186</a>/// produced the file. So, a `HirFileId` is either a `FileId` (source code |
| <a href=#187 id=187 data-nosnippet>187</a>/// written by user), or a `MacroCallId` (source code produced by macro). |
| <a href=#188 id=188 data-nosnippet>188</a>/// |
| <a href=#189 id=189 data-nosnippet>189</a>/// What is a `MacroCallId`? Simplifying, it's a `HirFileId` of a file |
| <a href=#190 id=190 data-nosnippet>190</a>/// containing the call plus the offset of the macro call in the file. Note that |
| <a href=#191 id=191 data-nosnippet>191</a>/// this is a recursive definition! However, the size_of of `HirFileId` is |
| <a href=#192 id=192 data-nosnippet>192</a>/// finite (because everything bottoms out at the real `FileId`) and small |
| <a href=#193 id=193 data-nosnippet>193</a>/// (`MacroCallId` uses the location interning. You can check details here: |
| <a href=#194 id=194 data-nosnippet>194</a>/// <https://en.wikipedia.org/wiki/String_interning>). |
| <a href=#195 id=195 data-nosnippet>195</a>/// |
| <a href=#196 id=196 data-nosnippet>196</a>/// Internally this holds a `salsa::Id`, but we cannot use this definition here |
| <a href=#197 id=197 data-nosnippet>197</a>/// as it references things from base-db and hir-expand. |
| <a href=#198 id=198 data-nosnippet>198</a></span><span class="comment">// FIXME: Give this a better fitting name |
| <a href=#199 id=199 data-nosnippet>199</a></span><span class="attr">#[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)] |
| <a href=#200 id=200 data-nosnippet>200</a></span><span class="kw">pub struct </span>HirFileId(<span class="kw">pub </span>salsa::Id); |
| <a href=#201 id=201 data-nosnippet>201</a> |
| <a href=#202 id=202 data-nosnippet>202</a><span class="doccomment">/// `MacroCallId` identifies a particular macro invocation, like |
| <a href=#203 id=203 data-nosnippet>203</a>/// `println!("Hello, {}", world)`. |
| <a href=#204 id=204 data-nosnippet>204</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] |
| <a href=#205 id=205 data-nosnippet>205</a></span><span class="kw">pub struct </span>MacroCallId(<span class="kw">pub </span>salsa::Id);</code></pre></div></section></main></body></html> |
