| <!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/ide/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-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ide" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0 (1159e78c4 2025-09-14)" data-channel="1.90.0" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-68b7e25d.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-eebb9057.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">ide/</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">//! ide crate provides "ide-centric" APIs for the rust-analyzer. That is, |
| <a href=#2 id=2 data-nosnippet>2</a>//! it generally operates with files and text ranges, and returns results as |
| <a href=#3 id=3 data-nosnippet>3</a>//! Strings, suitable for displaying to the human. |
| <a href=#4 id=4 data-nosnippet>4</a>//! |
| <a href=#5 id=5 data-nosnippet>5</a>//! What powers this API are the `RootDatabase` struct, which defines a `salsa` |
| <a href=#6 id=6 data-nosnippet>6</a>//! database, and the `hir` crate, where majority of the analysis happens. |
| <a href=#7 id=7 data-nosnippet>7</a>//! However, IDE specific bits of the analysis (most notably completion) happen |
| <a href=#8 id=8 data-nosnippet>8</a>//! in this crate. |
| <a href=#9 id=9 data-nosnippet>9</a> |
| <a href=#10 id=10 data-nosnippet>10</a></span><span class="comment">// For proving that RootDatabase is RefUnwindSafe. |
| <a href=#11 id=11 data-nosnippet>11</a> |
| <a href=#12 id=12 data-nosnippet>12</a></span><span class="attr">#![cfg_attr(feature = <span class="string">"in-rust-tree"</span>, feature(rustc_private))] |
| <a href=#13 id=13 data-nosnippet>13</a>#![recursion_limit = <span class="string">"128"</span>] |
| <a href=#14 id=14 data-nosnippet>14</a> |
| <a href=#15 id=15 data-nosnippet>15</a>#[cfg(test)] |
| <a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">mod </span>fixture; |
| <a href=#17 id=17 data-nosnippet>17</a> |
| <a href=#18 id=18 data-nosnippet>18</a><span class="kw">mod </span>markup; |
| <a href=#19 id=19 data-nosnippet>19</a><span class="kw">mod </span>navigation_target; |
| <a href=#20 id=20 data-nosnippet>20</a> |
| <a href=#21 id=21 data-nosnippet>21</a><span class="kw">mod </span>annotations; |
| <a href=#22 id=22 data-nosnippet>22</a><span class="kw">mod </span>call_hierarchy; |
| <a href=#23 id=23 data-nosnippet>23</a><span class="kw">mod </span>child_modules; |
| <a href=#24 id=24 data-nosnippet>24</a><span class="kw">mod </span>doc_links; |
| <a href=#25 id=25 data-nosnippet>25</a><span class="kw">mod </span>expand_macro; |
| <a href=#26 id=26 data-nosnippet>26</a><span class="kw">mod </span>extend_selection; |
| <a href=#27 id=27 data-nosnippet>27</a><span class="kw">mod </span>fetch_crates; |
| <a href=#28 id=28 data-nosnippet>28</a><span class="kw">mod </span>file_structure; |
| <a href=#29 id=29 data-nosnippet>29</a><span class="kw">mod </span>folding_ranges; |
| <a href=#30 id=30 data-nosnippet>30</a><span class="kw">mod </span>goto_declaration; |
| <a href=#31 id=31 data-nosnippet>31</a><span class="kw">mod </span>goto_definition; |
| <a href=#32 id=32 data-nosnippet>32</a><span class="kw">mod </span>goto_implementation; |
| <a href=#33 id=33 data-nosnippet>33</a><span class="kw">mod </span>goto_type_definition; |
| <a href=#34 id=34 data-nosnippet>34</a><span class="kw">mod </span>highlight_related; |
| <a href=#35 id=35 data-nosnippet>35</a><span class="kw">mod </span>hover; |
| <a href=#36 id=36 data-nosnippet>36</a><span class="kw">mod </span>inlay_hints; |
| <a href=#37 id=37 data-nosnippet>37</a><span class="kw">mod </span>interpret; |
| <a href=#38 id=38 data-nosnippet>38</a><span class="kw">mod </span>join_lines; |
| <a href=#39 id=39 data-nosnippet>39</a><span class="kw">mod </span>markdown_remove; |
| <a href=#40 id=40 data-nosnippet>40</a><span class="kw">mod </span>matching_brace; |
| <a href=#41 id=41 data-nosnippet>41</a><span class="kw">mod </span>moniker; |
| <a href=#42 id=42 data-nosnippet>42</a><span class="kw">mod </span>move_item; |
| <a href=#43 id=43 data-nosnippet>43</a><span class="kw">mod </span>parent_module; |
| <a href=#44 id=44 data-nosnippet>44</a><span class="kw">mod </span>references; |
| <a href=#45 id=45 data-nosnippet>45</a><span class="kw">mod </span>rename; |
| <a href=#46 id=46 data-nosnippet>46</a><span class="kw">mod </span>runnables; |
| <a href=#47 id=47 data-nosnippet>47</a><span class="kw">mod </span>signature_help; |
| <a href=#48 id=48 data-nosnippet>48</a><span class="kw">mod </span>ssr; |
| <a href=#49 id=49 data-nosnippet>49</a><span class="kw">mod </span>static_index; |
| <a href=#50 id=50 data-nosnippet>50</a><span class="kw">mod </span>status; |
| <a href=#51 id=51 data-nosnippet>51</a><span class="kw">mod </span>syntax_highlighting; |
| <a href=#52 id=52 data-nosnippet>52</a><span class="kw">mod </span>test_explorer; |
| <a href=#53 id=53 data-nosnippet>53</a><span class="kw">mod </span>typing; |
| <a href=#54 id=54 data-nosnippet>54</a><span class="kw">mod </span>view_crate_graph; |
| <a href=#55 id=55 data-nosnippet>55</a><span class="kw">mod </span>view_hir; |
| <a href=#56 id=56 data-nosnippet>56</a><span class="kw">mod </span>view_item_tree; |
| <a href=#57 id=57 data-nosnippet>57</a><span class="kw">mod </span>view_memory_layout; |
| <a href=#58 id=58 data-nosnippet>58</a><span class="kw">mod </span>view_mir; |
| <a href=#59 id=59 data-nosnippet>59</a><span class="kw">mod </span>view_syntax_tree; |
| <a href=#60 id=60 data-nosnippet>60</a> |
| <a href=#61 id=61 data-nosnippet>61</a><span class="kw">use </span>std::panic::{AssertUnwindSafe, UnwindSafe}; |
| <a href=#62 id=62 data-nosnippet>62</a> |
| <a href=#63 id=63 data-nosnippet>63</a><span class="kw">use </span>cfg::CfgOptions; |
| <a href=#64 id=64 data-nosnippet>64</a><span class="kw">use </span>fetch_crates::CrateInfo; |
| <a href=#65 id=65 data-nosnippet>65</a><span class="kw">use </span>hir::{ChangeWithProcMacros, EditionedFileId, crate_def_map, sym}; |
| <a href=#66 id=66 data-nosnippet>66</a><span class="kw">use </span>ide_db::{ |
| <a href=#67 id=67 data-nosnippet>67</a> FxHashMap, FxIndexSet, LineIndexDatabase, |
| <a href=#68 id=68 data-nosnippet>68</a> base_db::{ |
| <a href=#69 id=69 data-nosnippet>69</a> CrateOrigin, CrateWorkspaceData, Env, FileSet, RootQueryDb, SourceDatabase, VfsPath, |
| <a href=#70 id=70 data-nosnippet>70</a> salsa::Cancelled, |
| <a href=#71 id=71 data-nosnippet>71</a> }, |
| <a href=#72 id=72 data-nosnippet>72</a> prime_caches, symbol_index, |
| <a href=#73 id=73 data-nosnippet>73</a>}; |
| <a href=#74 id=74 data-nosnippet>74</a><span class="kw">use </span>ide_db::{MiniCore, ra_fixture::RaFixtureAnalysis}; |
| <a href=#75 id=75 data-nosnippet>75</a><span class="kw">use </span>macros::UpmapFromRaFixture; |
| <a href=#76 id=76 data-nosnippet>76</a><span class="kw">use </span>syntax::{SourceFile, ast}; |
| <a href=#77 id=77 data-nosnippet>77</a><span class="kw">use </span>triomphe::Arc; |
| <a href=#78 id=78 data-nosnippet>78</a><span class="kw">use </span>view_memory_layout::{RecursiveMemoryLayout, view_memory_layout}; |
| <a href=#79 id=79 data-nosnippet>79</a> |
| <a href=#80 id=80 data-nosnippet>80</a><span class="kw">use </span><span class="kw">crate</span>::navigation_target::ToNav; |
| <a href=#81 id=81 data-nosnippet>81</a> |
| <a href=#82 id=82 data-nosnippet>82</a><span class="kw">pub use crate</span>::{ |
| <a href=#83 id=83 data-nosnippet>83</a> annotations::{Annotation, AnnotationConfig, AnnotationKind, AnnotationLocation}, |
| <a href=#84 id=84 data-nosnippet>84</a> call_hierarchy::{CallHierarchyConfig, CallItem}, |
| <a href=#85 id=85 data-nosnippet>85</a> expand_macro::ExpandedMacro, |
| <a href=#86 id=86 data-nosnippet>86</a> file_structure::{FileStructureConfig, StructureNode, StructureNodeKind}, |
| <a href=#87 id=87 data-nosnippet>87</a> folding_ranges::{Fold, FoldKind}, |
| <a href=#88 id=88 data-nosnippet>88</a> goto_definition::GotoDefinitionConfig, |
| <a href=#89 id=89 data-nosnippet>89</a> goto_implementation::GotoImplementationConfig, |
| <a href=#90 id=90 data-nosnippet>90</a> highlight_related::{HighlightRelatedConfig, HighlightedRange}, |
| <a href=#91 id=91 data-nosnippet>91</a> hover::{ |
| <a href=#92 id=92 data-nosnippet>92</a> HoverAction, HoverConfig, HoverDocFormat, HoverGotoTypeData, HoverResult, |
| <a href=#93 id=93 data-nosnippet>93</a> MemoryLayoutHoverConfig, MemoryLayoutHoverRenderKind, SubstTyLen, |
| <a href=#94 id=94 data-nosnippet>94</a> }, |
| <a href=#95 id=95 data-nosnippet>95</a> inlay_hints::{ |
| <a href=#96 id=96 data-nosnippet>96</a> AdjustmentHints, AdjustmentHintsMode, ClosureReturnTypeHints, DiscriminantHints, |
| <a href=#97 id=97 data-nosnippet>97</a> GenericParameterHints, InlayFieldsToResolve, InlayHint, InlayHintLabel, InlayHintLabelPart, |
| <a href=#98 id=98 data-nosnippet>98</a> InlayHintPosition, InlayHintsConfig, InlayKind, InlayTooltip, LazyProperty, |
| <a href=#99 id=99 data-nosnippet>99</a> LifetimeElisionHints, |
| <a href=#100 id=100 data-nosnippet>100</a> }, |
| <a href=#101 id=101 data-nosnippet>101</a> join_lines::JoinLinesConfig, |
| <a href=#102 id=102 data-nosnippet>102</a> markup::Markup, |
| <a href=#103 id=103 data-nosnippet>103</a> moniker::{ |
| <a href=#104 id=104 data-nosnippet>104</a> Moniker, MonikerDescriptorKind, MonikerIdentifier, MonikerKind, MonikerResult, |
| <a href=#105 id=105 data-nosnippet>105</a> PackageInformation, SymbolInformationKind, |
| <a href=#106 id=106 data-nosnippet>106</a> }, |
| <a href=#107 id=107 data-nosnippet>107</a> move_item::Direction, |
| <a href=#108 id=108 data-nosnippet>108</a> navigation_target::{NavigationTarget, TryToNav, UpmappingResult}, |
| <a href=#109 id=109 data-nosnippet>109</a> references::{FindAllRefsConfig, ReferenceSearchResult}, |
| <a href=#110 id=110 data-nosnippet>110</a> rename::{RenameConfig, RenameError}, |
| <a href=#111 id=111 data-nosnippet>111</a> runnables::{Runnable, RunnableKind, TestId, UpdateTest}, |
| <a href=#112 id=112 data-nosnippet>112</a> signature_help::SignatureHelp, |
| <a href=#113 id=113 data-nosnippet>113</a> static_index::{ |
| <a href=#114 id=114 data-nosnippet>114</a> StaticIndex, StaticIndexedFile, TokenId, TokenStaticData, VendoredLibrariesConfig, |
| <a href=#115 id=115 data-nosnippet>115</a> }, |
| <a href=#116 id=116 data-nosnippet>116</a> syntax_highlighting::{ |
| <a href=#117 id=117 data-nosnippet>117</a> HighlightConfig, HlRange, |
| <a href=#118 id=118 data-nosnippet>118</a> tags::{Highlight, HlMod, HlMods, HlOperator, HlPunct, HlTag}, |
| <a href=#119 id=119 data-nosnippet>119</a> }, |
| <a href=#120 id=120 data-nosnippet>120</a> test_explorer::{TestItem, TestItemKind}, |
| <a href=#121 id=121 data-nosnippet>121</a>}; |
| <a href=#122 id=122 data-nosnippet>122</a><span class="kw">pub use </span>hir::Semantics; |
| <a href=#123 id=123 data-nosnippet>123</a><span class="kw">pub use </span>ide_assists::{ |
| <a href=#124 id=124 data-nosnippet>124</a> Assist, AssistConfig, AssistId, AssistKind, AssistResolveStrategy, SingleResolve, |
| <a href=#125 id=125 data-nosnippet>125</a>}; |
| <a href=#126 id=126 data-nosnippet>126</a><span class="kw">pub use </span>ide_completion::{ |
| <a href=#127 id=127 data-nosnippet>127</a> CallableSnippets, CompletionConfig, CompletionFieldsToResolve, CompletionItem, |
| <a href=#128 id=128 data-nosnippet>128</a> CompletionItemKind, CompletionItemRefMode, CompletionRelevance, Snippet, SnippetScope, |
| <a href=#129 id=129 data-nosnippet>129</a>}; |
| <a href=#130 id=130 data-nosnippet>130</a><span class="kw">pub use </span>ide_db::{ |
| <a href=#131 id=131 data-nosnippet>131</a> FileId, FilePosition, FileRange, RootDatabase, Severity, SymbolKind, |
| <a href=#132 id=132 data-nosnippet>132</a> assists::ExprFillDefaultMode, |
| <a href=#133 id=133 data-nosnippet>133</a> base_db::{Crate, CrateGraphBuilder, FileChange, SourceRoot, SourceRootId}, |
| <a href=#134 id=134 data-nosnippet>134</a> documentation::Documentation, |
| <a href=#135 id=135 data-nosnippet>135</a> label::Label, |
| <a href=#136 id=136 data-nosnippet>136</a> line_index::{LineCol, LineIndex}, |
| <a href=#137 id=137 data-nosnippet>137</a> prime_caches::ParallelPrimeCachesProgress, |
| <a href=#138 id=138 data-nosnippet>138</a> search::{ReferenceCategory, SearchScope}, |
| <a href=#139 id=139 data-nosnippet>139</a> source_change::{FileSystemEdit, SnippetEdit, SourceChange}, |
| <a href=#140 id=140 data-nosnippet>140</a> symbol_index::Query, |
| <a href=#141 id=141 data-nosnippet>141</a> text_edit::{Indel, TextEdit}, |
| <a href=#142 id=142 data-nosnippet>142</a>}; |
| <a href=#143 id=143 data-nosnippet>143</a><span class="kw">pub use </span>ide_diagnostics::{Diagnostic, DiagnosticCode, DiagnosticsConfig}; |
| <a href=#144 id=144 data-nosnippet>144</a><span class="kw">pub use </span>ide_ssr::SsrError; |
| <a href=#145 id=145 data-nosnippet>145</a><span class="kw">pub use </span>span::Edition; |
| <a href=#146 id=146 data-nosnippet>146</a><span class="kw">pub use </span>syntax::{TextRange, TextSize}; |
| <a href=#147 id=147 data-nosnippet>147</a> |
| <a href=#148 id=148 data-nosnippet>148</a><span class="kw">pub type </span>Cancellable<T> = <span class="prelude-ty">Result</span><T, Cancelled>; |
| <a href=#149 id=149 data-nosnippet>149</a> |
| <a href=#150 id=150 data-nosnippet>150</a><span class="doccomment">/// Info associated with a text range. |
| <a href=#151 id=151 data-nosnippet>151</a></span><span class="attr">#[derive(Debug, UpmapFromRaFixture)] |
| <a href=#152 id=152 data-nosnippet>152</a></span><span class="kw">pub struct </span>RangeInfo<T> { |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="kw">pub </span>range: TextRange, |
| <a href=#154 id=154 data-nosnippet>154</a> <span class="kw">pub </span>info: T, |
| <a href=#155 id=155 data-nosnippet>155</a>} |
| <a href=#156 id=156 data-nosnippet>156</a> |
| <a href=#157 id=157 data-nosnippet>157</a><span class="kw">impl</span><T> RangeInfo<T> { |
| <a href=#158 id=158 data-nosnippet>158</a> <span class="kw">pub fn </span>new(range: TextRange, info: T) -> RangeInfo<T> { |
| <a href=#159 id=159 data-nosnippet>159</a> RangeInfo { range, info } |
| <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> |
| <a href=#163 id=163 data-nosnippet>163</a><span class="doccomment">/// `AnalysisHost` stores the current state of the world. |
| <a href=#164 id=164 data-nosnippet>164</a></span><span class="attr">#[derive(Debug)] |
| <a href=#165 id=165 data-nosnippet>165</a></span><span class="kw">pub struct </span>AnalysisHost { |
| <a href=#166 id=166 data-nosnippet>166</a> db: RootDatabase, |
| <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">impl </span>AnalysisHost { |
| <a href=#170 id=170 data-nosnippet>170</a> <span class="kw">pub fn </span>new(lru_capacity: <span class="prelude-ty">Option</span><u16>) -> AnalysisHost { |
| <a href=#171 id=171 data-nosnippet>171</a> AnalysisHost { db: RootDatabase::new(lru_capacity) } |
| <a href=#172 id=172 data-nosnippet>172</a> } |
| <a href=#173 id=173 data-nosnippet>173</a> |
| <a href=#174 id=174 data-nosnippet>174</a> <span class="kw">pub fn </span>with_database(db: RootDatabase) -> AnalysisHost { |
| <a href=#175 id=175 data-nosnippet>175</a> AnalysisHost { db } |
| <a href=#176 id=176 data-nosnippet>176</a> } |
| <a href=#177 id=177 data-nosnippet>177</a> |
| <a href=#178 id=178 data-nosnippet>178</a> <span class="kw">pub fn </span>update_lru_capacity(<span class="kw-2">&mut </span><span class="self">self</span>, lru_capacity: <span class="prelude-ty">Option</span><u16>) { |
| <a href=#179 id=179 data-nosnippet>179</a> <span class="self">self</span>.db.update_base_query_lru_capacities(lru_capacity); |
| <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="kw">pub fn </span>update_lru_capacities(<span class="kw-2">&mut </span><span class="self">self</span>, lru_capacities: <span class="kw-2">&</span>FxHashMap<Box<str>, u16>) { |
| <a href=#183 id=183 data-nosnippet>183</a> <span class="self">self</span>.db.update_lru_capacities(lru_capacities); |
| <a href=#184 id=184 data-nosnippet>184</a> } |
| <a href=#185 id=185 data-nosnippet>185</a> |
| <a href=#186 id=186 data-nosnippet>186</a> <span class="doccomment">/// Returns a snapshot of the current state, which you can query for |
| <a href=#187 id=187 data-nosnippet>187</a> /// semantic information. |
| <a href=#188 id=188 data-nosnippet>188</a> </span><span class="kw">pub fn </span>analysis(<span class="kw-2">&</span><span class="self">self</span>) -> Analysis { |
| <a href=#189 id=189 data-nosnippet>189</a> Analysis { db: <span class="self">self</span>.db.clone() } |
| <a href=#190 id=190 data-nosnippet>190</a> } |
| <a href=#191 id=191 data-nosnippet>191</a> |
| <a href=#192 id=192 data-nosnippet>192</a> <span class="doccomment">/// Applies changes to the current state of the world. If there are |
| <a href=#193 id=193 data-nosnippet>193</a> /// outstanding snapshots, they will be canceled. |
| <a href=#194 id=194 data-nosnippet>194</a> </span><span class="kw">pub fn </span>apply_change(<span class="kw-2">&mut </span><span class="self">self</span>, change: ChangeWithProcMacros) { |
| <a href=#195 id=195 data-nosnippet>195</a> <span class="self">self</span>.db.apply_change(change); |
| <a href=#196 id=196 data-nosnippet>196</a> } |
| <a href=#197 id=197 data-nosnippet>197</a> |
| <a href=#198 id=198 data-nosnippet>198</a> <span class="doccomment">/// NB: this clears the database |
| <a href=#199 id=199 data-nosnippet>199</a> </span><span class="kw">pub fn </span>per_query_memory_usage(<span class="kw-2">&mut </span><span class="self">self</span>) -> Vec<(String, profile::Bytes, usize)> { |
| <a href=#200 id=200 data-nosnippet>200</a> <span class="self">self</span>.db.per_query_memory_usage() |
| <a href=#201 id=201 data-nosnippet>201</a> } |
| <a href=#202 id=202 data-nosnippet>202</a> <span class="kw">pub fn </span>request_cancellation(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#203 id=203 data-nosnippet>203</a> <span class="self">self</span>.db.request_cancellation(); |
| <a href=#204 id=204 data-nosnippet>204</a> } |
| <a href=#205 id=205 data-nosnippet>205</a> <span class="kw">pub fn </span>raw_database(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>RootDatabase { |
| <a href=#206 id=206 data-nosnippet>206</a> <span class="kw-2">&</span><span class="self">self</span>.db |
| <a href=#207 id=207 data-nosnippet>207</a> } |
| <a href=#208 id=208 data-nosnippet>208</a> <span class="kw">pub fn </span>raw_database_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>RootDatabase { |
| <a href=#209 id=209 data-nosnippet>209</a> <span class="kw-2">&mut </span><span class="self">self</span>.db |
| <a href=#210 id=210 data-nosnippet>210</a> } |
| <a href=#211 id=211 data-nosnippet>211</a>} |
| <a href=#212 id=212 data-nosnippet>212</a> |
| <a href=#213 id=213 data-nosnippet>213</a><span class="kw">impl </span>Default <span class="kw">for </span>AnalysisHost { |
| <a href=#214 id=214 data-nosnippet>214</a> <span class="kw">fn </span>default() -> AnalysisHost { |
| <a href=#215 id=215 data-nosnippet>215</a> AnalysisHost::new(<span class="prelude-val">None</span>) |
| <a href=#216 id=216 data-nosnippet>216</a> } |
| <a href=#217 id=217 data-nosnippet>217</a>} |
| <a href=#218 id=218 data-nosnippet>218</a> |
| <a href=#219 id=219 data-nosnippet>219</a><span class="doccomment">/// Analysis is a snapshot of a world state at a moment in time. It is the main |
| <a href=#220 id=220 data-nosnippet>220</a>/// entry point for asking semantic information about the world. When the world |
| <a href=#221 id=221 data-nosnippet>221</a>/// state is advanced using `AnalysisHost::apply_change` method, all existing |
| <a href=#222 id=222 data-nosnippet>222</a>/// `Analysis` are canceled (most method return `Err(Canceled)`). |
| <a href=#223 id=223 data-nosnippet>223</a></span><span class="attr">#[derive(Debug)] |
| <a href=#224 id=224 data-nosnippet>224</a></span><span class="kw">pub struct </span>Analysis { |
| <a href=#225 id=225 data-nosnippet>225</a> db: RootDatabase, |
| <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="comment">// As a general design guideline, `Analysis` API are intended to be independent |
| <a href=#229 id=229 data-nosnippet>229</a>// from the language server protocol. That is, when exposing some functionality |
| <a href=#230 id=230 data-nosnippet>230</a>// we should think in terms of "what API makes most sense" and not in terms of |
| <a href=#231 id=231 data-nosnippet>231</a>// "what types LSP uses". Although currently LSP is the only consumer of the |
| <a href=#232 id=232 data-nosnippet>232</a>// API, the API should in theory be usable as a library, or via a different |
| <a href=#233 id=233 data-nosnippet>233</a>// protocol. |
| <a href=#234 id=234 data-nosnippet>234</a></span><span class="kw">impl </span>Analysis { |
| <a href=#235 id=235 data-nosnippet>235</a> <span class="comment">// Creates an analysis instance for a single file, without any external |
| <a href=#236 id=236 data-nosnippet>236</a> // dependencies, stdlib support or ability to apply changes. See |
| <a href=#237 id=237 data-nosnippet>237</a> // `AnalysisHost` for creating a fully-featured analysis. |
| <a href=#238 id=238 data-nosnippet>238</a> </span><span class="kw">pub fn </span>from_single_file(text: String) -> (Analysis, FileId) { |
| <a href=#239 id=239 data-nosnippet>239</a> <span class="kw">let </span><span class="kw-2">mut </span>host = AnalysisHost::default(); |
| <a href=#240 id=240 data-nosnippet>240</a> <span class="kw">let </span>file_id = FileId::from_raw(<span class="number">0</span>); |
| <a href=#241 id=241 data-nosnippet>241</a> <span class="kw">let </span><span class="kw-2">mut </span>file_set = FileSet::default(); |
| <a href=#242 id=242 data-nosnippet>242</a> file_set.insert(file_id, VfsPath::new_virtual_path(<span class="string">"/main.rs"</span>.to_owned())); |
| <a href=#243 id=243 data-nosnippet>243</a> <span class="kw">let </span>source_root = SourceRoot::new_local(file_set); |
| <a href=#244 id=244 data-nosnippet>244</a> |
| <a href=#245 id=245 data-nosnippet>245</a> <span class="kw">let </span><span class="kw-2">mut </span>change = ChangeWithProcMacros::default(); |
| <a href=#246 id=246 data-nosnippet>246</a> change.set_roots(<span class="macro">vec!</span>[source_root]); |
| <a href=#247 id=247 data-nosnippet>247</a> <span class="kw">let </span><span class="kw-2">mut </span>crate_graph = CrateGraphBuilder::default(); |
| <a href=#248 id=248 data-nosnippet>248</a> <span class="comment">// FIXME: cfg options |
| <a href=#249 id=249 data-nosnippet>249</a> // Default to enable test for single file. |
| <a href=#250 id=250 data-nosnippet>250</a> </span><span class="kw">let </span><span class="kw-2">mut </span>cfg_options = CfgOptions::default(); |
| <a href=#251 id=251 data-nosnippet>251</a> |
| <a href=#252 id=252 data-nosnippet>252</a> <span class="comment">// FIXME: This is less than ideal |
| <a href=#253 id=253 data-nosnippet>253</a> </span><span class="kw">let </span>proc_macro_cwd = Arc::new( |
| <a href=#254 id=254 data-nosnippet>254</a> TryFrom::try_from(<span class="kw-2">&*</span>std::env::current_dir().unwrap().as_path().to_string_lossy()) |
| <a href=#255 id=255 data-nosnippet>255</a> .unwrap(), |
| <a href=#256 id=256 data-nosnippet>256</a> ); |
| <a href=#257 id=257 data-nosnippet>257</a> cfg_options.insert_atom(sym::test); |
| <a href=#258 id=258 data-nosnippet>258</a> crate_graph.add_crate_root( |
| <a href=#259 id=259 data-nosnippet>259</a> file_id, |
| <a href=#260 id=260 data-nosnippet>260</a> Edition::CURRENT, |
| <a href=#261 id=261 data-nosnippet>261</a> <span class="prelude-val">None</span>, |
| <a href=#262 id=262 data-nosnippet>262</a> <span class="prelude-val">None</span>, |
| <a href=#263 id=263 data-nosnippet>263</a> cfg_options, |
| <a href=#264 id=264 data-nosnippet>264</a> <span class="prelude-val">None</span>, |
| <a href=#265 id=265 data-nosnippet>265</a> Env::default(), |
| <a href=#266 id=266 data-nosnippet>266</a> CrateOrigin::Local { repo: <span class="prelude-val">None</span>, name: <span class="prelude-val">None </span>}, |
| <a href=#267 id=267 data-nosnippet>267</a> <span class="bool-val">false</span>, |
| <a href=#268 id=268 data-nosnippet>268</a> proc_macro_cwd, |
| <a href=#269 id=269 data-nosnippet>269</a> Arc::new(CrateWorkspaceData { |
| <a href=#270 id=270 data-nosnippet>270</a> target: <span class="prelude-val">Err</span>(<span class="string">"fixture has no layout"</span>.into()), |
| <a href=#271 id=271 data-nosnippet>271</a> toolchain: <span class="prelude-val">None</span>, |
| <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> change.change_file(file_id, <span class="prelude-val">Some</span>(text)); |
| <a href=#275 id=275 data-nosnippet>275</a> change.set_crate_graph(crate_graph); |
| <a href=#276 id=276 data-nosnippet>276</a> |
| <a href=#277 id=277 data-nosnippet>277</a> host.apply_change(change); |
| <a href=#278 id=278 data-nosnippet>278</a> (host.analysis(), file_id) |
| <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">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_ra_fixture( |
| <a href=#282 id=282 data-nosnippet>282</a> sema: <span class="kw-2">&</span>Semantics<<span class="lifetime">'_</span>, RootDatabase>, |
| <a href=#283 id=283 data-nosnippet>283</a> literal: ast::String, |
| <a href=#284 id=284 data-nosnippet>284</a> expanded: <span class="kw-2">&</span>ast::String, |
| <a href=#285 id=285 data-nosnippet>285</a> minicore: MiniCore<<span class="lifetime">'_</span>>, |
| <a href=#286 id=286 data-nosnippet>286</a> ) -> <span class="prelude-ty">Option</span><(Analysis, RaFixtureAnalysis)> { |
| <a href=#287 id=287 data-nosnippet>287</a> <span class="self">Self</span>::from_ra_fixture_with_on_cursor(sema, literal, expanded, minicore, <span class="kw-2">&mut </span>|<span class="kw">_</span>| {}) |
| <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> <span class="doccomment">/// Like [`Analysis::from_ra_fixture()`], but also calls `on_cursor` with the cursor position. |
| <a href=#291 id=291 data-nosnippet>291</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_ra_fixture_with_on_cursor( |
| <a href=#292 id=292 data-nosnippet>292</a> sema: <span class="kw-2">&</span>Semantics<<span class="lifetime">'_</span>, RootDatabase>, |
| <a href=#293 id=293 data-nosnippet>293</a> literal: ast::String, |
| <a href=#294 id=294 data-nosnippet>294</a> expanded: <span class="kw-2">&</span>ast::String, |
| <a href=#295 id=295 data-nosnippet>295</a> minicore: MiniCore<<span class="lifetime">'_</span>>, |
| <a href=#296 id=296 data-nosnippet>296</a> on_cursor: <span class="kw-2">&mut </span><span class="kw">dyn </span>FnMut(TextRange), |
| <a href=#297 id=297 data-nosnippet>297</a> ) -> <span class="prelude-ty">Option</span><(Analysis, RaFixtureAnalysis)> { |
| <a href=#298 id=298 data-nosnippet>298</a> <span class="kw">let </span>analysis = |
| <a href=#299 id=299 data-nosnippet>299</a> RaFixtureAnalysis::analyze_ra_fixture(sema, literal, expanded, minicore, on_cursor)<span class="question-mark">?</span>; |
| <a href=#300 id=300 data-nosnippet>300</a> <span class="prelude-val">Some</span>((Analysis { db: analysis.db.clone() }, analysis)) |
| <a href=#301 id=301 data-nosnippet>301</a> } |
| <a href=#302 id=302 data-nosnippet>302</a> |
| <a href=#303 id=303 data-nosnippet>303</a> <span class="doccomment">/// Debug info about the current state of the analysis. |
| <a href=#304 id=304 data-nosnippet>304</a> </span><span class="kw">pub fn </span>status(<span class="kw-2">&</span><span class="self">self</span>, file_id: <span class="prelude-ty">Option</span><FileId>) -> Cancellable<String> { |
| <a href=#305 id=305 data-nosnippet>305</a> <span class="self">self</span>.with_db(|db| status::status(db, 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="kw">pub fn </span>source_root_id(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<SourceRootId> { |
| <a href=#309 id=309 data-nosnippet>309</a> <span class="self">self</span>.with_db(|db| db.file_source_root(file_id).source_root_id(db)) |
| <a href=#310 id=310 data-nosnippet>310</a> } |
| <a href=#311 id=311 data-nosnippet>311</a> |
| <a href=#312 id=312 data-nosnippet>312</a> <span class="kw">pub fn </span>is_local_source_root(<span class="kw-2">&</span><span class="self">self</span>, source_root_id: SourceRootId) -> Cancellable<bool> { |
| <a href=#313 id=313 data-nosnippet>313</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#314 id=314 data-nosnippet>314</a> <span class="kw">let </span>sr = db.source_root(source_root_id).source_root(db); |
| <a href=#315 id=315 data-nosnippet>315</a> !sr.is_library |
| <a href=#316 id=316 data-nosnippet>316</a> }) |
| <a href=#317 id=317 data-nosnippet>317</a> } |
| <a href=#318 id=318 data-nosnippet>318</a> |
| <a href=#319 id=319 data-nosnippet>319</a> <span class="kw">pub fn </span>parallel_prime_caches<F>(<span class="kw-2">&</span><span class="self">self</span>, num_worker_threads: usize, cb: F) -> Cancellable<()> |
| <a href=#320 id=320 data-nosnippet>320</a> <span class="kw">where |
| <a href=#321 id=321 data-nosnippet>321</a> </span>F: Fn(ParallelPrimeCachesProgress) + Sync + std::panic::UnwindSafe, |
| <a href=#322 id=322 data-nosnippet>322</a> { |
| <a href=#323 id=323 data-nosnippet>323</a> <span class="self">self</span>.with_db(<span class="kw">move </span>|db| prime_caches::parallel_prime_caches(db, num_worker_threads, <span class="kw-2">&</span>cb)) |
| <a href=#324 id=324 data-nosnippet>324</a> } |
| <a href=#325 id=325 data-nosnippet>325</a> |
| <a href=#326 id=326 data-nosnippet>326</a> <span class="doccomment">/// Gets the text of the source file. |
| <a href=#327 id=327 data-nosnippet>327</a> </span><span class="kw">pub fn </span>file_text(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<Arc<str>> { |
| <a href=#328 id=328 data-nosnippet>328</a> <span class="self">self</span>.with_db(|db| SourceDatabase::file_text(db, file_id).text(db).clone()) |
| <a href=#329 id=329 data-nosnippet>329</a> } |
| <a href=#330 id=330 data-nosnippet>330</a> |
| <a href=#331 id=331 data-nosnippet>331</a> <span class="doccomment">/// Gets the syntax tree of the file. |
| <a href=#332 id=332 data-nosnippet>332</a> </span><span class="kw">pub fn </span>parse(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<SourceFile> { |
| <a href=#333 id=333 data-nosnippet>333</a> <span class="comment">// FIXME edition |
| <a href=#334 id=334 data-nosnippet>334</a> </span><span class="self">self</span>.with_db(|db| { |
| <a href=#335 id=335 data-nosnippet>335</a> <span class="kw">let </span>editioned_file_id_wrapper = EditionedFileId::current_edition(<span class="kw-2">&</span><span class="self">self</span>.db, file_id); |
| <a href=#336 id=336 data-nosnippet>336</a> |
| <a href=#337 id=337 data-nosnippet>337</a> db.parse(editioned_file_id_wrapper).tree() |
| <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="doccomment">/// Returns true if this file belongs to an immutable library. |
| <a href=#342 id=342 data-nosnippet>342</a> </span><span class="kw">pub fn </span>is_library_file(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<bool> { |
| <a href=#343 id=343 data-nosnippet>343</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#344 id=344 data-nosnippet>344</a> <span class="kw">let </span>source_root = db.file_source_root(file_id).source_root_id(db); |
| <a href=#345 id=345 data-nosnippet>345</a> db.source_root(source_root).source_root(db).is_library |
| <a href=#346 id=346 data-nosnippet>346</a> }) |
| <a href=#347 id=347 data-nosnippet>347</a> } |
| <a href=#348 id=348 data-nosnippet>348</a> |
| <a href=#349 id=349 data-nosnippet>349</a> <span class="doccomment">/// Gets the file's `LineIndex`: data structure to convert between absolute |
| <a href=#350 id=350 data-nosnippet>350</a> /// offsets and line/column representation. |
| <a href=#351 id=351 data-nosnippet>351</a> </span><span class="kw">pub fn </span>file_line_index(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<Arc<LineIndex>> { |
| <a href=#352 id=352 data-nosnippet>352</a> <span class="self">self</span>.with_db(|db| db.line_index(file_id)) |
| <a href=#353 id=353 data-nosnippet>353</a> } |
| <a href=#354 id=354 data-nosnippet>354</a> |
| <a href=#355 id=355 data-nosnippet>355</a> <span class="doccomment">/// Selects the next syntactic nodes encompassing the range. |
| <a href=#356 id=356 data-nosnippet>356</a> </span><span class="kw">pub fn </span>extend_selection(<span class="kw-2">&</span><span class="self">self</span>, frange: FileRange) -> Cancellable<TextRange> { |
| <a href=#357 id=357 data-nosnippet>357</a> <span class="self">self</span>.with_db(|db| extend_selection::extend_selection(db, frange)) |
| <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> <span class="doccomment">/// Returns position of the matching brace (all types of braces are |
| <a href=#361 id=361 data-nosnippet>361</a> /// supported). |
| <a href=#362 id=362 data-nosnippet>362</a> </span><span class="kw">pub fn </span>matching_brace(<span class="kw-2">&</span><span class="self">self</span>, position: FilePosition) -> Cancellable<<span class="prelude-ty">Option</span><TextSize>> { |
| <a href=#363 id=363 data-nosnippet>363</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#364 id=364 data-nosnippet>364</a> <span class="kw">let </span>file_id = EditionedFileId::current_edition(<span class="kw-2">&</span><span class="self">self</span>.db, position.file_id); |
| <a href=#365 id=365 data-nosnippet>365</a> <span class="kw">let </span>parse = db.parse(file_id); |
| <a href=#366 id=366 data-nosnippet>366</a> <span class="kw">let </span>file = parse.tree(); |
| <a href=#367 id=367 data-nosnippet>367</a> matching_brace::matching_brace(<span class="kw-2">&</span>file, position.offset) |
| <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> <span class="kw">pub fn </span>view_syntax_tree(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<String> { |
| <a href=#372 id=372 data-nosnippet>372</a> <span class="self">self</span>.with_db(|db| view_syntax_tree::view_syntax_tree(db, file_id)) |
| <a href=#373 id=373 data-nosnippet>373</a> } |
| <a href=#374 id=374 data-nosnippet>374</a> |
| <a href=#375 id=375 data-nosnippet>375</a> <span class="kw">pub fn </span>view_hir(<span class="kw-2">&</span><span class="self">self</span>, position: FilePosition) -> Cancellable<String> { |
| <a href=#376 id=376 data-nosnippet>376</a> <span class="self">self</span>.with_db(|db| view_hir::view_hir(db, position)) |
| <a href=#377 id=377 data-nosnippet>377</a> } |
| <a href=#378 id=378 data-nosnippet>378</a> |
| <a href=#379 id=379 data-nosnippet>379</a> <span class="kw">pub fn </span>view_mir(<span class="kw-2">&</span><span class="self">self</span>, position: FilePosition) -> Cancellable<String> { |
| <a href=#380 id=380 data-nosnippet>380</a> <span class="self">self</span>.with_db(|db| view_mir::view_mir(db, position)) |
| <a href=#381 id=381 data-nosnippet>381</a> } |
| <a href=#382 id=382 data-nosnippet>382</a> |
| <a href=#383 id=383 data-nosnippet>383</a> <span class="kw">pub fn </span>interpret_function(<span class="kw-2">&</span><span class="self">self</span>, position: FilePosition) -> Cancellable<String> { |
| <a href=#384 id=384 data-nosnippet>384</a> <span class="self">self</span>.with_db(|db| interpret::interpret(db, position)) |
| <a href=#385 id=385 data-nosnippet>385</a> } |
| <a href=#386 id=386 data-nosnippet>386</a> |
| <a href=#387 id=387 data-nosnippet>387</a> <span class="kw">pub fn </span>view_item_tree(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<String> { |
| <a href=#388 id=388 data-nosnippet>388</a> <span class="self">self</span>.with_db(|db| view_item_tree::view_item_tree(db, file_id)) |
| <a href=#389 id=389 data-nosnippet>389</a> } |
| <a href=#390 id=390 data-nosnippet>390</a> |
| <a href=#391 id=391 data-nosnippet>391</a> <span class="kw">pub fn </span>discover_test_roots(<span class="kw-2">&</span><span class="self">self</span>) -> Cancellable<Vec<TestItem>> { |
| <a href=#392 id=392 data-nosnippet>392</a> <span class="self">self</span>.with_db(test_explorer::discover_test_roots) |
| <a href=#393 id=393 data-nosnippet>393</a> } |
| <a href=#394 id=394 data-nosnippet>394</a> |
| <a href=#395 id=395 data-nosnippet>395</a> <span class="kw">pub fn </span>discover_tests_in_crate_by_test_id(<span class="kw-2">&</span><span class="self">self</span>, crate_id: <span class="kw-2">&</span>str) -> Cancellable<Vec<TestItem>> { |
| <a href=#396 id=396 data-nosnippet>396</a> <span class="self">self</span>.with_db(|db| test_explorer::discover_tests_in_crate_by_test_id(db, crate_id)) |
| <a href=#397 id=397 data-nosnippet>397</a> } |
| <a href=#398 id=398 data-nosnippet>398</a> |
| <a href=#399 id=399 data-nosnippet>399</a> <span class="kw">pub fn </span>discover_tests_in_crate(<span class="kw-2">&</span><span class="self">self</span>, crate_id: Crate) -> Cancellable<Vec<TestItem>> { |
| <a href=#400 id=400 data-nosnippet>400</a> <span class="self">self</span>.with_db(|db| test_explorer::discover_tests_in_crate(db, crate_id)) |
| <a href=#401 id=401 data-nosnippet>401</a> } |
| <a href=#402 id=402 data-nosnippet>402</a> |
| <a href=#403 id=403 data-nosnippet>403</a> <span class="kw">pub fn </span>discover_tests_in_file(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<Vec<TestItem>> { |
| <a href=#404 id=404 data-nosnippet>404</a> <span class="self">self</span>.with_db(|db| test_explorer::discover_tests_in_file(db, file_id)) |
| <a href=#405 id=405 data-nosnippet>405</a> } |
| <a href=#406 id=406 data-nosnippet>406</a> |
| <a href=#407 id=407 data-nosnippet>407</a> <span class="doccomment">/// Renders the crate graph to GraphViz "dot" syntax. |
| <a href=#408 id=408 data-nosnippet>408</a> </span><span class="kw">pub fn </span>view_crate_graph(<span class="kw-2">&</span><span class="self">self</span>, full: bool) -> Cancellable<<span class="prelude-ty">Result</span><String, String>> { |
| <a href=#409 id=409 data-nosnippet>409</a> <span class="self">self</span>.with_db(|db| view_crate_graph::view_crate_graph(db, full)) |
| <a href=#410 id=410 data-nosnippet>410</a> } |
| <a href=#411 id=411 data-nosnippet>411</a> |
| <a href=#412 id=412 data-nosnippet>412</a> <span class="kw">pub fn </span>fetch_crates(<span class="kw-2">&</span><span class="self">self</span>) -> Cancellable<FxIndexSet<CrateInfo>> { |
| <a href=#413 id=413 data-nosnippet>413</a> <span class="self">self</span>.with_db(fetch_crates::fetch_crates) |
| <a href=#414 id=414 data-nosnippet>414</a> } |
| <a href=#415 id=415 data-nosnippet>415</a> |
| <a href=#416 id=416 data-nosnippet>416</a> <span class="kw">pub fn </span>expand_macro(<span class="kw-2">&</span><span class="self">self</span>, position: FilePosition) -> Cancellable<<span class="prelude-ty">Option</span><ExpandedMacro>> { |
| <a href=#417 id=417 data-nosnippet>417</a> <span class="self">self</span>.with_db(|db| expand_macro::expand_macro(db, position)) |
| <a href=#418 id=418 data-nosnippet>418</a> } |
| <a href=#419 id=419 data-nosnippet>419</a> |
| <a href=#420 id=420 data-nosnippet>420</a> <span class="doccomment">/// Returns an edit to remove all newlines in the range, cleaning up minor |
| <a href=#421 id=421 data-nosnippet>421</a> /// stuff like trailing commas. |
| <a href=#422 id=422 data-nosnippet>422</a> </span><span class="kw">pub fn </span>join_lines(<span class="kw-2">&</span><span class="self">self</span>, config: <span class="kw-2">&</span>JoinLinesConfig, frange: FileRange) -> Cancellable<TextEdit> { |
| <a href=#423 id=423 data-nosnippet>423</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#424 id=424 data-nosnippet>424</a> <span class="kw">let </span>editioned_file_id_wrapper = |
| <a href=#425 id=425 data-nosnippet>425</a> EditionedFileId::current_edition(<span class="kw-2">&</span><span class="self">self</span>.db, frange.file_id); |
| <a href=#426 id=426 data-nosnippet>426</a> <span class="kw">let </span>parse = db.parse(editioned_file_id_wrapper); |
| <a href=#427 id=427 data-nosnippet>427</a> join_lines::join_lines(config, <span class="kw-2">&</span>parse.tree(), frange.range) |
| <a href=#428 id=428 data-nosnippet>428</a> }) |
| <a href=#429 id=429 data-nosnippet>429</a> } |
| <a href=#430 id=430 data-nosnippet>430</a> |
| <a href=#431 id=431 data-nosnippet>431</a> <span class="doccomment">/// Returns an edit which should be applied when opening a new line, fixing |
| <a href=#432 id=432 data-nosnippet>432</a> /// up minor stuff like continuing the comment. |
| <a href=#433 id=433 data-nosnippet>433</a> /// The edit will be a snippet (with `$0`). |
| <a href=#434 id=434 data-nosnippet>434</a> </span><span class="kw">pub fn </span>on_enter(<span class="kw-2">&</span><span class="self">self</span>, position: FilePosition) -> Cancellable<<span class="prelude-ty">Option</span><TextEdit>> { |
| <a href=#435 id=435 data-nosnippet>435</a> <span class="self">self</span>.with_db(|db| typing::on_enter(db, position)) |
| <a href=#436 id=436 data-nosnippet>436</a> } |
| <a href=#437 id=437 data-nosnippet>437</a> |
| <a href=#438 id=438 data-nosnippet>438</a> <span class="kw">pub const </span>SUPPORTED_TRIGGER_CHARS: <span class="kw-2">&</span>[char] = typing::TRIGGER_CHARS; |
| <a href=#439 id=439 data-nosnippet>439</a> |
| <a href=#440 id=440 data-nosnippet>440</a> <span class="doccomment">/// Returns an edit which should be applied after a character was typed. |
| <a href=#441 id=441 data-nosnippet>441</a> /// |
| <a href=#442 id=442 data-nosnippet>442</a> /// This is useful for some on-the-fly fixups, like adding `;` to `let =` |
| <a href=#443 id=443 data-nosnippet>443</a> /// automatically. |
| <a href=#444 id=444 data-nosnippet>444</a> </span><span class="kw">pub fn </span>on_char_typed( |
| <a href=#445 id=445 data-nosnippet>445</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#446 id=446 data-nosnippet>446</a> position: FilePosition, |
| <a href=#447 id=447 data-nosnippet>447</a> char_typed: char, |
| <a href=#448 id=448 data-nosnippet>448</a> ) -> Cancellable<<span class="prelude-ty">Option</span><SourceChange>> { |
| <a href=#449 id=449 data-nosnippet>449</a> <span class="comment">// Fast path to not even parse the file. |
| <a href=#450 id=450 data-nosnippet>450</a> </span><span class="kw">if </span>!typing::TRIGGER_CHARS.contains(<span class="kw-2">&</span>char_typed) { |
| <a href=#451 id=451 data-nosnippet>451</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>); |
| <a href=#452 id=452 data-nosnippet>452</a> } |
| <a href=#453 id=453 data-nosnippet>453</a> |
| <a href=#454 id=454 data-nosnippet>454</a> <span class="self">self</span>.with_db(|db| typing::on_char_typed(db, position, char_typed)) |
| <a href=#455 id=455 data-nosnippet>455</a> } |
| <a href=#456 id=456 data-nosnippet>456</a> |
| <a href=#457 id=457 data-nosnippet>457</a> <span class="doccomment">/// Returns a tree representation of symbols in the file. Useful to draw a |
| <a href=#458 id=458 data-nosnippet>458</a> /// file outline. |
| <a href=#459 id=459 data-nosnippet>459</a> </span><span class="kw">pub fn </span>file_structure( |
| <a href=#460 id=460 data-nosnippet>460</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#461 id=461 data-nosnippet>461</a> config: <span class="kw-2">&</span>FileStructureConfig, |
| <a href=#462 id=462 data-nosnippet>462</a> file_id: FileId, |
| <a href=#463 id=463 data-nosnippet>463</a> ) -> Cancellable<Vec<StructureNode>> { |
| <a href=#464 id=464 data-nosnippet>464</a> <span class="comment">// FIXME: Edition |
| <a href=#465 id=465 data-nosnippet>465</a> </span><span class="self">self</span>.with_db(|db| { |
| <a href=#466 id=466 data-nosnippet>466</a> <span class="kw">let </span>editioned_file_id_wrapper = EditionedFileId::current_edition(<span class="kw-2">&</span><span class="self">self</span>.db, file_id); |
| <a href=#467 id=467 data-nosnippet>467</a> <span class="kw">let </span>source_file = db.parse(editioned_file_id_wrapper).tree(); |
| <a href=#468 id=468 data-nosnippet>468</a> file_structure::file_structure(<span class="kw-2">&</span>source_file, config) |
| <a href=#469 id=469 data-nosnippet>469</a> }) |
| <a href=#470 id=470 data-nosnippet>470</a> } |
| <a href=#471 id=471 data-nosnippet>471</a> |
| <a href=#472 id=472 data-nosnippet>472</a> <span class="doccomment">/// Returns a list of the places in the file where type hints can be displayed. |
| <a href=#473 id=473 data-nosnippet>473</a> </span><span class="kw">pub fn </span>inlay_hints( |
| <a href=#474 id=474 data-nosnippet>474</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#475 id=475 data-nosnippet>475</a> config: <span class="kw-2">&</span>InlayHintsConfig<<span class="lifetime">'_</span>>, |
| <a href=#476 id=476 data-nosnippet>476</a> file_id: FileId, |
| <a href=#477 id=477 data-nosnippet>477</a> range: <span class="prelude-ty">Option</span><TextRange>, |
| <a href=#478 id=478 data-nosnippet>478</a> ) -> Cancellable<Vec<InlayHint>> { |
| <a href=#479 id=479 data-nosnippet>479</a> <span class="self">self</span>.with_db(|db| inlay_hints::inlay_hints(db, file_id, range, config)) |
| <a href=#480 id=480 data-nosnippet>480</a> } |
| <a href=#481 id=481 data-nosnippet>481</a> <span class="kw">pub fn </span>inlay_hints_resolve( |
| <a href=#482 id=482 data-nosnippet>482</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#483 id=483 data-nosnippet>483</a> config: <span class="kw-2">&</span>InlayHintsConfig<<span class="lifetime">'_</span>>, |
| <a href=#484 id=484 data-nosnippet>484</a> file_id: FileId, |
| <a href=#485 id=485 data-nosnippet>485</a> resolve_range: TextRange, |
| <a href=#486 id=486 data-nosnippet>486</a> hash: u64, |
| <a href=#487 id=487 data-nosnippet>487</a> hasher: <span class="kw">impl </span>Fn(<span class="kw-2">&</span>InlayHint) -> u64 + Send + UnwindSafe, |
| <a href=#488 id=488 data-nosnippet>488</a> ) -> Cancellable<<span class="prelude-ty">Option</span><InlayHint>> { |
| <a href=#489 id=489 data-nosnippet>489</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#490 id=490 data-nosnippet>490</a> inlay_hints::inlay_hints_resolve(db, file_id, resolve_range, hash, config, hasher) |
| <a href=#491 id=491 data-nosnippet>491</a> }) |
| <a href=#492 id=492 data-nosnippet>492</a> } |
| <a href=#493 id=493 data-nosnippet>493</a> |
| <a href=#494 id=494 data-nosnippet>494</a> <span class="doccomment">/// Returns the set of folding ranges. |
| <a href=#495 id=495 data-nosnippet>495</a> </span><span class="kw">pub fn </span>folding_ranges(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<Vec<Fold>> { |
| <a href=#496 id=496 data-nosnippet>496</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#497 id=497 data-nosnippet>497</a> <span class="kw">let </span>editioned_file_id_wrapper = EditionedFileId::current_edition(<span class="kw-2">&</span><span class="self">self</span>.db, file_id); |
| <a href=#498 id=498 data-nosnippet>498</a> |
| <a href=#499 id=499 data-nosnippet>499</a> folding_ranges::folding_ranges(<span class="kw-2">&</span>db.parse(editioned_file_id_wrapper).tree()) |
| <a href=#500 id=500 data-nosnippet>500</a> }) |
| <a href=#501 id=501 data-nosnippet>501</a> } |
| <a href=#502 id=502 data-nosnippet>502</a> |
| <a href=#503 id=503 data-nosnippet>503</a> <span class="doccomment">/// Fuzzy searches for a symbol. |
| <a href=#504 id=504 data-nosnippet>504</a> </span><span class="kw">pub fn </span>symbol_search(<span class="kw-2">&</span><span class="self">self</span>, query: Query, limit: usize) -> Cancellable<Vec<NavigationTarget>> { |
| <a href=#505 id=505 data-nosnippet>505</a> <span class="comment">// `world_symbols` currently clones the database to run stuff in parallel, which will make any query panic |
| <a href=#506 id=506 data-nosnippet>506</a> // if we were to attach it here. |
| <a href=#507 id=507 data-nosnippet>507</a> </span>Cancelled::catch(|| { |
| <a href=#508 id=508 data-nosnippet>508</a> <span class="kw">let </span>symbols = symbol_index::world_symbols(<span class="kw-2">&</span><span class="self">self</span>.db, query); |
| <a href=#509 id=509 data-nosnippet>509</a> hir::attach_db(<span class="kw-2">&</span><span class="self">self</span>.db, || { |
| <a href=#510 id=510 data-nosnippet>510</a> symbols |
| <a href=#511 id=511 data-nosnippet>511</a> .into_iter() |
| <a href=#512 id=512 data-nosnippet>512</a> .filter_map(|s| s.try_to_nav(<span class="kw-2">&</span>Semantics::new(<span class="kw-2">&</span><span class="self">self</span>.db))) |
| <a href=#513 id=513 data-nosnippet>513</a> .take(limit) |
| <a href=#514 id=514 data-nosnippet>514</a> .map(UpmappingResult::call_site) |
| <a href=#515 id=515 data-nosnippet>515</a> .collect::<Vec<<span class="kw">_</span>>>() |
| <a href=#516 id=516 data-nosnippet>516</a> }) |
| <a href=#517 id=517 data-nosnippet>517</a> }) |
| <a href=#518 id=518 data-nosnippet>518</a> } |
| <a href=#519 id=519 data-nosnippet>519</a> |
| <a href=#520 id=520 data-nosnippet>520</a> <span class="doccomment">/// Returns the definitions from the symbol at `position`. |
| <a href=#521 id=521 data-nosnippet>521</a> </span><span class="kw">pub fn </span>goto_definition( |
| <a href=#522 id=522 data-nosnippet>522</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#523 id=523 data-nosnippet>523</a> position: FilePosition, |
| <a href=#524 id=524 data-nosnippet>524</a> config: <span class="kw-2">&</span>GotoDefinitionConfig<<span class="lifetime">'_</span>>, |
| <a href=#525 id=525 data-nosnippet>525</a> ) -> Cancellable<<span class="prelude-ty">Option</span><RangeInfo<Vec<NavigationTarget>>>> { |
| <a href=#526 id=526 data-nosnippet>526</a> <span class="self">self</span>.with_db(|db| goto_definition::goto_definition(db, position, config)) |
| <a href=#527 id=527 data-nosnippet>527</a> } |
| <a href=#528 id=528 data-nosnippet>528</a> |
| <a href=#529 id=529 data-nosnippet>529</a> <span class="doccomment">/// Returns the declaration from the symbol at `position`. |
| <a href=#530 id=530 data-nosnippet>530</a> </span><span class="kw">pub fn </span>goto_declaration( |
| <a href=#531 id=531 data-nosnippet>531</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#532 id=532 data-nosnippet>532</a> position: FilePosition, |
| <a href=#533 id=533 data-nosnippet>533</a> config: <span class="kw-2">&</span>GotoDefinitionConfig<<span class="lifetime">'_</span>>, |
| <a href=#534 id=534 data-nosnippet>534</a> ) -> Cancellable<<span class="prelude-ty">Option</span><RangeInfo<Vec<NavigationTarget>>>> { |
| <a href=#535 id=535 data-nosnippet>535</a> <span class="self">self</span>.with_db(|db| goto_declaration::goto_declaration(db, position, config)) |
| <a href=#536 id=536 data-nosnippet>536</a> } |
| <a href=#537 id=537 data-nosnippet>537</a> |
| <a href=#538 id=538 data-nosnippet>538</a> <span class="doccomment">/// Returns the impls from the symbol at `position`. |
| <a href=#539 id=539 data-nosnippet>539</a> </span><span class="kw">pub fn </span>goto_implementation( |
| <a href=#540 id=540 data-nosnippet>540</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#541 id=541 data-nosnippet>541</a> config: <span class="kw-2">&</span>GotoImplementationConfig, |
| <a href=#542 id=542 data-nosnippet>542</a> position: FilePosition, |
| <a href=#543 id=543 data-nosnippet>543</a> ) -> Cancellable<<span class="prelude-ty">Option</span><RangeInfo<Vec<NavigationTarget>>>> { |
| <a href=#544 id=544 data-nosnippet>544</a> <span class="self">self</span>.with_db(|db| goto_implementation::goto_implementation(db, config, position)) |
| <a href=#545 id=545 data-nosnippet>545</a> } |
| <a href=#546 id=546 data-nosnippet>546</a> |
| <a href=#547 id=547 data-nosnippet>547</a> <span class="doccomment">/// Returns the type definitions for the symbol at `position`. |
| <a href=#548 id=548 data-nosnippet>548</a> </span><span class="kw">pub fn </span>goto_type_definition( |
| <a href=#549 id=549 data-nosnippet>549</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#550 id=550 data-nosnippet>550</a> position: FilePosition, |
| <a href=#551 id=551 data-nosnippet>551</a> ) -> Cancellable<<span class="prelude-ty">Option</span><RangeInfo<Vec<NavigationTarget>>>> { |
| <a href=#552 id=552 data-nosnippet>552</a> <span class="self">self</span>.with_db(|db| goto_type_definition::goto_type_definition(db, position)) |
| <a href=#553 id=553 data-nosnippet>553</a> } |
| <a href=#554 id=554 data-nosnippet>554</a> |
| <a href=#555 id=555 data-nosnippet>555</a> <span class="kw">pub fn </span>find_all_refs( |
| <a href=#556 id=556 data-nosnippet>556</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#557 id=557 data-nosnippet>557</a> position: FilePosition, |
| <a href=#558 id=558 data-nosnippet>558</a> config: <span class="kw-2">&</span>FindAllRefsConfig<<span class="lifetime">'_</span>>, |
| <a href=#559 id=559 data-nosnippet>559</a> ) -> Cancellable<<span class="prelude-ty">Option</span><Vec<ReferenceSearchResult>>> { |
| <a href=#560 id=560 data-nosnippet>560</a> <span class="kw">let </span>config = AssertUnwindSafe(config); |
| <a href=#561 id=561 data-nosnippet>561</a> <span class="self">self</span>.with_db(|db| references::find_all_refs(<span class="kw-2">&</span>Semantics::new(db), position, <span class="kw-2">&</span>config)) |
| <a href=#562 id=562 data-nosnippet>562</a> } |
| <a href=#563 id=563 data-nosnippet>563</a> |
| <a href=#564 id=564 data-nosnippet>564</a> <span class="doccomment">/// Returns a short text describing element at position. |
| <a href=#565 id=565 data-nosnippet>565</a> </span><span class="kw">pub fn </span>hover( |
| <a href=#566 id=566 data-nosnippet>566</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#567 id=567 data-nosnippet>567</a> config: <span class="kw-2">&</span>HoverConfig<<span class="lifetime">'_</span>>, |
| <a href=#568 id=568 data-nosnippet>568</a> range: FileRange, |
| <a href=#569 id=569 data-nosnippet>569</a> ) -> Cancellable<<span class="prelude-ty">Option</span><RangeInfo<HoverResult>>> { |
| <a href=#570 id=570 data-nosnippet>570</a> <span class="self">self</span>.with_db(|db| hover::hover(db, range, config)) |
| <a href=#571 id=571 data-nosnippet>571</a> } |
| <a href=#572 id=572 data-nosnippet>572</a> |
| <a href=#573 id=573 data-nosnippet>573</a> <span class="doccomment">/// Returns moniker of symbol at position. |
| <a href=#574 id=574 data-nosnippet>574</a> </span><span class="kw">pub fn </span>moniker( |
| <a href=#575 id=575 data-nosnippet>575</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#576 id=576 data-nosnippet>576</a> position: FilePosition, |
| <a href=#577 id=577 data-nosnippet>577</a> ) -> Cancellable<<span class="prelude-ty">Option</span><RangeInfo<Vec<moniker::MonikerResult>>>> { |
| <a href=#578 id=578 data-nosnippet>578</a> <span class="self">self</span>.with_db(|db| moniker::moniker(db, position)) |
| <a href=#579 id=579 data-nosnippet>579</a> } |
| <a href=#580 id=580 data-nosnippet>580</a> |
| <a href=#581 id=581 data-nosnippet>581</a> <span class="doccomment">/// Returns URL(s) for the documentation of the symbol under the cursor. |
| <a href=#582 id=582 data-nosnippet>582</a> /// # Arguments |
| <a href=#583 id=583 data-nosnippet>583</a> /// * `position` - Position in the file. |
| <a href=#584 id=584 data-nosnippet>584</a> /// * `target_dir` - Directory where the build output is stored. |
| <a href=#585 id=585 data-nosnippet>585</a> </span><span class="kw">pub fn </span>external_docs( |
| <a href=#586 id=586 data-nosnippet>586</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#587 id=587 data-nosnippet>587</a> position: FilePosition, |
| <a href=#588 id=588 data-nosnippet>588</a> target_dir: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>, |
| <a href=#589 id=589 data-nosnippet>589</a> sysroot: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>, |
| <a href=#590 id=590 data-nosnippet>590</a> ) -> Cancellable<doc_links::DocumentationLinks> { |
| <a href=#591 id=591 data-nosnippet>591</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#592 id=592 data-nosnippet>592</a> doc_links::external_docs(db, position, target_dir, sysroot).unwrap_or_default() |
| <a href=#593 id=593 data-nosnippet>593</a> }) |
| <a href=#594 id=594 data-nosnippet>594</a> } |
| <a href=#595 id=595 data-nosnippet>595</a> |
| <a href=#596 id=596 data-nosnippet>596</a> <span class="doccomment">/// Computes parameter information at the given position. |
| <a href=#597 id=597 data-nosnippet>597</a> </span><span class="kw">pub fn </span>signature_help(<span class="kw-2">&</span><span class="self">self</span>, position: FilePosition) -> Cancellable<<span class="prelude-ty">Option</span><SignatureHelp>> { |
| <a href=#598 id=598 data-nosnippet>598</a> <span class="self">self</span>.with_db(|db| signature_help::signature_help(db, position)) |
| <a href=#599 id=599 data-nosnippet>599</a> } |
| <a href=#600 id=600 data-nosnippet>600</a> |
| <a href=#601 id=601 data-nosnippet>601</a> <span class="doccomment">/// Computes call hierarchy candidates for the given file position. |
| <a href=#602 id=602 data-nosnippet>602</a> </span><span class="kw">pub fn </span>call_hierarchy( |
| <a href=#603 id=603 data-nosnippet>603</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#604 id=604 data-nosnippet>604</a> position: FilePosition, |
| <a href=#605 id=605 data-nosnippet>605</a> config: <span class="kw-2">&</span>CallHierarchyConfig<<span class="lifetime">'_</span>>, |
| <a href=#606 id=606 data-nosnippet>606</a> ) -> Cancellable<<span class="prelude-ty">Option</span><RangeInfo<Vec<NavigationTarget>>>> { |
| <a href=#607 id=607 data-nosnippet>607</a> <span class="self">self</span>.with_db(|db| call_hierarchy::call_hierarchy(db, position, config)) |
| <a href=#608 id=608 data-nosnippet>608</a> } |
| <a href=#609 id=609 data-nosnippet>609</a> |
| <a href=#610 id=610 data-nosnippet>610</a> <span class="doccomment">/// Computes incoming calls for the given file position. |
| <a href=#611 id=611 data-nosnippet>611</a> </span><span class="kw">pub fn </span>incoming_calls( |
| <a href=#612 id=612 data-nosnippet>612</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#613 id=613 data-nosnippet>613</a> config: <span class="kw-2">&</span>CallHierarchyConfig<<span class="lifetime">'_</span>>, |
| <a href=#614 id=614 data-nosnippet>614</a> position: FilePosition, |
| <a href=#615 id=615 data-nosnippet>615</a> ) -> Cancellable<<span class="prelude-ty">Option</span><Vec<CallItem>>> { |
| <a href=#616 id=616 data-nosnippet>616</a> <span class="self">self</span>.with_db(|db| call_hierarchy::incoming_calls(db, config, position)) |
| <a href=#617 id=617 data-nosnippet>617</a> } |
| <a href=#618 id=618 data-nosnippet>618</a> |
| <a href=#619 id=619 data-nosnippet>619</a> <span class="doccomment">/// Computes outgoing calls for the given file position. |
| <a href=#620 id=620 data-nosnippet>620</a> </span><span class="kw">pub fn </span>outgoing_calls( |
| <a href=#621 id=621 data-nosnippet>621</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#622 id=622 data-nosnippet>622</a> config: <span class="kw-2">&</span>CallHierarchyConfig<<span class="lifetime">'_</span>>, |
| <a href=#623 id=623 data-nosnippet>623</a> position: FilePosition, |
| <a href=#624 id=624 data-nosnippet>624</a> ) -> Cancellable<<span class="prelude-ty">Option</span><Vec<CallItem>>> { |
| <a href=#625 id=625 data-nosnippet>625</a> <span class="self">self</span>.with_db(|db| call_hierarchy::outgoing_calls(db, config, position)) |
| <a href=#626 id=626 data-nosnippet>626</a> } |
| <a href=#627 id=627 data-nosnippet>627</a> |
| <a href=#628 id=628 data-nosnippet>628</a> <span class="doccomment">/// Returns a `mod name;` declaration which created the current module. |
| <a href=#629 id=629 data-nosnippet>629</a> </span><span class="kw">pub fn </span>parent_module(<span class="kw-2">&</span><span class="self">self</span>, position: FilePosition) -> Cancellable<Vec<NavigationTarget>> { |
| <a href=#630 id=630 data-nosnippet>630</a> <span class="self">self</span>.with_db(|db| parent_module::parent_module(db, position)) |
| <a href=#631 id=631 data-nosnippet>631</a> } |
| <a href=#632 id=632 data-nosnippet>632</a> |
| <a href=#633 id=633 data-nosnippet>633</a> <span class="doccomment">/// Returns vec of `mod name;` declaration which are created by the current module. |
| <a href=#634 id=634 data-nosnippet>634</a> </span><span class="kw">pub fn </span>child_modules(<span class="kw-2">&</span><span class="self">self</span>, position: FilePosition) -> Cancellable<Vec<NavigationTarget>> { |
| <a href=#635 id=635 data-nosnippet>635</a> <span class="self">self</span>.with_db(|db| child_modules::child_modules(db, position)) |
| <a href=#636 id=636 data-nosnippet>636</a> } |
| <a href=#637 id=637 data-nosnippet>637</a> |
| <a href=#638 id=638 data-nosnippet>638</a> <span class="doccomment">/// Returns crates that this file belongs to. |
| <a href=#639 id=639 data-nosnippet>639</a> </span><span class="kw">pub fn </span>crates_for(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<Vec<Crate>> { |
| <a href=#640 id=640 data-nosnippet>640</a> <span class="self">self</span>.with_db(|db| parent_module::crates_for(db, file_id)) |
| <a href=#641 id=641 data-nosnippet>641</a> } |
| <a href=#642 id=642 data-nosnippet>642</a> |
| <a href=#643 id=643 data-nosnippet>643</a> <span class="doccomment">/// Returns crates that this file belongs to. |
| <a href=#644 id=644 data-nosnippet>644</a> </span><span class="kw">pub fn </span>transitive_rev_deps(<span class="kw-2">&</span><span class="self">self</span>, crate_id: Crate) -> Cancellable<Vec<Crate>> { |
| <a href=#645 id=645 data-nosnippet>645</a> <span class="self">self</span>.with_db(|db| Vec::from_iter(db.transitive_rev_deps(crate_id))) |
| <a href=#646 id=646 data-nosnippet>646</a> } |
| <a href=#647 id=647 data-nosnippet>647</a> |
| <a href=#648 id=648 data-nosnippet>648</a> <span class="doccomment">/// Returns crates that this file *might* belong to. |
| <a href=#649 id=649 data-nosnippet>649</a> </span><span class="kw">pub fn </span>relevant_crates_for(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<Vec<Crate>> { |
| <a href=#650 id=650 data-nosnippet>650</a> <span class="self">self</span>.with_db(|db| db.relevant_crates(file_id).iter().copied().collect()) |
| <a href=#651 id=651 data-nosnippet>651</a> } |
| <a href=#652 id=652 data-nosnippet>652</a> |
| <a href=#653 id=653 data-nosnippet>653</a> <span class="doccomment">/// Returns the edition of the given crate. |
| <a href=#654 id=654 data-nosnippet>654</a> </span><span class="kw">pub fn </span>crate_edition(<span class="kw-2">&</span><span class="self">self</span>, crate_id: Crate) -> Cancellable<Edition> { |
| <a href=#655 id=655 data-nosnippet>655</a> <span class="self">self</span>.with_db(|db| crate_id.data(db).edition) |
| <a href=#656 id=656 data-nosnippet>656</a> } |
| <a href=#657 id=657 data-nosnippet>657</a> |
| <a href=#658 id=658 data-nosnippet>658</a> <span class="doccomment">/// Returns whether the given crate is a proc macro. |
| <a href=#659 id=659 data-nosnippet>659</a> </span><span class="kw">pub fn </span>is_proc_macro_crate(<span class="kw-2">&</span><span class="self">self</span>, crate_id: Crate) -> Cancellable<bool> { |
| <a href=#660 id=660 data-nosnippet>660</a> <span class="self">self</span>.with_db(|db| crate_id.data(db).is_proc_macro) |
| <a href=#661 id=661 data-nosnippet>661</a> } |
| <a href=#662 id=662 data-nosnippet>662</a> |
| <a href=#663 id=663 data-nosnippet>663</a> <span class="doccomment">/// Returns true if this crate has `no_std` or `no_core` specified. |
| <a href=#664 id=664 data-nosnippet>664</a> </span><span class="kw">pub fn </span>is_crate_no_std(<span class="kw-2">&</span><span class="self">self</span>, crate_id: Crate) -> Cancellable<bool> { |
| <a href=#665 id=665 data-nosnippet>665</a> <span class="self">self</span>.with_db(|db| crate_def_map(db, crate_id).is_no_std()) |
| <a href=#666 id=666 data-nosnippet>666</a> } |
| <a href=#667 id=667 data-nosnippet>667</a> |
| <a href=#668 id=668 data-nosnippet>668</a> <span class="doccomment">/// Returns the root file of the given crate. |
| <a href=#669 id=669 data-nosnippet>669</a> </span><span class="kw">pub fn </span>crate_root(<span class="kw-2">&</span><span class="self">self</span>, crate_id: Crate) -> Cancellable<FileId> { |
| <a href=#670 id=670 data-nosnippet>670</a> <span class="self">self</span>.with_db(|db| crate_id.data(db).root_file_id) |
| <a href=#671 id=671 data-nosnippet>671</a> } |
| <a href=#672 id=672 data-nosnippet>672</a> |
| <a href=#673 id=673 data-nosnippet>673</a> <span class="doccomment">/// Returns the set of possible targets to run for the current file. |
| <a href=#674 id=674 data-nosnippet>674</a> </span><span class="kw">pub fn </span>runnables(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId) -> Cancellable<Vec<Runnable>> { |
| <a href=#675 id=675 data-nosnippet>675</a> <span class="self">self</span>.with_db(|db| runnables::runnables(db, file_id)) |
| <a href=#676 id=676 data-nosnippet>676</a> } |
| <a href=#677 id=677 data-nosnippet>677</a> |
| <a href=#678 id=678 data-nosnippet>678</a> <span class="doccomment">/// Returns the set of tests for the given file position. |
| <a href=#679 id=679 data-nosnippet>679</a> </span><span class="kw">pub fn </span>related_tests( |
| <a href=#680 id=680 data-nosnippet>680</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#681 id=681 data-nosnippet>681</a> position: FilePosition, |
| <a href=#682 id=682 data-nosnippet>682</a> search_scope: <span class="prelude-ty">Option</span><SearchScope>, |
| <a href=#683 id=683 data-nosnippet>683</a> ) -> Cancellable<Vec<Runnable>> { |
| <a href=#684 id=684 data-nosnippet>684</a> <span class="kw">let </span>search_scope = AssertUnwindSafe(search_scope); |
| <a href=#685 id=685 data-nosnippet>685</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#686 id=686 data-nosnippet>686</a> <span class="kw">let _ </span>= <span class="kw-2">&</span>search_scope; |
| <a href=#687 id=687 data-nosnippet>687</a> runnables::related_tests(db, position, search_scope.<span class="number">0</span>) |
| <a href=#688 id=688 data-nosnippet>688</a> }) |
| <a href=#689 id=689 data-nosnippet>689</a> } |
| <a href=#690 id=690 data-nosnippet>690</a> |
| <a href=#691 id=691 data-nosnippet>691</a> <span class="doccomment">/// Computes all ranges to highlight for a given item in a file. |
| <a href=#692 id=692 data-nosnippet>692</a> </span><span class="kw">pub fn </span>highlight_related( |
| <a href=#693 id=693 data-nosnippet>693</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#694 id=694 data-nosnippet>694</a> config: HighlightRelatedConfig, |
| <a href=#695 id=695 data-nosnippet>695</a> position: FilePosition, |
| <a href=#696 id=696 data-nosnippet>696</a> ) -> Cancellable<<span class="prelude-ty">Option</span><Vec<HighlightedRange>>> { |
| <a href=#697 id=697 data-nosnippet>697</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#698 id=698 data-nosnippet>698</a> highlight_related::highlight_related(<span class="kw-2">&</span>Semantics::new(db), config, position) |
| <a href=#699 id=699 data-nosnippet>699</a> }) |
| <a href=#700 id=700 data-nosnippet>700</a> } |
| <a href=#701 id=701 data-nosnippet>701</a> |
| <a href=#702 id=702 data-nosnippet>702</a> <span class="doccomment">/// Computes syntax highlighting for the given file |
| <a href=#703 id=703 data-nosnippet>703</a> </span><span class="kw">pub fn </span>highlight( |
| <a href=#704 id=704 data-nosnippet>704</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#705 id=705 data-nosnippet>705</a> highlight_config: HighlightConfig<<span class="lifetime">'_</span>>, |
| <a href=#706 id=706 data-nosnippet>706</a> file_id: FileId, |
| <a href=#707 id=707 data-nosnippet>707</a> ) -> Cancellable<Vec<HlRange>> { |
| <a href=#708 id=708 data-nosnippet>708</a> <span class="self">self</span>.with_db(|db| syntax_highlighting::highlight(db, <span class="kw-2">&</span>highlight_config, file_id, <span class="prelude-val">None</span>)) |
| <a href=#709 id=709 data-nosnippet>709</a> } |
| <a href=#710 id=710 data-nosnippet>710</a> |
| <a href=#711 id=711 data-nosnippet>711</a> <span class="doccomment">/// Computes syntax highlighting for the given file range. |
| <a href=#712 id=712 data-nosnippet>712</a> </span><span class="kw">pub fn </span>highlight_range( |
| <a href=#713 id=713 data-nosnippet>713</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#714 id=714 data-nosnippet>714</a> highlight_config: HighlightConfig<<span class="lifetime">'_</span>>, |
| <a href=#715 id=715 data-nosnippet>715</a> frange: FileRange, |
| <a href=#716 id=716 data-nosnippet>716</a> ) -> Cancellable<Vec<HlRange>> { |
| <a href=#717 id=717 data-nosnippet>717</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#718 id=718 data-nosnippet>718</a> syntax_highlighting::highlight( |
| <a href=#719 id=719 data-nosnippet>719</a> db, |
| <a href=#720 id=720 data-nosnippet>720</a> <span class="kw-2">&</span>highlight_config, |
| <a href=#721 id=721 data-nosnippet>721</a> frange.file_id, |
| <a href=#722 id=722 data-nosnippet>722</a> <span class="prelude-val">Some</span>(frange.range), |
| <a href=#723 id=723 data-nosnippet>723</a> ) |
| <a href=#724 id=724 data-nosnippet>724</a> }) |
| <a href=#725 id=725 data-nosnippet>725</a> } |
| <a href=#726 id=726 data-nosnippet>726</a> |
| <a href=#727 id=727 data-nosnippet>727</a> <span class="doccomment">/// Computes syntax highlighting for the given file. |
| <a href=#728 id=728 data-nosnippet>728</a> </span><span class="kw">pub fn </span>highlight_as_html_with_config( |
| <a href=#729 id=729 data-nosnippet>729</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#730 id=730 data-nosnippet>730</a> config: HighlightConfig<<span class="lifetime">'_</span>>, |
| <a href=#731 id=731 data-nosnippet>731</a> file_id: FileId, |
| <a href=#732 id=732 data-nosnippet>732</a> rainbow: bool, |
| <a href=#733 id=733 data-nosnippet>733</a> ) -> Cancellable<String> { |
| <a href=#734 id=734 data-nosnippet>734</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#735 id=735 data-nosnippet>735</a> syntax_highlighting::highlight_as_html_with_config(db, <span class="kw-2">&</span>config, file_id, rainbow) |
| <a href=#736 id=736 data-nosnippet>736</a> }) |
| <a href=#737 id=737 data-nosnippet>737</a> } |
| <a href=#738 id=738 data-nosnippet>738</a> |
| <a href=#739 id=739 data-nosnippet>739</a> <span class="doccomment">/// Computes syntax highlighting for the given file. |
| <a href=#740 id=740 data-nosnippet>740</a> </span><span class="kw">pub fn </span>highlight_as_html(<span class="kw-2">&</span><span class="self">self</span>, file_id: FileId, rainbow: bool) -> Cancellable<String> { |
| <a href=#741 id=741 data-nosnippet>741</a> <span class="self">self</span>.with_db(|db| syntax_highlighting::highlight_as_html(db, file_id, rainbow)) |
| <a href=#742 id=742 data-nosnippet>742</a> } |
| <a href=#743 id=743 data-nosnippet>743</a> |
| <a href=#744 id=744 data-nosnippet>744</a> <span class="doccomment">/// Computes completions at the given position. |
| <a href=#745 id=745 data-nosnippet>745</a> </span><span class="kw">pub fn </span>completions( |
| <a href=#746 id=746 data-nosnippet>746</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#747 id=747 data-nosnippet>747</a> config: <span class="kw-2">&</span>CompletionConfig<<span class="lifetime">'_</span>>, |
| <a href=#748 id=748 data-nosnippet>748</a> position: FilePosition, |
| <a href=#749 id=749 data-nosnippet>749</a> trigger_character: <span class="prelude-ty">Option</span><char>, |
| <a href=#750 id=750 data-nosnippet>750</a> ) -> Cancellable<<span class="prelude-ty">Option</span><Vec<CompletionItem>>> { |
| <a href=#751 id=751 data-nosnippet>751</a> <span class="self">self</span>.with_db(|db| ide_completion::completions(db, config, position, trigger_character)) |
| <a href=#752 id=752 data-nosnippet>752</a> } |
| <a href=#753 id=753 data-nosnippet>753</a> |
| <a href=#754 id=754 data-nosnippet>754</a> <span class="doccomment">/// Resolves additional completion data at the position given. |
| <a href=#755 id=755 data-nosnippet>755</a> </span><span class="kw">pub fn </span>resolve_completion_edits( |
| <a href=#756 id=756 data-nosnippet>756</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#757 id=757 data-nosnippet>757</a> config: <span class="kw-2">&</span>CompletionConfig<<span class="lifetime">'_</span>>, |
| <a href=#758 id=758 data-nosnippet>758</a> position: FilePosition, |
| <a href=#759 id=759 data-nosnippet>759</a> imports: <span class="kw">impl </span>IntoIterator<Item = String> + std::panic::UnwindSafe, |
| <a href=#760 id=760 data-nosnippet>760</a> ) -> Cancellable<Vec<TextEdit>> { |
| <a href=#761 id=761 data-nosnippet>761</a> <span class="prelude-val">Ok</span>(<span class="self">self |
| <a href=#762 id=762 data-nosnippet>762</a> </span>.with_db(|db| ide_completion::resolve_completion_edits(db, config, position, imports))<span class="question-mark">? |
| <a href=#763 id=763 data-nosnippet>763</a> </span>.unwrap_or_default()) |
| <a href=#764 id=764 data-nosnippet>764</a> } |
| <a href=#765 id=765 data-nosnippet>765</a> |
| <a href=#766 id=766 data-nosnippet>766</a> <span class="doccomment">/// Computes the set of parser level diagnostics for the given file. |
| <a href=#767 id=767 data-nosnippet>767</a> </span><span class="kw">pub fn </span>syntax_diagnostics( |
| <a href=#768 id=768 data-nosnippet>768</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#769 id=769 data-nosnippet>769</a> config: <span class="kw-2">&</span>DiagnosticsConfig, |
| <a href=#770 id=770 data-nosnippet>770</a> file_id: FileId, |
| <a href=#771 id=771 data-nosnippet>771</a> ) -> Cancellable<Vec<Diagnostic>> { |
| <a href=#772 id=772 data-nosnippet>772</a> <span class="self">self</span>.with_db(|db| ide_diagnostics::syntax_diagnostics(db, config, file_id)) |
| <a href=#773 id=773 data-nosnippet>773</a> } |
| <a href=#774 id=774 data-nosnippet>774</a> |
| <a href=#775 id=775 data-nosnippet>775</a> <span class="doccomment">/// Computes the set of semantic diagnostics for the given file. |
| <a href=#776 id=776 data-nosnippet>776</a> </span><span class="kw">pub fn </span>semantic_diagnostics( |
| <a href=#777 id=777 data-nosnippet>777</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#778 id=778 data-nosnippet>778</a> config: <span class="kw-2">&</span>DiagnosticsConfig, |
| <a href=#779 id=779 data-nosnippet>779</a> resolve: AssistResolveStrategy, |
| <a href=#780 id=780 data-nosnippet>780</a> file_id: FileId, |
| <a href=#781 id=781 data-nosnippet>781</a> ) -> Cancellable<Vec<Diagnostic>> { |
| <a href=#782 id=782 data-nosnippet>782</a> <span class="self">self</span>.with_db(|db| ide_diagnostics::semantic_diagnostics(db, config, <span class="kw-2">&</span>resolve, file_id)) |
| <a href=#783 id=783 data-nosnippet>783</a> } |
| <a href=#784 id=784 data-nosnippet>784</a> |
| <a href=#785 id=785 data-nosnippet>785</a> <span class="doccomment">/// Computes the set of both syntax and semantic diagnostics for the given file. |
| <a href=#786 id=786 data-nosnippet>786</a> </span><span class="kw">pub fn </span>full_diagnostics( |
| <a href=#787 id=787 data-nosnippet>787</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#788 id=788 data-nosnippet>788</a> config: <span class="kw-2">&</span>DiagnosticsConfig, |
| <a href=#789 id=789 data-nosnippet>789</a> resolve: AssistResolveStrategy, |
| <a href=#790 id=790 data-nosnippet>790</a> file_id: FileId, |
| <a href=#791 id=791 data-nosnippet>791</a> ) -> Cancellable<Vec<Diagnostic>> { |
| <a href=#792 id=792 data-nosnippet>792</a> <span class="self">self</span>.with_db(|db| ide_diagnostics::full_diagnostics(db, config, <span class="kw-2">&</span>resolve, file_id)) |
| <a href=#793 id=793 data-nosnippet>793</a> } |
| <a href=#794 id=794 data-nosnippet>794</a> |
| <a href=#795 id=795 data-nosnippet>795</a> <span class="doccomment">/// Convenience function to return assists + quick fixes for diagnostics |
| <a href=#796 id=796 data-nosnippet>796</a> </span><span class="kw">pub fn </span>assists_with_fixes( |
| <a href=#797 id=797 data-nosnippet>797</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#798 id=798 data-nosnippet>798</a> assist_config: <span class="kw-2">&</span>AssistConfig, |
| <a href=#799 id=799 data-nosnippet>799</a> diagnostics_config: <span class="kw-2">&</span>DiagnosticsConfig, |
| <a href=#800 id=800 data-nosnippet>800</a> resolve: AssistResolveStrategy, |
| <a href=#801 id=801 data-nosnippet>801</a> frange: FileRange, |
| <a href=#802 id=802 data-nosnippet>802</a> ) -> Cancellable<Vec<Assist>> { |
| <a href=#803 id=803 data-nosnippet>803</a> <span class="kw">let </span>include_fixes = <span class="kw">match </span><span class="kw-2">&</span>assist_config.allowed { |
| <a href=#804 id=804 data-nosnippet>804</a> <span class="prelude-val">Some</span>(it) => it.contains(<span class="kw-2">&</span>AssistKind::QuickFix), |
| <a href=#805 id=805 data-nosnippet>805</a> <span class="prelude-val">None </span>=> <span class="bool-val">true</span>, |
| <a href=#806 id=806 data-nosnippet>806</a> }; |
| <a href=#807 id=807 data-nosnippet>807</a> |
| <a href=#808 id=808 data-nosnippet>808</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#809 id=809 data-nosnippet>809</a> <span class="kw">let </span>diagnostic_assists = <span class="kw">if </span>diagnostics_config.enabled && include_fixes { |
| <a href=#810 id=810 data-nosnippet>810</a> ide_diagnostics::full_diagnostics(db, diagnostics_config, <span class="kw-2">&</span>resolve, frange.file_id) |
| <a href=#811 id=811 data-nosnippet>811</a> .into_iter() |
| <a href=#812 id=812 data-nosnippet>812</a> .flat_map(|it| it.fixes.unwrap_or_default()) |
| <a href=#813 id=813 data-nosnippet>813</a> .filter(|it| it.target.intersect(frange.range).is_some()) |
| <a href=#814 id=814 data-nosnippet>814</a> .collect() |
| <a href=#815 id=815 data-nosnippet>815</a> } <span class="kw">else </span>{ |
| <a href=#816 id=816 data-nosnippet>816</a> Vec::new() |
| <a href=#817 id=817 data-nosnippet>817</a> }; |
| <a href=#818 id=818 data-nosnippet>818</a> <span class="kw">let </span>ssr_assists = ssr::ssr_assists(db, <span class="kw-2">&</span>resolve, frange); |
| <a href=#819 id=819 data-nosnippet>819</a> <span class="kw">let </span>assists = ide_assists::assists(db, assist_config, resolve, frange); |
| <a href=#820 id=820 data-nosnippet>820</a> |
| <a href=#821 id=821 data-nosnippet>821</a> <span class="kw">let </span><span class="kw-2">mut </span>res = diagnostic_assists; |
| <a href=#822 id=822 data-nosnippet>822</a> res.extend(ssr_assists); |
| <a href=#823 id=823 data-nosnippet>823</a> res.extend(assists); |
| <a href=#824 id=824 data-nosnippet>824</a> |
| <a href=#825 id=825 data-nosnippet>825</a> res |
| <a href=#826 id=826 data-nosnippet>826</a> }) |
| <a href=#827 id=827 data-nosnippet>827</a> } |
| <a href=#828 id=828 data-nosnippet>828</a> |
| <a href=#829 id=829 data-nosnippet>829</a> <span class="doccomment">/// Returns the edit required to rename reference at the position to the new |
| <a href=#830 id=830 data-nosnippet>830</a> /// name. |
| <a href=#831 id=831 data-nosnippet>831</a> </span><span class="kw">pub fn </span>rename( |
| <a href=#832 id=832 data-nosnippet>832</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#833 id=833 data-nosnippet>833</a> position: FilePosition, |
| <a href=#834 id=834 data-nosnippet>834</a> new_name: <span class="kw-2">&</span>str, |
| <a href=#835 id=835 data-nosnippet>835</a> config: <span class="kw-2">&</span>RenameConfig, |
| <a href=#836 id=836 data-nosnippet>836</a> ) -> Cancellable<<span class="prelude-ty">Result</span><SourceChange, RenameError>> { |
| <a href=#837 id=837 data-nosnippet>837</a> <span class="self">self</span>.with_db(|db| rename::rename(db, position, new_name, config)) |
| <a href=#838 id=838 data-nosnippet>838</a> } |
| <a href=#839 id=839 data-nosnippet>839</a> |
| <a href=#840 id=840 data-nosnippet>840</a> <span class="kw">pub fn </span>prepare_rename( |
| <a href=#841 id=841 data-nosnippet>841</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#842 id=842 data-nosnippet>842</a> position: FilePosition, |
| <a href=#843 id=843 data-nosnippet>843</a> ) -> Cancellable<<span class="prelude-ty">Result</span><RangeInfo<()>, RenameError>> { |
| <a href=#844 id=844 data-nosnippet>844</a> <span class="self">self</span>.with_db(|db| rename::prepare_rename(db, position)) |
| <a href=#845 id=845 data-nosnippet>845</a> } |
| <a href=#846 id=846 data-nosnippet>846</a> |
| <a href=#847 id=847 data-nosnippet>847</a> <span class="kw">pub fn </span>will_rename_file( |
| <a href=#848 id=848 data-nosnippet>848</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#849 id=849 data-nosnippet>849</a> file_id: FileId, |
| <a href=#850 id=850 data-nosnippet>850</a> new_name_stem: <span class="kw-2">&</span>str, |
| <a href=#851 id=851 data-nosnippet>851</a> ) -> Cancellable<<span class="prelude-ty">Option</span><SourceChange>> { |
| <a href=#852 id=852 data-nosnippet>852</a> <span class="self">self</span>.with_db(|db| rename::will_rename_file(db, file_id, new_name_stem)) |
| <a href=#853 id=853 data-nosnippet>853</a> } |
| <a href=#854 id=854 data-nosnippet>854</a> |
| <a href=#855 id=855 data-nosnippet>855</a> <span class="kw">pub fn </span>structural_search_replace( |
| <a href=#856 id=856 data-nosnippet>856</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#857 id=857 data-nosnippet>857</a> query: <span class="kw-2">&</span>str, |
| <a href=#858 id=858 data-nosnippet>858</a> parse_only: bool, |
| <a href=#859 id=859 data-nosnippet>859</a> resolve_context: FilePosition, |
| <a href=#860 id=860 data-nosnippet>860</a> selections: Vec<FileRange>, |
| <a href=#861 id=861 data-nosnippet>861</a> ) -> Cancellable<<span class="prelude-ty">Result</span><SourceChange, SsrError>> { |
| <a href=#862 id=862 data-nosnippet>862</a> <span class="self">self</span>.with_db(|db| { |
| <a href=#863 id=863 data-nosnippet>863</a> <span class="kw">let </span>rule: ide_ssr::SsrRule = query.parse()<span class="question-mark">?</span>; |
| <a href=#864 id=864 data-nosnippet>864</a> <span class="kw">let </span><span class="kw-2">mut </span>match_finder = |
| <a href=#865 id=865 data-nosnippet>865</a> ide_ssr::MatchFinder::in_context(db, resolve_context, selections)<span class="question-mark">?</span>; |
| <a href=#866 id=866 data-nosnippet>866</a> match_finder.add_rule(rule)<span class="question-mark">?</span>; |
| <a href=#867 id=867 data-nosnippet>867</a> <span class="kw">let </span>edits = <span class="kw">if </span>parse_only { Default::default() } <span class="kw">else </span>{ match_finder.edits() }; |
| <a href=#868 id=868 data-nosnippet>868</a> <span class="prelude-val">Ok</span>(SourceChange::from_iter(edits)) |
| <a href=#869 id=869 data-nosnippet>869</a> }) |
| <a href=#870 id=870 data-nosnippet>870</a> } |
| <a href=#871 id=871 data-nosnippet>871</a> |
| <a href=#872 id=872 data-nosnippet>872</a> <span class="kw">pub fn </span>annotations( |
| <a href=#873 id=873 data-nosnippet>873</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#874 id=874 data-nosnippet>874</a> config: <span class="kw-2">&</span>AnnotationConfig<<span class="lifetime">'_</span>>, |
| <a href=#875 id=875 data-nosnippet>875</a> file_id: FileId, |
| <a href=#876 id=876 data-nosnippet>876</a> ) -> Cancellable<Vec<Annotation>> { |
| <a href=#877 id=877 data-nosnippet>877</a> <span class="self">self</span>.with_db(|db| annotations::annotations(db, config, file_id)) |
| <a href=#878 id=878 data-nosnippet>878</a> } |
| <a href=#879 id=879 data-nosnippet>879</a> |
| <a href=#880 id=880 data-nosnippet>880</a> <span class="kw">pub fn </span>resolve_annotation( |
| <a href=#881 id=881 data-nosnippet>881</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#882 id=882 data-nosnippet>882</a> config: <span class="kw-2">&</span>AnnotationConfig<<span class="lifetime">'_</span>>, |
| <a href=#883 id=883 data-nosnippet>883</a> annotation: Annotation, |
| <a href=#884 id=884 data-nosnippet>884</a> ) -> Cancellable<Annotation> { |
| <a href=#885 id=885 data-nosnippet>885</a> <span class="self">self</span>.with_db(|db| annotations::resolve_annotation(db, config, annotation)) |
| <a href=#886 id=886 data-nosnippet>886</a> } |
| <a href=#887 id=887 data-nosnippet>887</a> |
| <a href=#888 id=888 data-nosnippet>888</a> <span class="kw">pub fn </span>move_item( |
| <a href=#889 id=889 data-nosnippet>889</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#890 id=890 data-nosnippet>890</a> range: FileRange, |
| <a href=#891 id=891 data-nosnippet>891</a> direction: Direction, |
| <a href=#892 id=892 data-nosnippet>892</a> ) -> Cancellable<<span class="prelude-ty">Option</span><TextEdit>> { |
| <a href=#893 id=893 data-nosnippet>893</a> <span class="self">self</span>.with_db(|db| move_item::move_item(db, range, direction)) |
| <a href=#894 id=894 data-nosnippet>894</a> } |
| <a href=#895 id=895 data-nosnippet>895</a> |
| <a href=#896 id=896 data-nosnippet>896</a> <span class="kw">pub fn </span>get_recursive_memory_layout( |
| <a href=#897 id=897 data-nosnippet>897</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#898 id=898 data-nosnippet>898</a> position: FilePosition, |
| <a href=#899 id=899 data-nosnippet>899</a> ) -> Cancellable<<span class="prelude-ty">Option</span><RecursiveMemoryLayout>> { |
| <a href=#900 id=900 data-nosnippet>900</a> <span class="self">self</span>.with_db(|db| view_memory_layout(db, position)) |
| <a href=#901 id=901 data-nosnippet>901</a> } |
| <a href=#902 id=902 data-nosnippet>902</a> |
| <a href=#903 id=903 data-nosnippet>903</a> <span class="kw">pub fn </span>editioned_file_id_to_vfs(<span class="kw-2">&</span><span class="self">self</span>, file_id: hir::EditionedFileId) -> FileId { |
| <a href=#904 id=904 data-nosnippet>904</a> file_id.file_id(<span class="kw-2">&</span><span class="self">self</span>.db) |
| <a href=#905 id=905 data-nosnippet>905</a> } |
| <a href=#906 id=906 data-nosnippet>906</a> |
| <a href=#907 id=907 data-nosnippet>907</a> <span class="doccomment">/// Performs an operation on the database that may be canceled. |
| <a href=#908 id=908 data-nosnippet>908</a> /// |
| <a href=#909 id=909 data-nosnippet>909</a> /// rust-analyzer needs to be able to answer semantic questions about the |
| <a href=#910 id=910 data-nosnippet>910</a> /// code while the code is being modified. A common problem is that a |
| <a href=#911 id=911 data-nosnippet>911</a> /// long-running query is being calculated when a new change arrives. |
| <a href=#912 id=912 data-nosnippet>912</a> /// |
| <a href=#913 id=913 data-nosnippet>913</a> /// We can't just apply the change immediately: this will cause the pending |
| <a href=#914 id=914 data-nosnippet>914</a> /// query to see inconsistent state (it will observe an absence of |
| <a href=#915 id=915 data-nosnippet>915</a> /// repeatable read). So what we do is we **cancel** all pending queries |
| <a href=#916 id=916 data-nosnippet>916</a> /// before applying the change. |
| <a href=#917 id=917 data-nosnippet>917</a> /// |
| <a href=#918 id=918 data-nosnippet>918</a> /// Salsa implements cancellation by unwinding with a special value and |
| <a href=#919 id=919 data-nosnippet>919</a> /// catching it on the API boundary. |
| <a href=#920 id=920 data-nosnippet>920</a> </span><span class="kw">fn </span>with_db<F, T>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> Cancellable<T> |
| <a href=#921 id=921 data-nosnippet>921</a> <span class="kw">where |
| <a href=#922 id=922 data-nosnippet>922</a> </span>F: FnOnce(<span class="kw-2">&</span>RootDatabase) -> T + std::panic::UnwindSafe, |
| <a href=#923 id=923 data-nosnippet>923</a> { |
| <a href=#924 id=924 data-nosnippet>924</a> <span class="comment">// We use `attach_db_allow_change()` and not `attach_db()` because fixture injection can change the database. |
| <a href=#925 id=925 data-nosnippet>925</a> </span>hir::attach_db_allow_change(<span class="kw-2">&</span><span class="self">self</span>.db, || Cancelled::catch(|| f(<span class="kw-2">&</span><span class="self">self</span>.db))) |
| <a href=#926 id=926 data-nosnippet>926</a> } |
| <a href=#927 id=927 data-nosnippet>927</a>} |
| <a href=#928 id=928 data-nosnippet>928</a> |
| <a href=#929 id=929 data-nosnippet>929</a><span class="attr">#[test] |
| <a href=#930 id=930 data-nosnippet>930</a></span><span class="kw">fn </span>analysis_is_send() { |
| <a href=#931 id=931 data-nosnippet>931</a> <span class="kw">fn </span>is_send<T: Send>() {} |
| <a href=#932 id=932 data-nosnippet>932</a> is_send::<Analysis>(); |
| <a href=#933 id=933 data-nosnippet>933</a>}</code></pre></div></section></main></body></html> |
