| <!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/vfs/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="vfs" 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">vfs/</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">//! # Virtual File System |
| <a href=#2 id=2 data-nosnippet>2</a>//! |
| <a href=#3 id=3 data-nosnippet>3</a>//! VFS records all file changes pushed to it via [`set_file_contents`]. |
| <a href=#4 id=4 data-nosnippet>4</a>//! As such it only ever stores changes, not the actual content of a file at any given moment. |
| <a href=#5 id=5 data-nosnippet>5</a>//! All file changes are logged, and can be retrieved via |
| <a href=#6 id=6 data-nosnippet>6</a>//! [`take_changes`] method. The pack of changes is then pushed to `salsa` and |
| <a href=#7 id=7 data-nosnippet>7</a>//! triggers incremental recomputation. |
| <a href=#8 id=8 data-nosnippet>8</a>//! |
| <a href=#9 id=9 data-nosnippet>9</a>//! Files in VFS are identified with [`FileId`]s -- interned paths. The notion of |
| <a href=#10 id=10 data-nosnippet>10</a>//! the path, [`VfsPath`] is somewhat abstract: at the moment, it is represented |
| <a href=#11 id=11 data-nosnippet>11</a>//! as an [`std::path::PathBuf`] internally, but this is an implementation detail. |
| <a href=#12 id=12 data-nosnippet>12</a>//! |
| <a href=#13 id=13 data-nosnippet>13</a>//! VFS doesn't do IO or file watching itself. For that, see the [`loader`] |
| <a href=#14 id=14 data-nosnippet>14</a>//! module. [`loader::Handle`] is an object-safe trait which abstracts both file |
| <a href=#15 id=15 data-nosnippet>15</a>//! loading and file watching. [`Handle`] is dynamically configured with a set of |
| <a href=#16 id=16 data-nosnippet>16</a>//! directory entries which should be scanned and watched. [`Handle`] then |
| <a href=#17 id=17 data-nosnippet>17</a>//! asynchronously pushes file changes. Directory entries are configured in |
| <a href=#18 id=18 data-nosnippet>18</a>//! free-form via list of globs, it's up to the [`Handle`] to interpret the globs |
| <a href=#19 id=19 data-nosnippet>19</a>//! in any specific way. |
| <a href=#20 id=20 data-nosnippet>20</a>//! |
| <a href=#21 id=21 data-nosnippet>21</a>//! VFS stores a flat list of files. [`file_set::FileSet`] can partition this list |
| <a href=#22 id=22 data-nosnippet>22</a>//! of files into disjoint sets of files. Traversal-like operations (including |
| <a href=#23 id=23 data-nosnippet>23</a>//! getting the neighbor file by the relative path) are handled by the [`FileSet`]. |
| <a href=#24 id=24 data-nosnippet>24</a>//! [`FileSet`]s are also pushed to salsa and cause it to re-check `mod foo;` |
| <a href=#25 id=25 data-nosnippet>25</a>//! declarations when files are created or deleted. |
| <a href=#26 id=26 data-nosnippet>26</a>//! |
| <a href=#27 id=27 data-nosnippet>27</a>//! [`FileSet`] and [`loader::Entry`] play similar, but different roles. |
| <a href=#28 id=28 data-nosnippet>28</a>//! Both specify the "set of paths/files", one is geared towards file watching, |
| <a href=#29 id=29 data-nosnippet>29</a>//! the other towards salsa changes. In particular, single [`FileSet`] |
| <a href=#30 id=30 data-nosnippet>30</a>//! may correspond to several [`loader::Entry`]. For example, a crate from |
| <a href=#31 id=31 data-nosnippet>31</a>//! crates.io which uses code generation would have two [`Entries`] -- for sources |
| <a href=#32 id=32 data-nosnippet>32</a>//! in `~/.cargo`, and for generated code in `./target/debug/build`. It will |
| <a href=#33 id=33 data-nosnippet>33</a>//! have a single [`FileSet`] which unions the two sources. |
| <a href=#34 id=34 data-nosnippet>34</a>//! |
| <a href=#35 id=35 data-nosnippet>35</a>//! [`set_file_contents`]: Vfs::set_file_contents |
| <a href=#36 id=36 data-nosnippet>36</a>//! [`take_changes`]: Vfs::take_changes |
| <a href=#37 id=37 data-nosnippet>37</a>//! [`FileSet`]: file_set::FileSet |
| <a href=#38 id=38 data-nosnippet>38</a>//! [`Handle`]: loader::Handle |
| <a href=#39 id=39 data-nosnippet>39</a>//! [`Entries`]: loader::Entry |
| <a href=#40 id=40 data-nosnippet>40</a> |
| <a href=#41 id=41 data-nosnippet>41</a></span><span class="kw">mod </span>anchored_path; |
| <a href=#42 id=42 data-nosnippet>42</a><span class="kw">pub mod </span>file_set; |
| <a href=#43 id=43 data-nosnippet>43</a><span class="kw">pub mod </span>loader; |
| <a href=#44 id=44 data-nosnippet>44</a><span class="kw">mod </span>path_interner; |
| <a href=#45 id=45 data-nosnippet>45</a><span class="kw">mod </span>vfs_path; |
| <a href=#46 id=46 data-nosnippet>46</a> |
| <a href=#47 id=47 data-nosnippet>47</a><span class="kw">use </span>std::{fmt, hash::BuildHasherDefault, mem}; |
| <a href=#48 id=48 data-nosnippet>48</a> |
| <a href=#49 id=49 data-nosnippet>49</a><span class="kw">use </span><span class="kw">crate</span>::path_interner::PathInterner; |
| <a href=#50 id=50 data-nosnippet>50</a> |
| <a href=#51 id=51 data-nosnippet>51</a><span class="kw">pub use crate</span>::{ |
| <a href=#52 id=52 data-nosnippet>52</a> anchored_path::{AnchoredPath, AnchoredPathBuf}, |
| <a href=#53 id=53 data-nosnippet>53</a> vfs_path::VfsPath, |
| <a href=#54 id=54 data-nosnippet>54</a>}; |
| <a href=#55 id=55 data-nosnippet>55</a><span class="kw">use </span>indexmap::{IndexMap, map::Entry}; |
| <a href=#56 id=56 data-nosnippet>56</a><span class="kw">pub use </span>paths::{AbsPath, AbsPathBuf}; |
| <a href=#57 id=57 data-nosnippet>57</a> |
| <a href=#58 id=58 data-nosnippet>58</a><span class="kw">use </span>rustc_hash::FxHasher; |
| <a href=#59 id=59 data-nosnippet>59</a><span class="kw">use </span>stdx::hash_once; |
| <a href=#60 id=60 data-nosnippet>60</a><span class="kw">use </span>tracing::{Level, span}; |
| <a href=#61 id=61 data-nosnippet>61</a> |
| <a href=#62 id=62 data-nosnippet>62</a><span class="doccomment">/// Handle to a file in [`Vfs`] |
| <a href=#63 id=63 data-nosnippet>63</a>/// |
| <a href=#64 id=64 data-nosnippet>64</a>/// Most functions in rust-analyzer use this when they need to refer to a file. |
| <a href=#65 id=65 data-nosnippet>65</a></span><span class="attr">#[derive(Copy, Clone, Debug, Ord, PartialOrd, Eq, PartialEq, Hash)] |
| <a href=#66 id=66 data-nosnippet>66</a></span><span class="kw">pub struct </span>FileId(u32); |
| <a href=#67 id=67 data-nosnippet>67</a><span class="comment">// pub struct FileId(NonMaxU32); |
| <a href=#68 id=68 data-nosnippet>68</a> |
| <a href=#69 id=69 data-nosnippet>69</a></span><span class="kw">impl </span>FileId { |
| <a href=#70 id=70 data-nosnippet>70</a> <span class="kw">const </span>MAX: u32 = <span class="number">0x7fff_ffff</span>; |
| <a href=#71 id=71 data-nosnippet>71</a> |
| <a href=#72 id=72 data-nosnippet>72</a> <span class="attr">#[inline] |
| <a href=#73 id=73 data-nosnippet>73</a> </span><span class="kw">pub const fn </span>from_raw(raw: u32) -> FileId { |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="macro">assert!</span>(raw <= <span class="self">Self</span>::MAX); |
| <a href=#75 id=75 data-nosnippet>75</a> FileId(raw) |
| <a href=#76 id=76 data-nosnippet>76</a> } |
| <a href=#77 id=77 data-nosnippet>77</a> |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="attr">#[inline] |
| <a href=#79 id=79 data-nosnippet>79</a> </span><span class="kw">pub const fn </span>index(<span class="self">self</span>) -> u32 { |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="self">self</span>.<span class="number">0 |
| <a href=#81 id=81 data-nosnippet>81</a> </span>} |
| <a href=#82 id=82 data-nosnippet>82</a>} |
| <a href=#83 id=83 data-nosnippet>83</a> |
| <a href=#84 id=84 data-nosnippet>84</a><span class="doccomment">/// safe because `FileId` is a newtype of `u32` |
| <a href=#85 id=85 data-nosnippet>85</a></span><span class="kw">impl </span>nohash_hasher::IsEnabled <span class="kw">for </span>FileId {} |
| <a href=#86 id=86 data-nosnippet>86</a> |
| <a href=#87 id=87 data-nosnippet>87</a><span class="doccomment">/// Storage for all file changes and the file id to path mapping. |
| <a href=#88 id=88 data-nosnippet>88</a>/// |
| <a href=#89 id=89 data-nosnippet>89</a>/// For more information see the [crate-level](crate) documentation. |
| <a href=#90 id=90 data-nosnippet>90</a></span><span class="attr">#[derive(Default)] |
| <a href=#91 id=91 data-nosnippet>91</a></span><span class="kw">pub struct </span>Vfs { |
| <a href=#92 id=92 data-nosnippet>92</a> interner: PathInterner, |
| <a href=#93 id=93 data-nosnippet>93</a> data: Vec<FileState>, |
| <a href=#94 id=94 data-nosnippet>94</a> changes: IndexMap<FileId, ChangedFile, BuildHasherDefault<FxHasher>>, |
| <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="attr">#[derive(Copy, Clone, Debug, PartialEq, PartialOrd)] |
| <a href=#98 id=98 data-nosnippet>98</a></span><span class="kw">pub enum </span>FileState { |
| <a href=#99 id=99 data-nosnippet>99</a> <span class="doccomment">/// The file exists with the given content hash. |
| <a href=#100 id=100 data-nosnippet>100</a> </span>Exists(u64), |
| <a href=#101 id=101 data-nosnippet>101</a> <span class="doccomment">/// The file is deleted. |
| <a href=#102 id=102 data-nosnippet>102</a> </span>Deleted, |
| <a href=#103 id=103 data-nosnippet>103</a> <span class="doccomment">/// The file was specifically excluded by the user. We still include excluded files |
| <a href=#104 id=104 data-nosnippet>104</a> /// when they're opened (without their contents). |
| <a href=#105 id=105 data-nosnippet>105</a> </span>Excluded, |
| <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="doccomment">/// Changed file in the [`Vfs`]. |
| <a href=#109 id=109 data-nosnippet>109</a></span><span class="attr">#[derive(Debug)] |
| <a href=#110 id=110 data-nosnippet>110</a></span><span class="kw">pub struct </span>ChangedFile { |
| <a href=#111 id=111 data-nosnippet>111</a> <span class="doccomment">/// Id of the changed file |
| <a href=#112 id=112 data-nosnippet>112</a> </span><span class="kw">pub </span>file_id: FileId, |
| <a href=#113 id=113 data-nosnippet>113</a> <span class="doccomment">/// Kind of change |
| <a href=#114 id=114 data-nosnippet>114</a> </span><span class="kw">pub </span>change: Change, |
| <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>ChangedFile { |
| <a href=#118 id=118 data-nosnippet>118</a> <span class="doccomment">/// Returns `true` if the change is not [`Delete`](ChangeKind::Delete). |
| <a href=#119 id=119 data-nosnippet>119</a> </span><span class="kw">pub fn </span>exists(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <a href=#120 id=120 data-nosnippet>120</a> !<span class="macro">matches!</span>(<span class="self">self</span>.change, Change::Delete) |
| <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="doccomment">/// Returns `true` if the change is [`Create`](ChangeKind::Create) or |
| <a href=#124 id=124 data-nosnippet>124</a> /// [`Delete`](Change::Delete). |
| <a href=#125 id=125 data-nosnippet>125</a> </span><span class="kw">pub fn </span>is_created_or_deleted(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <a href=#126 id=126 data-nosnippet>126</a> <span class="macro">matches!</span>(<span class="self">self</span>.change, Change::Create(<span class="kw">_</span>, <span class="kw">_</span>) | Change::Delete) |
| <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="doccomment">/// Returns `true` if the change is [`Create`](ChangeKind::Create). |
| <a href=#130 id=130 data-nosnippet>130</a> </span><span class="kw">pub fn </span>is_created(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <a href=#131 id=131 data-nosnippet>131</a> <span class="macro">matches!</span>(<span class="self">self</span>.change, Change::Create(<span class="kw">_</span>, <span class="kw">_</span>)) |
| <a href=#132 id=132 data-nosnippet>132</a> } |
| <a href=#133 id=133 data-nosnippet>133</a> |
| <a href=#134 id=134 data-nosnippet>134</a> <span class="doccomment">/// Returns `true` if the change is [`Modify`](ChangeKind::Modify). |
| <a href=#135 id=135 data-nosnippet>135</a> </span><span class="kw">pub fn </span>is_modified(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <a href=#136 id=136 data-nosnippet>136</a> <span class="macro">matches!</span>(<span class="self">self</span>.change, Change::Modify(<span class="kw">_</span>, <span class="kw">_</span>)) |
| <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> <span class="kw">pub fn </span>kind(<span class="kw-2">&</span><span class="self">self</span>) -> ChangeKind { |
| <a href=#140 id=140 data-nosnippet>140</a> <span class="kw">match </span><span class="self">self</span>.change { |
| <a href=#141 id=141 data-nosnippet>141</a> Change::Create(<span class="kw">_</span>, <span class="kw">_</span>) => ChangeKind::Create, |
| <a href=#142 id=142 data-nosnippet>142</a> Change::Modify(<span class="kw">_</span>, <span class="kw">_</span>) => ChangeKind::Modify, |
| <a href=#143 id=143 data-nosnippet>143</a> Change::Delete => ChangeKind::Delete, |
| <a href=#144 id=144 data-nosnippet>144</a> } |
| <a href=#145 id=145 data-nosnippet>145</a> } |
| <a href=#146 id=146 data-nosnippet>146</a>} |
| <a href=#147 id=147 data-nosnippet>147</a> |
| <a href=#148 id=148 data-nosnippet>148</a><span class="doccomment">/// Kind of [file change](ChangedFile). |
| <a href=#149 id=149 data-nosnippet>149</a></span><span class="attr">#[derive(Eq, PartialEq, Debug)] |
| <a href=#150 id=150 data-nosnippet>150</a></span><span class="kw">pub enum </span>Change { |
| <a href=#151 id=151 data-nosnippet>151</a> <span class="doccomment">/// The file was (re-)created |
| <a href=#152 id=152 data-nosnippet>152</a> </span>Create(Vec<u8>, u64), |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="doccomment">/// The file was modified |
| <a href=#154 id=154 data-nosnippet>154</a> </span>Modify(Vec<u8>, u64), |
| <a href=#155 id=155 data-nosnippet>155</a> <span class="doccomment">/// The file was deleted |
| <a href=#156 id=156 data-nosnippet>156</a> </span>Delete, |
| <a href=#157 id=157 data-nosnippet>157</a>} |
| <a href=#158 id=158 data-nosnippet>158</a> |
| <a href=#159 id=159 data-nosnippet>159</a><span class="doccomment">/// Kind of [file change](ChangedFile). |
| <a href=#160 id=160 data-nosnippet>160</a></span><span class="attr">#[derive(Eq, PartialEq, Debug)] |
| <a href=#161 id=161 data-nosnippet>161</a></span><span class="kw">pub enum </span>ChangeKind { |
| <a href=#162 id=162 data-nosnippet>162</a> <span class="doccomment">/// The file was (re-)created |
| <a href=#163 id=163 data-nosnippet>163</a> </span>Create, |
| <a href=#164 id=164 data-nosnippet>164</a> <span class="doccomment">/// The file was modified |
| <a href=#165 id=165 data-nosnippet>165</a> </span>Modify, |
| <a href=#166 id=166 data-nosnippet>166</a> <span class="doccomment">/// The file was deleted |
| <a href=#167 id=167 data-nosnippet>167</a> </span>Delete, |
| <a href=#168 id=168 data-nosnippet>168</a>} |
| <a href=#169 id=169 data-nosnippet>169</a> |
| <a href=#170 id=170 data-nosnippet>170</a><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| <a href=#171 id=171 data-nosnippet>171</a></span><span class="kw">pub enum </span>FileExcluded { |
| <a href=#172 id=172 data-nosnippet>172</a> Yes, |
| <a href=#173 id=173 data-nosnippet>173</a> No, |
| <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="kw">impl </span>Vfs { |
| <a href=#177 id=177 data-nosnippet>177</a> <span class="doccomment">/// Id of the given path if it exists in the `Vfs` and is not deleted. |
| <a href=#178 id=178 data-nosnippet>178</a> </span><span class="kw">pub fn </span>file_id(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw-2">&</span>VfsPath) -> <span class="prelude-ty">Option</span><(FileId, FileExcluded)> { |
| <a href=#179 id=179 data-nosnippet>179</a> <span class="kw">let </span>file_id = <span class="self">self</span>.interner.get(path)<span class="question-mark">?</span>; |
| <a href=#180 id=180 data-nosnippet>180</a> <span class="kw">let </span>file_state = <span class="self">self</span>.get(file_id); |
| <a href=#181 id=181 data-nosnippet>181</a> <span class="kw">match </span>file_state { |
| <a href=#182 id=182 data-nosnippet>182</a> FileState::Exists(<span class="kw">_</span>) => <span class="prelude-val">Some</span>((file_id, FileExcluded::No)), |
| <a href=#183 id=183 data-nosnippet>183</a> FileState::Deleted => <span class="prelude-val">None</span>, |
| <a href=#184 id=184 data-nosnippet>184</a> FileState::Excluded => <span class="prelude-val">Some</span>((file_id, FileExcluded::Yes)), |
| <a href=#185 id=185 data-nosnippet>185</a> } |
| <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="doccomment">/// File path corresponding to the given `file_id`. |
| <a href=#189 id=189 data-nosnippet>189</a> /// |
| <a href=#190 id=190 data-nosnippet>190</a> /// # Panics |
| <a href=#191 id=191 data-nosnippet>191</a> /// |
| <a href=#192 id=192 data-nosnippet>192</a> /// Panics if the id is not present in the `Vfs`. |
| <a href=#193 id=193 data-nosnippet>193</a> </span><span class="kw">pub fn </span>file_path(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> <span class="kw-2">&</span>VfsPath { |
| <a href=#194 id=194 data-nosnippet>194</a> <span class="self">self</span>.interner.lookup(file_id) |
| <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="doccomment">/// Returns an iterator over the stored ids and their corresponding paths. |
| <a href=#198 id=198 data-nosnippet>198</a> /// |
| <a href=#199 id=199 data-nosnippet>199</a> /// This will skip deleted files. |
| <a href=#200 id=200 data-nosnippet>200</a> </span><span class="kw">pub fn </span>iter(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw">impl </span>Iterator<Item = (FileId, <span class="kw-2">&</span>VfsPath)> + <span class="lifetime">'_ </span>{ |
| <a href=#201 id=201 data-nosnippet>201</a> (<span class="number">0</span>..<span class="self">self</span>.data.len()) |
| <a href=#202 id=202 data-nosnippet>202</a> .map(|it| FileId(it <span class="kw">as </span>u32)) |
| <a href=#203 id=203 data-nosnippet>203</a> .filter(<span class="kw">move </span>|<span class="kw-2">&</span>file_id| <span class="macro">matches!</span>(<span class="self">self</span>.get(file_id), FileState::Exists(<span class="kw">_</span>))) |
| <a href=#204 id=204 data-nosnippet>204</a> .map(<span class="kw">move </span>|file_id| { |
| <a href=#205 id=205 data-nosnippet>205</a> <span class="kw">let </span>path = <span class="self">self</span>.interner.lookup(file_id); |
| <a href=#206 id=206 data-nosnippet>206</a> (file_id, path) |
| <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="doccomment">/// Update the `path` with the given `contents`. `None` means the file was deleted. |
| <a href=#211 id=211 data-nosnippet>211</a> /// |
| <a href=#212 id=212 data-nosnippet>212</a> /// Returns `true` if the file was modified, and saves the [change](ChangedFile). |
| <a href=#213 id=213 data-nosnippet>213</a> /// |
| <a href=#214 id=214 data-nosnippet>214</a> /// If the path does not currently exists in the `Vfs`, allocates a new |
| <a href=#215 id=215 data-nosnippet>215</a> /// [`FileId`] for it. |
| <a href=#216 id=216 data-nosnippet>216</a> </span><span class="kw">pub fn </span>set_file_contents(<span class="kw-2">&mut </span><span class="self">self</span>, path: VfsPath, contents: <span class="prelude-ty">Option</span><Vec<u8>>) -> bool { |
| <a href=#217 id=217 data-nosnippet>217</a> <span class="kw">let </span>_p = <span class="macro">span!</span>(Level::INFO, <span class="string">"Vfs::set_file_contents"</span>).entered(); |
| <a href=#218 id=218 data-nosnippet>218</a> <span class="kw">let </span>file_id = <span class="self">self</span>.alloc_file_id(path); |
| <a href=#219 id=219 data-nosnippet>219</a> <span class="kw">let </span>state: FileState = <span class="self">self</span>.get(file_id); |
| <a href=#220 id=220 data-nosnippet>220</a> <span class="kw">let </span>change = <span class="kw">match </span>(state, contents) { |
| <a href=#221 id=221 data-nosnippet>221</a> (FileState::Deleted, <span class="prelude-val">None</span>) => <span class="kw">return </span><span class="bool-val">false</span>, |
| <a href=#222 id=222 data-nosnippet>222</a> (FileState::Deleted, <span class="prelude-val">Some</span>(v)) => { |
| <a href=#223 id=223 data-nosnippet>223</a> <span class="kw">let </span>hash = hash_once::<FxHasher>(<span class="kw-2">&*</span>v); |
| <a href=#224 id=224 data-nosnippet>224</a> Change::Create(v, hash) |
| <a href=#225 id=225 data-nosnippet>225</a> } |
| <a href=#226 id=226 data-nosnippet>226</a> (FileState::Exists(<span class="kw">_</span>), <span class="prelude-val">None</span>) => Change::Delete, |
| <a href=#227 id=227 data-nosnippet>227</a> (FileState::Exists(hash), <span class="prelude-val">Some</span>(v)) => { |
| <a href=#228 id=228 data-nosnippet>228</a> <span class="kw">let </span>new_hash = hash_once::<FxHasher>(<span class="kw-2">&*</span>v); |
| <a href=#229 id=229 data-nosnippet>229</a> <span class="kw">if </span>new_hash == hash { |
| <a href=#230 id=230 data-nosnippet>230</a> <span class="kw">return </span><span class="bool-val">false</span>; |
| <a href=#231 id=231 data-nosnippet>231</a> } |
| <a href=#232 id=232 data-nosnippet>232</a> Change::Modify(v, new_hash) |
| <a href=#233 id=233 data-nosnippet>233</a> } |
| <a href=#234 id=234 data-nosnippet>234</a> (FileState::Excluded, <span class="kw">_</span>) => <span class="kw">return </span><span class="bool-val">false</span>, |
| <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="kw">let </span><span class="kw-2">mut </span>set_data = |change_kind| { |
| <a href=#238 id=238 data-nosnippet>238</a> <span class="self">self</span>.data[file_id.<span class="number">0 </span><span class="kw">as </span>usize] = <span class="kw">match </span>change_kind { |
| <a href=#239 id=239 data-nosnippet>239</a> <span class="kw-2">&</span>Change::Create(<span class="kw">_</span>, hash) | <span class="kw-2">&</span>Change::Modify(<span class="kw">_</span>, hash) => FileState::Exists(hash), |
| <a href=#240 id=240 data-nosnippet>240</a> Change::Delete => FileState::Deleted, |
| <a href=#241 id=241 data-nosnippet>241</a> }; |
| <a href=#242 id=242 data-nosnippet>242</a> }; |
| <a href=#243 id=243 data-nosnippet>243</a> |
| <a href=#244 id=244 data-nosnippet>244</a> <span class="kw">let </span>changed_file = ChangedFile { file_id, change }; |
| <a href=#245 id=245 data-nosnippet>245</a> <span class="kw">match </span><span class="self">self</span>.changes.entry(file_id) { |
| <a href=#246 id=246 data-nosnippet>246</a> <span class="comment">// two changes to the same file in one cycle, merge them appropriately |
| <a href=#247 id=247 data-nosnippet>247</a> </span>Entry::Occupied(<span class="kw-2">mut </span>o) => { |
| <a href=#248 id=248 data-nosnippet>248</a> <span class="kw">use </span>Change::<span class="kw-2">*</span>; |
| <a href=#249 id=249 data-nosnippet>249</a> |
| <a href=#250 id=250 data-nosnippet>250</a> <span class="kw">match </span>(<span class="kw-2">&mut </span>o.get_mut().change, changed_file.change) { |
| <a href=#251 id=251 data-nosnippet>251</a> <span class="comment">// newer `Delete` wins |
| <a href=#252 id=252 data-nosnippet>252</a> </span>(change, Delete) => <span class="kw-2">*</span>change = Delete, |
| <a href=#253 id=253 data-nosnippet>253</a> <span class="comment">// merge `Create` with `Create` or `Modify` |
| <a href=#254 id=254 data-nosnippet>254</a> </span>(Create(prev, old_hash), Create(new, new_hash) | Modify(new, new_hash)) => { |
| <a href=#255 id=255 data-nosnippet>255</a> <span class="kw-2">*</span>prev = new; |
| <a href=#256 id=256 data-nosnippet>256</a> <span class="kw-2">*</span>old_hash = new_hash; |
| <a href=#257 id=257 data-nosnippet>257</a> } |
| <a href=#258 id=258 data-nosnippet>258</a> <span class="comment">// collapse identical `Modify`es |
| <a href=#259 id=259 data-nosnippet>259</a> </span>(Modify(prev, old_hash), Modify(new, new_hash)) => { |
| <a href=#260 id=260 data-nosnippet>260</a> <span class="kw-2">*</span>prev = new; |
| <a href=#261 id=261 data-nosnippet>261</a> <span class="kw-2">*</span>old_hash = new_hash; |
| <a href=#262 id=262 data-nosnippet>262</a> } |
| <a href=#263 id=263 data-nosnippet>263</a> <span class="comment">// equivalent to `Modify` |
| <a href=#264 id=264 data-nosnippet>264</a> </span>(change @ Delete, Create(new, new_hash)) => { |
| <a href=#265 id=265 data-nosnippet>265</a> <span class="kw-2">*</span>change = Modify(new, new_hash); |
| <a href=#266 id=266 data-nosnippet>266</a> } |
| <a href=#267 id=267 data-nosnippet>267</a> <span class="comment">// shouldn't occur, but collapse into `Create` |
| <a href=#268 id=268 data-nosnippet>268</a> </span>(change @ Delete, Modify(new, new_hash)) => { |
| <a href=#269 id=269 data-nosnippet>269</a> <span class="macro">stdx::never!</span>(); |
| <a href=#270 id=270 data-nosnippet>270</a> <span class="kw-2">*</span>change = Create(new, new_hash); |
| <a href=#271 id=271 data-nosnippet>271</a> } |
| <a href=#272 id=272 data-nosnippet>272</a> <span class="comment">// shouldn't occur, but keep the Create |
| <a href=#273 id=273 data-nosnippet>273</a> </span>(prev @ Modify(<span class="kw">_</span>, <span class="kw">_</span>), new @ Create(<span class="kw">_</span>, <span class="kw">_</span>)) => <span class="kw-2">*</span>prev = new, |
| <a href=#274 id=274 data-nosnippet>274</a> } |
| <a href=#275 id=275 data-nosnippet>275</a> set_data(<span class="kw-2">&</span>o.get().change); |
| <a href=#276 id=276 data-nosnippet>276</a> } |
| <a href=#277 id=277 data-nosnippet>277</a> Entry::Vacant(v) => set_data(<span class="kw-2">&</span>v.insert(changed_file).change), |
| <a href=#278 id=278 data-nosnippet>278</a> }; |
| <a href=#279 id=279 data-nosnippet>279</a> |
| <a href=#280 id=280 data-nosnippet>280</a> <span class="bool-val">true |
| <a href=#281 id=281 data-nosnippet>281</a> </span>} |
| <a href=#282 id=282 data-nosnippet>282</a> |
| <a href=#283 id=283 data-nosnippet>283</a> <span class="doccomment">/// Drain and returns all the changes in the `Vfs`. |
| <a href=#284 id=284 data-nosnippet>284</a> </span><span class="kw">pub fn </span>take_changes(<span class="kw-2">&mut </span><span class="self">self</span>) -> IndexMap<FileId, ChangedFile, BuildHasherDefault<FxHasher>> { |
| <a href=#285 id=285 data-nosnippet>285</a> mem::take(<span class="kw-2">&mut </span><span class="self">self</span>.changes) |
| <a href=#286 id=286 data-nosnippet>286</a> } |
| <a href=#287 id=287 data-nosnippet>287</a> |
| <a href=#288 id=288 data-nosnippet>288</a> <span class="doccomment">/// Provides a panic-less way to verify file_id validity. |
| <a href=#289 id=289 data-nosnippet>289</a> </span><span class="kw">pub fn </span>exists(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> bool { |
| <a href=#290 id=290 data-nosnippet>290</a> <span class="macro">matches!</span>(<span class="self">self</span>.get(file_id), FileState::Exists(<span class="kw">_</span>)) |
| <a href=#291 id=291 data-nosnippet>291</a> } |
| <a href=#292 id=292 data-nosnippet>292</a> |
| <a href=#293 id=293 data-nosnippet>293</a> <span class="doccomment">/// Returns the id associated with `path` |
| <a href=#294 id=294 data-nosnippet>294</a> /// |
| <a href=#295 id=295 data-nosnippet>295</a> /// - If `path` does not exists in the `Vfs`, allocate a new id for it, associated with a |
| <a href=#296 id=296 data-nosnippet>296</a> /// deleted file; |
| <a href=#297 id=297 data-nosnippet>297</a> /// - Else, returns `path`'s id. |
| <a href=#298 id=298 data-nosnippet>298</a> /// |
| <a href=#299 id=299 data-nosnippet>299</a> /// Does not record a change. |
| <a href=#300 id=300 data-nosnippet>300</a> </span><span class="kw">fn </span>alloc_file_id(<span class="kw-2">&mut </span><span class="self">self</span>, path: VfsPath) -> FileId { |
| <a href=#301 id=301 data-nosnippet>301</a> <span class="kw">let </span>file_id = <span class="self">self</span>.interner.intern(path); |
| <a href=#302 id=302 data-nosnippet>302</a> <span class="kw">let </span>idx = file_id.<span class="number">0 </span><span class="kw">as </span>usize; |
| <a href=#303 id=303 data-nosnippet>303</a> <span class="kw">let </span>len = <span class="self">self</span>.data.len().max(idx + <span class="number">1</span>); |
| <a href=#304 id=304 data-nosnippet>304</a> <span class="self">self</span>.data.resize(len, FileState::Deleted); |
| <a href=#305 id=305 data-nosnippet>305</a> file_id |
| <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> <span class="doccomment">/// Returns the status of the file associated with the given `file_id`. |
| <a href=#309 id=309 data-nosnippet>309</a> /// |
| <a href=#310 id=310 data-nosnippet>310</a> /// # Panics |
| <a href=#311 id=311 data-nosnippet>311</a> /// |
| <a href=#312 id=312 data-nosnippet>312</a> /// Panics if no file is associated to that id. |
| <a href=#313 id=313 data-nosnippet>313</a> </span><span class="kw">fn </span>get(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> FileState { |
| <a href=#314 id=314 data-nosnippet>314</a> <span class="self">self</span>.data[file_id.<span class="number">0 </span><span class="kw">as </span>usize] |
| <a href=#315 id=315 data-nosnippet>315</a> } |
| <a href=#316 id=316 data-nosnippet>316</a> |
| <a href=#317 id=317 data-nosnippet>317</a> <span class="doccomment">/// We cannot ignore excluded files, because this will lead to errors when the client |
| <a href=#318 id=318 data-nosnippet>318</a> /// requests semantic information for them, so we instead mark them specially. |
| <a href=#319 id=319 data-nosnippet>319</a> </span><span class="kw">pub fn </span>insert_excluded_file(<span class="kw-2">&mut </span><span class="self">self</span>, path: VfsPath) { |
| <a href=#320 id=320 data-nosnippet>320</a> <span class="kw">let </span>file_id = <span class="self">self</span>.alloc_file_id(path); |
| <a href=#321 id=321 data-nosnippet>321</a> <span class="self">self</span>.data[file_id.<span class="number">0 </span><span class="kw">as </span>usize] = FileState::Excluded; |
| <a href=#322 id=322 data-nosnippet>322</a> } |
| <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="kw">impl </span>fmt::Debug <span class="kw">for </span>Vfs { |
| <a href=#326 id=326 data-nosnippet>326</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=#327 id=327 data-nosnippet>327</a> f.debug_struct(<span class="string">"Vfs"</span>).field(<span class="string">"n_files"</span>, <span class="kw-2">&</span><span class="self">self</span>.data.len()).finish() |
| <a href=#328 id=328 data-nosnippet>328</a> } |
| <a href=#329 id=329 data-nosnippet>329</a>}</code></pre></div></section></main></body></html> |
