| <!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-completion/src/item.rs`."><title>item.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-77263533.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ide_completion" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-ffcac47a.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">ide_completion/</div>item.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">//! See `CompletionItem` structure. |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>std::{fmt, mem}; |
| <a href=#4 id=4 data-nosnippet>4</a> |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>hir::Mutability; |
| <a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>ide_db::text_edit::TextEdit; |
| <a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>ide_db::{ |
| <a href=#8 id=8 data-nosnippet>8</a> RootDatabase, SnippetCap, SymbolKind, documentation::Documentation, |
| <a href=#9 id=9 data-nosnippet>9</a> imports::import_assets::LocatedImport, |
| <a href=#10 id=10 data-nosnippet>10</a>}; |
| <a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span>itertools::Itertools; |
| <a href=#12 id=12 data-nosnippet>12</a><span class="kw">use </span>macros::UpmapFromRaFixture; |
| <a href=#13 id=13 data-nosnippet>13</a><span class="kw">use </span>smallvec::SmallVec; |
| <a href=#14 id=14 data-nosnippet>14</a><span class="kw">use </span>stdx::{format_to, impl_from, never}; |
| <a href=#15 id=15 data-nosnippet>15</a><span class="kw">use </span>syntax::{Edition, SmolStr, TextRange, TextSize, format_smolstr}; |
| <a href=#16 id=16 data-nosnippet>16</a> |
| <a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>crate::{ |
| <a href=#18 id=18 data-nosnippet>18</a> context::{CompletionContext, PathCompletionCtx}, |
| <a href=#19 id=19 data-nosnippet>19</a> render::{RenderContext, render_path_resolution}, |
| <a href=#20 id=20 data-nosnippet>20</a>}; |
| <a href=#21 id=21 data-nosnippet>21</a> |
| <a href=#22 id=22 data-nosnippet>22</a><span class="doccomment">/// `CompletionItem` describes a single completion entity which expands to 1 or more entries in the |
| <a href=#23 id=23 data-nosnippet>23</a>/// editor pop-up. |
| <a href=#24 id=24 data-nosnippet>24</a>/// |
| <a href=#25 id=25 data-nosnippet>25</a>/// It is basically a POD with various properties. To construct a [`CompletionItem`], |
| <a href=#26 id=26 data-nosnippet>26</a>/// use the [`Builder`] struct. |
| <a href=#27 id=27 data-nosnippet>27</a></span><span class="attr">#[derive(Clone, UpmapFromRaFixture)] |
| <a href=#28 id=28 data-nosnippet>28</a>#[non_exhaustive] |
| <a href=#29 id=29 data-nosnippet>29</a></span><span class="kw">pub struct </span>CompletionItem { |
| <a href=#30 id=30 data-nosnippet>30</a> <span class="doccomment">/// Label in the completion pop up which identifies completion. |
| <a href=#31 id=31 data-nosnippet>31</a> </span><span class="kw">pub </span>label: CompletionItemLabel, |
| <a href=#32 id=32 data-nosnippet>32</a> |
| <a href=#33 id=33 data-nosnippet>33</a> <span class="doccomment">/// Range of identifier that is being completed. |
| <a href=#34 id=34 data-nosnippet>34</a> /// |
| <a href=#35 id=35 data-nosnippet>35</a> /// It should be used primarily for UI, but we also use this to convert |
| <a href=#36 id=36 data-nosnippet>36</a> /// generic TextEdit into LSP's completion edit (see conv.rs). |
| <a href=#37 id=37 data-nosnippet>37</a> /// |
| <a href=#38 id=38 data-nosnippet>38</a> /// `source_range` must contain the completion offset. `text_edit` should |
| <a href=#39 id=39 data-nosnippet>39</a> /// start with what `source_range` points to, or VSCode will filter out the |
| <a href=#40 id=40 data-nosnippet>40</a> /// completion silently. |
| <a href=#41 id=41 data-nosnippet>41</a> </span><span class="kw">pub </span>source_range: TextRange, |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="doccomment">/// What happens when user selects this item. |
| <a href=#43 id=43 data-nosnippet>43</a> /// |
| <a href=#44 id=44 data-nosnippet>44</a> /// Typically, replaces `source_range` with new identifier. |
| <a href=#45 id=45 data-nosnippet>45</a> </span><span class="kw">pub </span>text_edit: TextEdit, |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">pub </span>is_snippet: bool, |
| <a href=#47 id=47 data-nosnippet>47</a> |
| <a href=#48 id=48 data-nosnippet>48</a> <span class="doccomment">/// What item (struct, function, etc) are we completing. |
| <a href=#49 id=49 data-nosnippet>49</a> </span><span class="kw">pub </span>kind: CompletionItemKind, |
| <a href=#50 id=50 data-nosnippet>50</a> |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="doccomment">/// Lookup is used to check if completion item indeed can complete current |
| <a href=#52 id=52 data-nosnippet>52</a> /// ident. |
| <a href=#53 id=53 data-nosnippet>53</a> /// |
| <a href=#54 id=54 data-nosnippet>54</a> /// That is, in `foo.bar$0` lookup of `abracadabra` will be accepted (it |
| <a href=#55 id=55 data-nosnippet>55</a> /// contains `bar` sub sequence), and `quux` will rejected. |
| <a href=#56 id=56 data-nosnippet>56</a> </span><span class="kw">pub </span>lookup: SmolStr, |
| <a href=#57 id=57 data-nosnippet>57</a> |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="doccomment">/// Additional info to show in the UI pop up. |
| <a href=#59 id=59 data-nosnippet>59</a> </span><span class="kw">pub </span>detail: <span class="prelude-ty">Option</span><String>, |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="comment">// FIXME: Make this with `'db` lifetime. |
| <a href=#61 id=61 data-nosnippet>61</a> </span><span class="kw">pub </span>documentation: <span class="prelude-ty">Option</span><Documentation<<span class="lifetime">'static</span>>>, |
| <a href=#62 id=62 data-nosnippet>62</a> |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="doccomment">/// Whether this item is marked as deprecated |
| <a href=#64 id=64 data-nosnippet>64</a> </span><span class="kw">pub </span>deprecated: bool, |
| <a href=#65 id=65 data-nosnippet>65</a> |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="doccomment">/// If completing a function call, ask the editor to show parameter popup |
| <a href=#67 id=67 data-nosnippet>67</a> /// after completion. |
| <a href=#68 id=68 data-nosnippet>68</a> </span><span class="kw">pub </span>trigger_call_info: bool, |
| <a href=#69 id=69 data-nosnippet>69</a> |
| <a href=#70 id=70 data-nosnippet>70</a> <span class="doccomment">/// We use this to sort completion. Relevance records facts like "do the |
| <a href=#71 id=71 data-nosnippet>71</a> /// types align precisely?". We can't sort by relevances directly, they are |
| <a href=#72 id=72 data-nosnippet>72</a> /// only partially ordered. |
| <a href=#73 id=73 data-nosnippet>73</a> /// |
| <a href=#74 id=74 data-nosnippet>74</a> /// Note that Relevance ignores fuzzy match score. We compute Relevance for |
| <a href=#75 id=75 data-nosnippet>75</a> /// all possible items, and then separately build an ordered completion list |
| <a href=#76 id=76 data-nosnippet>76</a> /// based on relevance and fuzzy matching with the already typed identifier. |
| <a href=#77 id=77 data-nosnippet>77</a> </span><span class="kw">pub </span>relevance: CompletionRelevance, |
| <a href=#78 id=78 data-nosnippet>78</a> |
| <a href=#79 id=79 data-nosnippet>79</a> <span class="doccomment">/// Indicates that a reference or mutable reference to this variable is a |
| <a href=#80 id=80 data-nosnippet>80</a> /// possible match. |
| <a href=#81 id=81 data-nosnippet>81</a> </span><span class="comment">// FIXME: We shouldn't expose Mutability here (that is HIR types at all), its fine for now though |
| <a href=#82 id=82 data-nosnippet>82</a> // until we have more splitting completions in which case we should think about |
| <a href=#83 id=83 data-nosnippet>83</a> // generalizing this. See https://github.com/rust-lang/rust-analyzer/issues/12571 |
| <a href=#84 id=84 data-nosnippet>84</a> </span><span class="kw">pub </span>ref_match: <span class="prelude-ty">Option</span><(CompletionItemRefMode, TextSize)>, |
| <a href=#85 id=85 data-nosnippet>85</a> |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="doccomment">/// The import data to add to completion's edits. |
| <a href=#87 id=87 data-nosnippet>87</a> </span><span class="kw">pub </span>import_to_add: SmallVec<[String; <span class="number">1</span>]>, |
| <a href=#88 id=88 data-nosnippet>88</a>} |
| <a href=#89 id=89 data-nosnippet>89</a> |
| <a href=#90 id=90 data-nosnippet>90</a><span class="attr">#[derive(Clone, PartialEq, Eq, PartialOrd, Ord)] |
| <a href=#91 id=91 data-nosnippet>91</a></span><span class="kw">pub struct </span>CompletionItemLabel { |
| <a href=#92 id=92 data-nosnippet>92</a> <span class="doccomment">/// The primary label for the completion item. |
| <a href=#93 id=93 data-nosnippet>93</a> </span><span class="kw">pub </span>primary: SmolStr, |
| <a href=#94 id=94 data-nosnippet>94</a> <span class="doccomment">/// The left detail for the completion item, usually rendered right next to the primary label. |
| <a href=#95 id=95 data-nosnippet>95</a> </span><span class="kw">pub </span>detail_left: <span class="prelude-ty">Option</span><String>, |
| <a href=#96 id=96 data-nosnippet>96</a> <span class="doccomment">/// The right detail for the completion item, usually rendered right aligned at the end of the completion item. |
| <a href=#97 id=97 data-nosnippet>97</a> </span><span class="kw">pub </span>detail_right: <span class="prelude-ty">Option</span><String>, |
| <a href=#98 id=98 data-nosnippet>98</a>} |
| <a href=#99 id=99 data-nosnippet>99</a><span class="comment">// We use custom debug for CompletionItem to make snapshot tests more readable. |
| <a href=#100 id=100 data-nosnippet>100</a></span><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>CompletionItem { |
| <a href=#101 id=101 data-nosnippet>101</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <a href=#102 id=102 data-nosnippet>102</a> <span class="kw">let </span><span class="kw-2">mut </span>s = f.debug_struct(<span class="string">"CompletionItem"</span>); |
| <a href=#103 id=103 data-nosnippet>103</a> s.field(<span class="string">"label"</span>, <span class="kw-2">&</span><span class="self">self</span>.label.primary) |
| <a href=#104 id=104 data-nosnippet>104</a> .field(<span class="string">"detail_left"</span>, <span class="kw-2">&</span><span class="self">self</span>.label.detail_left) |
| <a href=#105 id=105 data-nosnippet>105</a> .field(<span class="string">"detail_right"</span>, <span class="kw-2">&</span><span class="self">self</span>.label.detail_right) |
| <a href=#106 id=106 data-nosnippet>106</a> .field(<span class="string">"source_range"</span>, <span class="kw-2">&</span><span class="self">self</span>.source_range); |
| <a href=#107 id=107 data-nosnippet>107</a> <span class="kw">if </span><span class="self">self</span>.text_edit.len() == <span class="number">1 </span>{ |
| <a href=#108 id=108 data-nosnippet>108</a> <span class="kw">let </span>atom = <span class="self">self</span>.text_edit.iter().next().unwrap(); |
| <a href=#109 id=109 data-nosnippet>109</a> s.field(<span class="string">"delete"</span>, <span class="kw-2">&</span>atom.delete); |
| <a href=#110 id=110 data-nosnippet>110</a> s.field(<span class="string">"insert"</span>, <span class="kw-2">&</span>atom.insert); |
| <a href=#111 id=111 data-nosnippet>111</a> } <span class="kw">else </span>{ |
| <a href=#112 id=112 data-nosnippet>112</a> s.field(<span class="string">"text_edit"</span>, <span class="kw-2">&</span><span class="self">self</span>.text_edit); |
| <a href=#113 id=113 data-nosnippet>113</a> } |
| <a href=#114 id=114 data-nosnippet>114</a> s.field(<span class="string">"kind"</span>, <span class="kw-2">&</span><span class="self">self</span>.kind); |
| <a href=#115 id=115 data-nosnippet>115</a> <span class="kw">if </span><span class="self">self</span>.lookup() != <span class="self">self</span>.label.primary { |
| <a href=#116 id=116 data-nosnippet>116</a> s.field(<span class="string">"lookup"</span>, <span class="kw-2">&</span><span class="self">self</span>.lookup()); |
| <a href=#117 id=117 data-nosnippet>117</a> } |
| <a href=#118 id=118 data-nosnippet>118</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(detail) = <span class="kw-2">&</span><span class="self">self</span>.detail { |
| <a href=#119 id=119 data-nosnippet>119</a> s.field(<span class="string">"detail"</span>, <span class="kw-2">&</span>detail); |
| <a href=#120 id=120 data-nosnippet>120</a> } |
| <a href=#121 id=121 data-nosnippet>121</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(documentation) = <span class="kw-2">&</span><span class="self">self</span>.documentation { |
| <a href=#122 id=122 data-nosnippet>122</a> s.field(<span class="string">"documentation"</span>, <span class="kw-2">&</span>documentation); |
| <a href=#123 id=123 data-nosnippet>123</a> } |
| <a href=#124 id=124 data-nosnippet>124</a> <span class="kw">if </span><span class="self">self</span>.deprecated { |
| <a href=#125 id=125 data-nosnippet>125</a> s.field(<span class="string">"deprecated"</span>, <span class="kw-2">&</span><span class="bool-val">true</span>); |
| <a href=#126 id=126 data-nosnippet>126</a> } |
| <a href=#127 id=127 data-nosnippet>127</a> |
| <a href=#128 id=128 data-nosnippet>128</a> <span class="kw">if </span><span class="self">self</span>.<span class="macro">relevance !</span>= CompletionRelevance::default() { |
| <a href=#129 id=129 data-nosnippet>129</a> s.field(<span class="string">"relevance"</span>, <span class="kw-2">&</span><span class="self">self</span>.relevance); |
| <a href=#130 id=130 data-nosnippet>130</a> } |
| <a href=#131 id=131 data-nosnippet>131</a> |
| <a href=#132 id=132 data-nosnippet>132</a> <span class="kw">if let </span><span class="prelude-val">Some</span>((ref_mode, offset)) = <span class="self">self</span>.ref_match { |
| <a href=#133 id=133 data-nosnippet>133</a> <span class="kw">let </span>prefix = <span class="kw">match </span>ref_mode { |
| <a href=#134 id=134 data-nosnippet>134</a> CompletionItemRefMode::Reference(mutability) => <span class="kw">match </span>mutability { |
| <a href=#135 id=135 data-nosnippet>135</a> Mutability::Shared => <span class="string">"&"</span>, |
| <a href=#136 id=136 data-nosnippet>136</a> Mutability::Mut => <span class="string">"&mut "</span>, |
| <a href=#137 id=137 data-nosnippet>137</a> }, |
| <a href=#138 id=138 data-nosnippet>138</a> CompletionItemRefMode::Dereference => <span class="string">"*"</span>, |
| <a href=#139 id=139 data-nosnippet>139</a> }; |
| <a href=#140 id=140 data-nosnippet>140</a> s.field(<span class="string">"ref_match"</span>, <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{prefix}@{offset:?}"</span>)); |
| <a href=#141 id=141 data-nosnippet>141</a> } |
| <a href=#142 id=142 data-nosnippet>142</a> <span class="kw">if </span><span class="self">self</span>.trigger_call_info { |
| <a href=#143 id=143 data-nosnippet>143</a> s.field(<span class="string">"trigger_call_info"</span>, <span class="kw-2">&</span><span class="bool-val">true</span>); |
| <a href=#144 id=144 data-nosnippet>144</a> } |
| <a href=#145 id=145 data-nosnippet>145</a> s.finish() |
| <a href=#146 id=146 data-nosnippet>146</a> } |
| <a href=#147 id=147 data-nosnippet>147</a>} |
| <a href=#148 id=148 data-nosnippet>148</a> |
| <a href=#149 id=149 data-nosnippet>149</a><span class="attr">#[derive(Debug, Clone, Copy, Eq, PartialEq, Default)] |
| <a href=#150 id=150 data-nosnippet>150</a></span><span class="kw">pub struct </span>CompletionRelevance { |
| <a href=#151 id=151 data-nosnippet>151</a> <span class="doccomment">/// This is set when the identifier being completed matches up with the name that is expected, |
| <a href=#152 id=152 data-nosnippet>152</a> /// like in a function argument. |
| <a href=#153 id=153 data-nosnippet>153</a> /// |
| <a href=#154 id=154 data-nosnippet>154</a> /// ```ignore |
| <a href=#155 id=155 data-nosnippet>155</a> /// fn f(spam: String) {} |
| <a href=#156 id=156 data-nosnippet>156</a> /// fn main() { |
| <a href=#157 id=157 data-nosnippet>157</a> /// let spam = 92; |
| <a href=#158 id=158 data-nosnippet>158</a> /// f($0) // name of local matches the name of param |
| <a href=#159 id=159 data-nosnippet>159</a> /// } |
| <a href=#160 id=160 data-nosnippet>160</a> /// ``` |
| <a href=#161 id=161 data-nosnippet>161</a> </span><span class="kw">pub </span>exact_name_match: bool, |
| <a href=#162 id=162 data-nosnippet>162</a> <span class="doccomment">/// See [`CompletionRelevanceTypeMatch`]. |
| <a href=#163 id=163 data-nosnippet>163</a> </span><span class="kw">pub </span>type_match: <span class="prelude-ty">Option</span><CompletionRelevanceTypeMatch>, |
| <a href=#164 id=164 data-nosnippet>164</a> <span class="doccomment">/// Set for local variables. |
| <a href=#165 id=165 data-nosnippet>165</a> /// |
| <a href=#166 id=166 data-nosnippet>166</a> /// ```ignore |
| <a href=#167 id=167 data-nosnippet>167</a> /// fn foo(a: u32) { |
| <a href=#168 id=168 data-nosnippet>168</a> /// let b = 0; |
| <a href=#169 id=169 data-nosnippet>169</a> /// $0 // `a` and `b` are local |
| <a href=#170 id=170 data-nosnippet>170</a> /// } |
| <a href=#171 id=171 data-nosnippet>171</a> /// ``` |
| <a href=#172 id=172 data-nosnippet>172</a> </span><span class="kw">pub </span>is_local: bool, |
| <a href=#173 id=173 data-nosnippet>173</a> <span class="doccomment">/// Populated when the completion item comes from a trait (impl). |
| <a href=#174 id=174 data-nosnippet>174</a> </span><span class="kw">pub </span>trait_: <span class="prelude-ty">Option</span><CompletionRelevanceTraitInfo>, |
| <a href=#175 id=175 data-nosnippet>175</a> <span class="doccomment">/// This is set when an import is suggested in a use item whose name is already imported. |
| <a href=#176 id=176 data-nosnippet>176</a> </span><span class="kw">pub </span>is_name_already_imported: bool, |
| <a href=#177 id=177 data-nosnippet>177</a> <span class="doccomment">/// This is set for completions that will insert a `use` item. |
| <a href=#178 id=178 data-nosnippet>178</a> </span><span class="kw">pub </span>requires_import: bool, |
| <a href=#179 id=179 data-nosnippet>179</a> <span class="doccomment">/// Set for item completions that are private but in the workspace. |
| <a href=#180 id=180 data-nosnippet>180</a> </span><span class="kw">pub </span>is_private_editable: bool, |
| <a href=#181 id=181 data-nosnippet>181</a> <span class="doccomment">/// Set for postfix snippet item completions |
| <a href=#182 id=182 data-nosnippet>182</a> </span><span class="kw">pub </span>postfix_match: <span class="prelude-ty">Option</span><CompletionRelevancePostfixMatch>, |
| <a href=#183 id=183 data-nosnippet>183</a> <span class="doccomment">/// This is set for items that are function (associated or method) |
| <a href=#184 id=184 data-nosnippet>184</a> </span><span class="kw">pub </span>function: <span class="prelude-ty">Option</span><CompletionRelevanceFn>, |
| <a href=#185 id=185 data-nosnippet>185</a> <span class="doccomment">/// true when there is an `await.method()` or `iter().method()` completion. |
| <a href=#186 id=186 data-nosnippet>186</a> </span><span class="kw">pub </span>is_skipping_completion: bool, |
| <a href=#187 id=187 data-nosnippet>187</a>} |
| <a href=#188 id=188 data-nosnippet>188</a><span class="attr">#[derive(Debug, Clone, Copy, Eq, PartialEq)] |
| <a href=#189 id=189 data-nosnippet>189</a></span><span class="kw">pub struct </span>CompletionRelevanceTraitInfo { |
| <a href=#190 id=190 data-nosnippet>190</a> <span class="doccomment">/// The trait this item is from is a `#[doc(notable_trait)]` |
| <a href=#191 id=191 data-nosnippet>191</a> </span><span class="kw">pub </span>notable_trait: bool, |
| <a href=#192 id=192 data-nosnippet>192</a> <span class="doccomment">/// Set for method completions of the `core::ops` and `core::cmp` family. |
| <a href=#193 id=193 data-nosnippet>193</a> </span><span class="kw">pub </span>is_op_method: bool, |
| <a href=#194 id=194 data-nosnippet>194</a>} |
| <a href=#195 id=195 data-nosnippet>195</a> |
| <a href=#196 id=196 data-nosnippet>196</a><span class="attr">#[derive(Debug, Clone, Copy, Eq, PartialEq)] |
| <a href=#197 id=197 data-nosnippet>197</a></span><span class="kw">pub enum </span>CompletionRelevanceTypeMatch { |
| <a href=#198 id=198 data-nosnippet>198</a> <span class="doccomment">/// This is set in cases like these: |
| <a href=#199 id=199 data-nosnippet>199</a> /// |
| <a href=#200 id=200 data-nosnippet>200</a> /// ```ignore |
| <a href=#201 id=201 data-nosnippet>201</a> /// enum Option<T> { Some(T), None } |
| <a href=#202 id=202 data-nosnippet>202</a> /// fn f(a: Option<u32>) {} |
| <a href=#203 id=203 data-nosnippet>203</a> /// fn main { |
| <a href=#204 id=204 data-nosnippet>204</a> /// f(Option::N$0) // type `Option<T>` could unify with `Option<u32>` |
| <a href=#205 id=205 data-nosnippet>205</a> /// } |
| <a href=#206 id=206 data-nosnippet>206</a> /// ``` |
| <a href=#207 id=207 data-nosnippet>207</a> </span>CouldUnify, |
| <a href=#208 id=208 data-nosnippet>208</a> <span class="doccomment">/// This is set in cases where the type matches the expected type, like: |
| <a href=#209 id=209 data-nosnippet>209</a> /// |
| <a href=#210 id=210 data-nosnippet>210</a> /// ```ignore |
| <a href=#211 id=211 data-nosnippet>211</a> /// fn f(spam: String) {} |
| <a href=#212 id=212 data-nosnippet>212</a> /// fn main() { |
| <a href=#213 id=213 data-nosnippet>213</a> /// let foo = String::new(); |
| <a href=#214 id=214 data-nosnippet>214</a> /// f($0) // type of local matches the type of param |
| <a href=#215 id=215 data-nosnippet>215</a> /// } |
| <a href=#216 id=216 data-nosnippet>216</a> /// ``` |
| <a href=#217 id=217 data-nosnippet>217</a> </span>Exact, |
| <a href=#218 id=218 data-nosnippet>218</a>} |
| <a href=#219 id=219 data-nosnippet>219</a> |
| <a href=#220 id=220 data-nosnippet>220</a><span class="attr">#[derive(Debug, Clone, Copy, Eq, PartialEq)] |
| <a href=#221 id=221 data-nosnippet>221</a></span><span class="kw">pub enum </span>CompletionRelevancePostfixMatch { |
| <a href=#222 id=222 data-nosnippet>222</a> <span class="doccomment">/// Set in cases when item is postfix, but not exact |
| <a href=#223 id=223 data-nosnippet>223</a> </span>NonExact, |
| <a href=#224 id=224 data-nosnippet>224</a> <span class="doccomment">/// This is set in cases like these: |
| <a href=#225 id=225 data-nosnippet>225</a> /// |
| <a href=#226 id=226 data-nosnippet>226</a> /// ```ignore |
| <a href=#227 id=227 data-nosnippet>227</a> /// (a > b).not$0 |
| <a href=#228 id=228 data-nosnippet>228</a> /// ``` |
| <a href=#229 id=229 data-nosnippet>229</a> /// |
| <a href=#230 id=230 data-nosnippet>230</a> /// Basically, we want to guarantee that postfix snippets always takes |
| <a href=#231 id=231 data-nosnippet>231</a> /// precedence over everything else. |
| <a href=#232 id=232 data-nosnippet>232</a> </span>Exact, |
| <a href=#233 id=233 data-nosnippet>233</a>} |
| <a href=#234 id=234 data-nosnippet>234</a> |
| <a href=#235 id=235 data-nosnippet>235</a><span class="attr">#[derive(Debug, Clone, Copy, Eq, PartialEq)] |
| <a href=#236 id=236 data-nosnippet>236</a></span><span class="kw">pub struct </span>CompletionRelevanceFn { |
| <a href=#237 id=237 data-nosnippet>237</a> <span class="kw">pub </span>has_params: bool, |
| <a href=#238 id=238 data-nosnippet>238</a> <span class="kw">pub </span>has_self_param: bool, |
| <a href=#239 id=239 data-nosnippet>239</a> <span class="kw">pub </span>return_type: CompletionRelevanceReturnType, |
| <a href=#240 id=240 data-nosnippet>240</a>} |
| <a href=#241 id=241 data-nosnippet>241</a> |
| <a href=#242 id=242 data-nosnippet>242</a><span class="attr">#[derive(Debug, Clone, Copy, Eq, PartialEq)] |
| <a href=#243 id=243 data-nosnippet>243</a></span><span class="kw">pub enum </span>CompletionRelevanceReturnType { |
| <a href=#244 id=244 data-nosnippet>244</a> Other, |
| <a href=#245 id=245 data-nosnippet>245</a> <span class="doccomment">/// Returns the Self type of the impl/trait |
| <a href=#246 id=246 data-nosnippet>246</a> </span>DirectConstructor, |
| <a href=#247 id=247 data-nosnippet>247</a> <span class="doccomment">/// Returns something that indirectly constructs the `Self` type of the impl/trait e.g. `Result<Self, ()>`, `Option<Self>` |
| <a href=#248 id=248 data-nosnippet>248</a> </span>Constructor, |
| <a href=#249 id=249 data-nosnippet>249</a> <span class="doccomment">/// Returns a possible builder for the type |
| <a href=#250 id=250 data-nosnippet>250</a> </span>Builder, |
| <a href=#251 id=251 data-nosnippet>251</a>} |
| <a href=#252 id=252 data-nosnippet>252</a> |
| <a href=#253 id=253 data-nosnippet>253</a><span class="kw">impl </span>CompletionRelevance { |
| <a href=#254 id=254 data-nosnippet>254</a> <span class="doccomment">/// Provides a relevance score. Higher values are more relevant. |
| <a href=#255 id=255 data-nosnippet>255</a> /// |
| <a href=#256 id=256 data-nosnippet>256</a> /// The absolute value of the relevance score is not meaningful, for |
| <a href=#257 id=257 data-nosnippet>257</a> /// example a value of BASE_SCORE doesn't mean "not relevant", rather |
| <a href=#258 id=258 data-nosnippet>258</a> /// it means "least relevant". The score value should only be used |
| <a href=#259 id=259 data-nosnippet>259</a> /// for relative ordering. |
| <a href=#260 id=260 data-nosnippet>260</a> /// |
| <a href=#261 id=261 data-nosnippet>261</a> /// See is_relevant if you need to make some judgement about score |
| <a href=#262 id=262 data-nosnippet>262</a> /// in an absolute sense. |
| <a href=#263 id=263 data-nosnippet>263</a> </span><span class="kw">const </span>BASE_SCORE: u32 = u32::MAX / <span class="number">2</span>; |
| <a href=#264 id=264 data-nosnippet>264</a> |
| <a href=#265 id=265 data-nosnippet>265</a> <span class="kw">pub fn </span>score(<span class="self">self</span>) -> u32 { |
| <a href=#266 id=266 data-nosnippet>266</a> <span class="kw">let </span><span class="kw-2">mut </span>score = <span class="self">Self</span>::BASE_SCORE; |
| <a href=#267 id=267 data-nosnippet>267</a> <span class="kw">let </span>CompletionRelevance { |
| <a href=#268 id=268 data-nosnippet>268</a> exact_name_match, |
| <a href=#269 id=269 data-nosnippet>269</a> type_match, |
| <a href=#270 id=270 data-nosnippet>270</a> is_local, |
| <a href=#271 id=271 data-nosnippet>271</a> is_name_already_imported, |
| <a href=#272 id=272 data-nosnippet>272</a> requires_import, |
| <a href=#273 id=273 data-nosnippet>273</a> is_private_editable, |
| <a href=#274 id=274 data-nosnippet>274</a> postfix_match, |
| <a href=#275 id=275 data-nosnippet>275</a> trait_, |
| <a href=#276 id=276 data-nosnippet>276</a> function, |
| <a href=#277 id=277 data-nosnippet>277</a> is_skipping_completion, |
| <a href=#278 id=278 data-nosnippet>278</a> } = <span class="self">self</span>; |
| <a href=#279 id=279 data-nosnippet>279</a> |
| <a href=#280 id=280 data-nosnippet>280</a> <span class="comment">// only applicable for completions within use items |
| <a href=#281 id=281 data-nosnippet>281</a> // lower rank for conflicting import names |
| <a href=#282 id=282 data-nosnippet>282</a> </span><span class="kw">if </span>is_name_already_imported { |
| <a href=#283 id=283 data-nosnippet>283</a> score -= <span class="number">1</span>; |
| <a href=#284 id=284 data-nosnippet>284</a> } |
| <a href=#285 id=285 data-nosnippet>285</a> <span class="comment">// slightly prefer locals |
| <a href=#286 id=286 data-nosnippet>286</a> </span><span class="kw">if </span>is_local { |
| <a href=#287 id=287 data-nosnippet>287</a> score += <span class="number">1</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="comment">// lower rank private things |
| <a href=#291 id=291 data-nosnippet>291</a> </span><span class="kw">if </span>!is_private_editable { |
| <a href=#292 id=292 data-nosnippet>292</a> score += <span class="number">1</span>; |
| <a href=#293 id=293 data-nosnippet>293</a> } |
| <a href=#294 id=294 data-nosnippet>294</a> |
| <a href=#295 id=295 data-nosnippet>295</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(trait_) = trait_ { |
| <a href=#296 id=296 data-nosnippet>296</a> <span class="comment">// lower rank trait methods unless its notable |
| <a href=#297 id=297 data-nosnippet>297</a> </span><span class="kw">if </span>!trait_.notable_trait { |
| <a href=#298 id=298 data-nosnippet>298</a> score -= <span class="number">5</span>; |
| <a href=#299 id=299 data-nosnippet>299</a> } |
| <a href=#300 id=300 data-nosnippet>300</a> <span class="comment">// lower rank trait op methods |
| <a href=#301 id=301 data-nosnippet>301</a> </span><span class="kw">if </span>trait_.is_op_method { |
| <a href=#302 id=302 data-nosnippet>302</a> score -= <span class="number">5</span>; |
| <a href=#303 id=303 data-nosnippet>303</a> } |
| <a href=#304 id=304 data-nosnippet>304</a> } |
| <a href=#305 id=305 data-nosnippet>305</a> |
| <a href=#306 id=306 data-nosnippet>306</a> <span class="comment">// Lower rank for completions that skip `await` and `iter()`. |
| <a href=#307 id=307 data-nosnippet>307</a> </span><span class="kw">if </span>is_skipping_completion { |
| <a href=#308 id=308 data-nosnippet>308</a> score -= <span class="number">7</span>; |
| <a href=#309 id=309 data-nosnippet>309</a> } |
| <a href=#310 id=310 data-nosnippet>310</a> |
| <a href=#311 id=311 data-nosnippet>311</a> <span class="comment">// lower rank for items that need an import |
| <a href=#312 id=312 data-nosnippet>312</a> </span><span class="kw">if </span>requires_import { |
| <a href=#313 id=313 data-nosnippet>313</a> score -= <span class="number">1</span>; |
| <a href=#314 id=314 data-nosnippet>314</a> } |
| <a href=#315 id=315 data-nosnippet>315</a> <span class="kw">if </span>exact_name_match { |
| <a href=#316 id=316 data-nosnippet>316</a> score += <span class="number">20</span>; |
| <a href=#317 id=317 data-nosnippet>317</a> } |
| <a href=#318 id=318 data-nosnippet>318</a> <span class="kw">match </span>postfix_match { |
| <a href=#319 id=319 data-nosnippet>319</a> <span class="prelude-val">Some</span>(CompletionRelevancePostfixMatch::Exact) => score += <span class="number">100</span>, |
| <a href=#320 id=320 data-nosnippet>320</a> <span class="prelude-val">Some</span>(CompletionRelevancePostfixMatch::NonExact) => score -= <span class="number">5</span>, |
| <a href=#321 id=321 data-nosnippet>321</a> <span class="prelude-val">None </span>=> (), |
| <a href=#322 id=322 data-nosnippet>322</a> }; |
| <a href=#323 id=323 data-nosnippet>323</a> score += <span class="kw">match </span>type_match { |
| <a href=#324 id=324 data-nosnippet>324</a> <span class="prelude-val">Some</span>(CompletionRelevanceTypeMatch::Exact) => <span class="number">18</span>, |
| <a href=#325 id=325 data-nosnippet>325</a> <span class="prelude-val">Some</span>(CompletionRelevanceTypeMatch::CouldUnify) => <span class="number">5</span>, |
| <a href=#326 id=326 data-nosnippet>326</a> <span class="prelude-val">None </span>=> <span class="number">0</span>, |
| <a href=#327 id=327 data-nosnippet>327</a> }; |
| <a href=#328 id=328 data-nosnippet>328</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(function) = function { |
| <a href=#329 id=329 data-nosnippet>329</a> <span class="kw">let </span><span class="kw-2">mut </span>fn_score = <span class="kw">match </span>function.return_type { |
| <a href=#330 id=330 data-nosnippet>330</a> CompletionRelevanceReturnType::DirectConstructor => <span class="number">15</span>, |
| <a href=#331 id=331 data-nosnippet>331</a> CompletionRelevanceReturnType::Builder => <span class="number">10</span>, |
| <a href=#332 id=332 data-nosnippet>332</a> CompletionRelevanceReturnType::Constructor => <span class="number">5</span>, |
| <a href=#333 id=333 data-nosnippet>333</a> CompletionRelevanceReturnType::Other => <span class="number">0u32</span>, |
| <a href=#334 id=334 data-nosnippet>334</a> }; |
| <a href=#335 id=335 data-nosnippet>335</a> |
| <a href=#336 id=336 data-nosnippet>336</a> <span class="comment">// When a fn is bumped due to return type: |
| <a href=#337 id=337 data-nosnippet>337</a> // Bump Constructor or Builder methods with no arguments, |
| <a href=#338 id=338 data-nosnippet>338</a> // over them than with self arguments |
| <a href=#339 id=339 data-nosnippet>339</a> </span><span class="kw">if </span>function.has_params { |
| <a href=#340 id=340 data-nosnippet>340</a> <span class="comment">// bump associated functions |
| <a href=#341 id=341 data-nosnippet>341</a> </span>fn_score = fn_score.saturating_sub(<span class="number">1</span>); |
| <a href=#342 id=342 data-nosnippet>342</a> } <span class="kw">else if </span>function.has_self_param { |
| <a href=#343 id=343 data-nosnippet>343</a> <span class="comment">// downgrade methods (below Constructor) |
| <a href=#344 id=344 data-nosnippet>344</a> </span>fn_score = fn_score.min(<span class="number">1</span>); |
| <a href=#345 id=345 data-nosnippet>345</a> } |
| <a href=#346 id=346 data-nosnippet>346</a> |
| <a href=#347 id=347 data-nosnippet>347</a> score += fn_score; |
| <a href=#348 id=348 data-nosnippet>348</a> }; |
| <a href=#349 id=349 data-nosnippet>349</a> |
| <a href=#350 id=350 data-nosnippet>350</a> score |
| <a href=#351 id=351 data-nosnippet>351</a> } |
| <a href=#352 id=352 data-nosnippet>352</a> |
| <a href=#353 id=353 data-nosnippet>353</a> <span class="doccomment">/// Returns true when the score for this threshold is above |
| <a href=#354 id=354 data-nosnippet>354</a> /// some threshold such that we think it is especially likely |
| <a href=#355 id=355 data-nosnippet>355</a> /// to be relevant. |
| <a href=#356 id=356 data-nosnippet>356</a> </span><span class="kw">pub fn </span>is_relevant(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <a href=#357 id=357 data-nosnippet>357</a> <span class="self">self</span>.score() > <span class="self">Self</span>::BASE_SCORE |
| <a href=#358 id=358 data-nosnippet>358</a> } |
| <a href=#359 id=359 data-nosnippet>359</a>} |
| <a href=#360 id=360 data-nosnippet>360</a> |
| <a href=#361 id=361 data-nosnippet>361</a><span class="doccomment">/// The type of the completion item. |
| <a href=#362 id=362 data-nosnippet>362</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)] |
| <a href=#363 id=363 data-nosnippet>363</a></span><span class="kw">pub enum </span>CompletionItemKind { |
| <a href=#364 id=364 data-nosnippet>364</a> SymbolKind(SymbolKind), |
| <a href=#365 id=365 data-nosnippet>365</a> Binding, |
| <a href=#366 id=366 data-nosnippet>366</a> BuiltinType, |
| <a href=#367 id=367 data-nosnippet>367</a> InferredType, |
| <a href=#368 id=368 data-nosnippet>368</a> Keyword, |
| <a href=#369 id=369 data-nosnippet>369</a> Snippet, |
| <a href=#370 id=370 data-nosnippet>370</a> UnresolvedReference, |
| <a href=#371 id=371 data-nosnippet>371</a> Expression, |
| <a href=#372 id=372 data-nosnippet>372</a>} |
| <a href=#373 id=373 data-nosnippet>373</a> |
| <a href=#374 id=374 data-nosnippet>374</a><span class="macro">impl_from!</span>(SymbolKind <span class="kw">for </span>CompletionItemKind); |
| <a href=#375 id=375 data-nosnippet>375</a> |
| <a href=#376 id=376 data-nosnippet>376</a><span class="kw">impl </span>CompletionItemKind { |
| <a href=#377 id=377 data-nosnippet>377</a> <span class="kw">pub fn </span>tag(<span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>str { |
| <a href=#378 id=378 data-nosnippet>378</a> <span class="kw">match </span><span class="self">self </span>{ |
| <a href=#379 id=379 data-nosnippet>379</a> CompletionItemKind::SymbolKind(kind) => <span class="kw">match </span>kind { |
| <a href=#380 id=380 data-nosnippet>380</a> SymbolKind::Attribute => <span class="string">"at"</span>, |
| <a href=#381 id=381 data-nosnippet>381</a> SymbolKind::BuiltinAttr => <span class="string">"ba"</span>, |
| <a href=#382 id=382 data-nosnippet>382</a> SymbolKind::Const => <span class="string">"ct"</span>, |
| <a href=#383 id=383 data-nosnippet>383</a> SymbolKind::ConstParam => <span class="string">"cp"</span>, |
| <a href=#384 id=384 data-nosnippet>384</a> SymbolKind::CrateRoot => <span class="string">"cr"</span>, |
| <a href=#385 id=385 data-nosnippet>385</a> SymbolKind::Derive => <span class="string">"de"</span>, |
| <a href=#386 id=386 data-nosnippet>386</a> SymbolKind::DeriveHelper => <span class="string">"dh"</span>, |
| <a href=#387 id=387 data-nosnippet>387</a> SymbolKind::Enum => <span class="string">"en"</span>, |
| <a href=#388 id=388 data-nosnippet>388</a> SymbolKind::Field => <span class="string">"fd"</span>, |
| <a href=#389 id=389 data-nosnippet>389</a> SymbolKind::Function => <span class="string">"fn"</span>, |
| <a href=#390 id=390 data-nosnippet>390</a> SymbolKind::Impl => <span class="string">"im"</span>, |
| <a href=#391 id=391 data-nosnippet>391</a> SymbolKind::InlineAsmRegOrRegClass => <span class="string">"ar"</span>, |
| <a href=#392 id=392 data-nosnippet>392</a> SymbolKind::Label => <span class="string">"lb"</span>, |
| <a href=#393 id=393 data-nosnippet>393</a> SymbolKind::LifetimeParam => <span class="string">"lt"</span>, |
| <a href=#394 id=394 data-nosnippet>394</a> SymbolKind::Local => <span class="string">"lc"</span>, |
| <a href=#395 id=395 data-nosnippet>395</a> SymbolKind::Macro => <span class="string">"ma"</span>, |
| <a href=#396 id=396 data-nosnippet>396</a> SymbolKind::Method => <span class="string">"me"</span>, |
| <a href=#397 id=397 data-nosnippet>397</a> SymbolKind::ProcMacro => <span class="string">"pm"</span>, |
| <a href=#398 id=398 data-nosnippet>398</a> SymbolKind::Module => <span class="string">"md"</span>, |
| <a href=#399 id=399 data-nosnippet>399</a> SymbolKind::SelfParam => <span class="string">"sp"</span>, |
| <a href=#400 id=400 data-nosnippet>400</a> SymbolKind::SelfType => <span class="string">"sy"</span>, |
| <a href=#401 id=401 data-nosnippet>401</a> SymbolKind::Static => <span class="string">"sc"</span>, |
| <a href=#402 id=402 data-nosnippet>402</a> SymbolKind::Struct => <span class="string">"st"</span>, |
| <a href=#403 id=403 data-nosnippet>403</a> SymbolKind::ToolModule => <span class="string">"tm"</span>, |
| <a href=#404 id=404 data-nosnippet>404</a> SymbolKind::Trait => <span class="string">"tt"</span>, |
| <a href=#405 id=405 data-nosnippet>405</a> SymbolKind::TypeAlias => <span class="string">"ta"</span>, |
| <a href=#406 id=406 data-nosnippet>406</a> SymbolKind::TypeParam => <span class="string">"tp"</span>, |
| <a href=#407 id=407 data-nosnippet>407</a> SymbolKind::Union => <span class="string">"un"</span>, |
| <a href=#408 id=408 data-nosnippet>408</a> SymbolKind::ValueParam => <span class="string">"vp"</span>, |
| <a href=#409 id=409 data-nosnippet>409</a> SymbolKind::Variant => <span class="string">"ev"</span>, |
| <a href=#410 id=410 data-nosnippet>410</a> }, |
| <a href=#411 id=411 data-nosnippet>411</a> CompletionItemKind::Binding => <span class="string">"bn"</span>, |
| <a href=#412 id=412 data-nosnippet>412</a> CompletionItemKind::BuiltinType => <span class="string">"bt"</span>, |
| <a href=#413 id=413 data-nosnippet>413</a> CompletionItemKind::InferredType => <span class="string">"it"</span>, |
| <a href=#414 id=414 data-nosnippet>414</a> CompletionItemKind::Keyword => <span class="string">"kw"</span>, |
| <a href=#415 id=415 data-nosnippet>415</a> CompletionItemKind::Snippet => <span class="string">"sn"</span>, |
| <a href=#416 id=416 data-nosnippet>416</a> CompletionItemKind::UnresolvedReference => <span class="string">"??"</span>, |
| <a href=#417 id=417 data-nosnippet>417</a> CompletionItemKind::Expression => <span class="string">"ex"</span>, |
| <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>} |
| <a href=#421 id=421 data-nosnippet>421</a> |
| <a href=#422 id=422 data-nosnippet>422</a><span class="attr">#[derive(Copy, Clone, Debug)] |
| <a href=#423 id=423 data-nosnippet>423</a></span><span class="kw">pub enum </span>CompletionItemRefMode { |
| <a href=#424 id=424 data-nosnippet>424</a> Reference(Mutability), |
| <a href=#425 id=425 data-nosnippet>425</a> Dereference, |
| <a href=#426 id=426 data-nosnippet>426</a>} |
| <a href=#427 id=427 data-nosnippet>427</a> |
| <a href=#428 id=428 data-nosnippet>428</a><span class="kw">impl </span>CompletionItem { |
| <a href=#429 id=429 data-nosnippet>429</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new( |
| <a href=#430 id=430 data-nosnippet>430</a> kind: <span class="kw">impl </span>Into<CompletionItemKind>, |
| <a href=#431 id=431 data-nosnippet>431</a> source_range: TextRange, |
| <a href=#432 id=432 data-nosnippet>432</a> label: <span class="kw">impl </span>Into<SmolStr>, |
| <a href=#433 id=433 data-nosnippet>433</a> edition: Edition, |
| <a href=#434 id=434 data-nosnippet>434</a> ) -> Builder { |
| <a href=#435 id=435 data-nosnippet>435</a> <span class="kw">let </span>label = label.into(); |
| <a href=#436 id=436 data-nosnippet>436</a> Builder { |
| <a href=#437 id=437 data-nosnippet>437</a> source_range, |
| <a href=#438 id=438 data-nosnippet>438</a> label, |
| <a href=#439 id=439 data-nosnippet>439</a> insert_text: <span class="prelude-val">None</span>, |
| <a href=#440 id=440 data-nosnippet>440</a> is_snippet: <span class="bool-val">false</span>, |
| <a href=#441 id=441 data-nosnippet>441</a> trait_name: <span class="prelude-val">None</span>, |
| <a href=#442 id=442 data-nosnippet>442</a> detail: <span class="prelude-val">None</span>, |
| <a href=#443 id=443 data-nosnippet>443</a> documentation: <span class="prelude-val">None</span>, |
| <a href=#444 id=444 data-nosnippet>444</a> lookup: <span class="prelude-val">None</span>, |
| <a href=#445 id=445 data-nosnippet>445</a> kind: kind.into(), |
| <a href=#446 id=446 data-nosnippet>446</a> text_edit: <span class="prelude-val">None</span>, |
| <a href=#447 id=447 data-nosnippet>447</a> deprecated: <span class="bool-val">false</span>, |
| <a href=#448 id=448 data-nosnippet>448</a> trigger_call_info: <span class="bool-val">false</span>, |
| <a href=#449 id=449 data-nosnippet>449</a> relevance: CompletionRelevance::default(), |
| <a href=#450 id=450 data-nosnippet>450</a> ref_match: <span class="prelude-val">None</span>, |
| <a href=#451 id=451 data-nosnippet>451</a> imports_to_add: Default::default(), |
| <a href=#452 id=452 data-nosnippet>452</a> doc_aliases: <span class="macro">vec!</span>[], |
| <a href=#453 id=453 data-nosnippet>453</a> edition, |
| <a href=#454 id=454 data-nosnippet>454</a> } |
| <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">/// What string is used for filtering. |
| <a href=#458 id=458 data-nosnippet>458</a> </span><span class="kw">pub fn </span>lookup(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <a href=#459 id=459 data-nosnippet>459</a> <span class="self">self</span>.lookup.as_str() |
| <a href=#460 id=460 data-nosnippet>460</a> } |
| <a href=#461 id=461 data-nosnippet>461</a> |
| <a href=#462 id=462 data-nosnippet>462</a> <span class="kw">pub fn </span>ref_match(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><(String, ide_db::text_edit::Indel, CompletionRelevance)> { |
| <a href=#463 id=463 data-nosnippet>463</a> <span class="comment">// Relevance of the ref match should be the same as the original |
| <a href=#464 id=464 data-nosnippet>464</a> // match, but with exact type match set because self.ref_match |
| <a href=#465 id=465 data-nosnippet>465</a> // is only set if there is an exact type match. |
| <a href=#466 id=466 data-nosnippet>466</a> </span><span class="kw">let </span><span class="kw-2">mut </span>relevance = <span class="self">self</span>.relevance; |
| <a href=#467 id=467 data-nosnippet>467</a> relevance.type_match = <span class="prelude-val">Some</span>(CompletionRelevanceTypeMatch::Exact); |
| <a href=#468 id=468 data-nosnippet>468</a> |
| <a href=#469 id=469 data-nosnippet>469</a> <span class="self">self</span>.ref_match.map(|(mode, offset)| { |
| <a href=#470 id=470 data-nosnippet>470</a> <span class="kw">let </span>prefix = <span class="kw">match </span>mode { |
| <a href=#471 id=471 data-nosnippet>471</a> CompletionItemRefMode::Reference(Mutability::Shared) => <span class="string">"&"</span>, |
| <a href=#472 id=472 data-nosnippet>472</a> CompletionItemRefMode::Reference(Mutability::Mut) => <span class="string">"&mut "</span>, |
| <a href=#473 id=473 data-nosnippet>473</a> CompletionItemRefMode::Dereference => <span class="string">"*"</span>, |
| <a href=#474 id=474 data-nosnippet>474</a> }; |
| <a href=#475 id=475 data-nosnippet>475</a> <span class="kw">let </span>label = <span class="macro">format!</span>(<span class="string">"{prefix}{}"</span>, <span class="self">self</span>.label.primary); |
| <a href=#476 id=476 data-nosnippet>476</a> (label, ide_db::text_edit::Indel::insert(offset, String::from(prefix)), relevance) |
| <a href=#477 id=477 data-nosnippet>477</a> }) |
| <a href=#478 id=478 data-nosnippet>478</a> } |
| <a href=#479 id=479 data-nosnippet>479</a>} |
| <a href=#480 id=480 data-nosnippet>480</a> |
| <a href=#481 id=481 data-nosnippet>481</a><span class="doccomment">/// A helper to make `CompletionItem`s. |
| <a href=#482 id=482 data-nosnippet>482</a></span><span class="attr">#[must_use] |
| <a href=#483 id=483 data-nosnippet>483</a>#[derive(Clone)] |
| <a href=#484 id=484 data-nosnippet>484</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Builder { |
| <a href=#485 id=485 data-nosnippet>485</a> source_range: TextRange, |
| <a href=#486 id=486 data-nosnippet>486</a> imports_to_add: SmallVec<[LocatedImport; <span class="number">1</span>]>, |
| <a href=#487 id=487 data-nosnippet>487</a> trait_name: <span class="prelude-ty">Option</span><SmolStr>, |
| <a href=#488 id=488 data-nosnippet>488</a> doc_aliases: Vec<SmolStr>, |
| <a href=#489 id=489 data-nosnippet>489</a> label: SmolStr, |
| <a href=#490 id=490 data-nosnippet>490</a> insert_text: <span class="prelude-ty">Option</span><String>, |
| <a href=#491 id=491 data-nosnippet>491</a> is_snippet: bool, |
| <a href=#492 id=492 data-nosnippet>492</a> detail: <span class="prelude-ty">Option</span><String>, |
| <a href=#493 id=493 data-nosnippet>493</a> <span class="comment">// FIXME: Make this with `'db` lifetime. |
| <a href=#494 id=494 data-nosnippet>494</a> </span>documentation: <span class="prelude-ty">Option</span><Documentation<<span class="lifetime">'static</span>>>, |
| <a href=#495 id=495 data-nosnippet>495</a> lookup: <span class="prelude-ty">Option</span><SmolStr>, |
| <a href=#496 id=496 data-nosnippet>496</a> kind: CompletionItemKind, |
| <a href=#497 id=497 data-nosnippet>497</a> text_edit: <span class="prelude-ty">Option</span><TextEdit>, |
| <a href=#498 id=498 data-nosnippet>498</a> deprecated: bool, |
| <a href=#499 id=499 data-nosnippet>499</a> trigger_call_info: bool, |
| <a href=#500 id=500 data-nosnippet>500</a> relevance: CompletionRelevance, |
| <a href=#501 id=501 data-nosnippet>501</a> ref_match: <span class="prelude-ty">Option</span><(CompletionItemRefMode, TextSize)>, |
| <a href=#502 id=502 data-nosnippet>502</a> edition: Edition, |
| <a href=#503 id=503 data-nosnippet>503</a>} |
| <a href=#504 id=504 data-nosnippet>504</a> |
| <a href=#505 id=505 data-nosnippet>505</a><span class="kw">impl </span>Builder { |
| <a href=#506 id=506 data-nosnippet>506</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_resolution( |
| <a href=#507 id=507 data-nosnippet>507</a> ctx: <span class="kw-2">&</span>CompletionContext<<span class="lifetime">'_</span>>, |
| <a href=#508 id=508 data-nosnippet>508</a> path_ctx: <span class="kw-2">&</span>PathCompletionCtx<<span class="lifetime">'_</span>>, |
| <a href=#509 id=509 data-nosnippet>509</a> local_name: hir::Name, |
| <a href=#510 id=510 data-nosnippet>510</a> resolution: hir::ScopeDef, |
| <a href=#511 id=511 data-nosnippet>511</a> ) -> <span class="self">Self </span>{ |
| <a href=#512 id=512 data-nosnippet>512</a> <span class="kw">let </span>doc_aliases = ctx.doc_aliases_in_scope(resolution); |
| <a href=#513 id=513 data-nosnippet>513</a> render_path_resolution( |
| <a href=#514 id=514 data-nosnippet>514</a> RenderContext::new(ctx).doc_aliases(doc_aliases), |
| <a href=#515 id=515 data-nosnippet>515</a> path_ctx, |
| <a href=#516 id=516 data-nosnippet>516</a> local_name, |
| <a href=#517 id=517 data-nosnippet>517</a> resolution, |
| <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> |
| <a href=#521 id=521 data-nosnippet>521</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>build(<span class="self">self</span>, db: <span class="kw-2">&</span>RootDatabase) -> CompletionItem { |
| <a href=#522 id=522 data-nosnippet>522</a> <span class="kw">let </span>_p = <span class="macro">tracing::info_span!</span>(<span class="string">"item::Builder::build"</span>).entered(); |
| <a href=#523 id=523 data-nosnippet>523</a> |
| <a href=#524 id=524 data-nosnippet>524</a> <span class="kw">let </span>label = <span class="self">self</span>.label; |
| <a href=#525 id=525 data-nosnippet>525</a> <span class="kw">let </span><span class="kw-2">mut </span>lookup = <span class="self">self</span>.lookup.unwrap_or_else(|| label.clone()); |
| <a href=#526 id=526 data-nosnippet>526</a> <span class="kw">let </span>insert_text = <span class="self">self</span>.insert_text.unwrap_or_else(|| label.to_string()); |
| <a href=#527 id=527 data-nosnippet>527</a> |
| <a href=#528 id=528 data-nosnippet>528</a> <span class="kw">let </span><span class="kw-2">mut </span>detail_left = <span class="prelude-val">None</span>; |
| <a href=#529 id=529 data-nosnippet>529</a> <span class="kw">if </span>!<span class="self">self</span>.doc_aliases.is_empty() { |
| <a href=#530 id=530 data-nosnippet>530</a> <span class="kw">let </span>doc_aliases = <span class="self">self</span>.doc_aliases.iter().join(<span class="string">", "</span>); |
| <a href=#531 id=531 data-nosnippet>531</a> detail_left = <span class="prelude-val">Some</span>(<span class="macro">format!</span>(<span class="string">"(alias {doc_aliases})"</span>)); |
| <a href=#532 id=532 data-nosnippet>532</a> <span class="kw">let </span>lookup_doc_aliases = <span class="self">self |
| <a href=#533 id=533 data-nosnippet>533</a> </span>.doc_aliases |
| <a href=#534 id=534 data-nosnippet>534</a> .iter() |
| <a href=#535 id=535 data-nosnippet>535</a> <span class="comment">// Don't include aliases in `lookup` that aren't valid identifiers as including |
| <a href=#536 id=536 data-nosnippet>536</a> // them results in weird completion filtering behavior e.g. `Partial>` matching |
| <a href=#537 id=537 data-nosnippet>537</a> // `PartialOrd` because it has an alias of ">". |
| <a href=#538 id=538 data-nosnippet>538</a> </span>.filter(|alias| { |
| <a href=#539 id=539 data-nosnippet>539</a> <span class="kw">let </span><span class="kw-2">mut </span>chars = alias.chars(); |
| <a href=#540 id=540 data-nosnippet>540</a> chars.next().is_some_and(char::is_alphabetic) |
| <a href=#541 id=541 data-nosnippet>541</a> && chars.all(|c| c.is_alphanumeric() || c == <span class="string">'_'</span>) |
| <a href=#542 id=542 data-nosnippet>542</a> }) |
| <a href=#543 id=543 data-nosnippet>543</a> <span class="comment">// Deliberately concatenated without separators as adding separators e.g. |
| <a href=#544 id=544 data-nosnippet>544</a> // `alias1, alias2` results in LSP clients continuing to display the completion even |
| <a href=#545 id=545 data-nosnippet>545</a> // after typing a comma or space. |
| <a href=#546 id=546 data-nosnippet>546</a> </span>.join(<span class="string">""</span>); |
| <a href=#547 id=547 data-nosnippet>547</a> <span class="kw">if </span>!lookup_doc_aliases.is_empty() { |
| <a href=#548 id=548 data-nosnippet>548</a> lookup = <span class="macro">format_smolstr!</span>(<span class="string">"{lookup}{lookup_doc_aliases}"</span>); |
| <a href=#549 id=549 data-nosnippet>549</a> } |
| <a href=#550 id=550 data-nosnippet>550</a> } |
| <a href=#551 id=551 data-nosnippet>551</a> <span class="kw">if let </span>[import_edit] = <span class="kw-2">&*</span><span class="self">self</span>.imports_to_add { |
| <a href=#552 id=552 data-nosnippet>552</a> <span class="comment">// snippets can have multiple imports, but normal completions only have up to one |
| <a href=#553 id=553 data-nosnippet>553</a> </span><span class="kw">let </span>detail_left = detail_left.get_or_insert_with(String::new); |
| <a href=#554 id=554 data-nosnippet>554</a> <span class="macro">format_to!</span>( |
| <a href=#555 id=555 data-nosnippet>555</a> detail_left, |
| <a href=#556 id=556 data-nosnippet>556</a> <span class="string">"{}(use {})"</span>, |
| <a href=#557 id=557 data-nosnippet>557</a> <span class="kw">if </span>detail_left.is_empty() { <span class="string">"" </span>} <span class="kw">else </span>{ <span class="string">" " </span>}, |
| <a href=#558 id=558 data-nosnippet>558</a> import_edit.import_path.display(db, <span class="self">self</span>.edition) |
| <a href=#559 id=559 data-nosnippet>559</a> ); |
| <a href=#560 id=560 data-nosnippet>560</a> } <span class="kw">else if let </span><span class="prelude-val">Some</span>(trait_name) = <span class="self">self</span>.trait_name { |
| <a href=#561 id=561 data-nosnippet>561</a> <span class="kw">let </span>detail_left = detail_left.get_or_insert_with(String::new); |
| <a href=#562 id=562 data-nosnippet>562</a> <span class="macro">format_to!</span>( |
| <a href=#563 id=563 data-nosnippet>563</a> detail_left, |
| <a href=#564 id=564 data-nosnippet>564</a> <span class="string">"{}(as {trait_name})"</span>, |
| <a href=#565 id=565 data-nosnippet>565</a> <span class="kw">if </span>detail_left.is_empty() { <span class="string">"" </span>} <span class="kw">else </span>{ <span class="string">" " </span>}, |
| <a href=#566 id=566 data-nosnippet>566</a> ); |
| <a href=#567 id=567 data-nosnippet>567</a> } |
| <a href=#568 id=568 data-nosnippet>568</a> |
| <a href=#569 id=569 data-nosnippet>569</a> <span class="kw">let </span>text_edit = <span class="kw">match </span><span class="self">self</span>.text_edit { |
| <a href=#570 id=570 data-nosnippet>570</a> <span class="prelude-val">Some</span>(it) => it, |
| <a href=#571 id=571 data-nosnippet>571</a> <span class="prelude-val">None </span>=> TextEdit::replace(<span class="self">self</span>.source_range, insert_text), |
| <a href=#572 id=572 data-nosnippet>572</a> }; |
| <a href=#573 id=573 data-nosnippet>573</a> |
| <a href=#574 id=574 data-nosnippet>574</a> <span class="kw">let </span>import_to_add = <span class="self">self |
| <a href=#575 id=575 data-nosnippet>575</a> </span>.imports_to_add |
| <a href=#576 id=576 data-nosnippet>576</a> .into_iter() |
| <a href=#577 id=577 data-nosnippet>577</a> .map(|import| import.import_path.display(db, <span class="self">self</span>.edition).to_string()) |
| <a href=#578 id=578 data-nosnippet>578</a> .collect(); |
| <a href=#579 id=579 data-nosnippet>579</a> |
| <a href=#580 id=580 data-nosnippet>580</a> CompletionItem { |
| <a href=#581 id=581 data-nosnippet>581</a> source_range: <span class="self">self</span>.source_range, |
| <a href=#582 id=582 data-nosnippet>582</a> label: CompletionItemLabel { |
| <a href=#583 id=583 data-nosnippet>583</a> primary: label, |
| <a href=#584 id=584 data-nosnippet>584</a> detail_left, |
| <a href=#585 id=585 data-nosnippet>585</a> detail_right: <span class="self">self</span>.detail.clone(), |
| <a href=#586 id=586 data-nosnippet>586</a> }, |
| <a href=#587 id=587 data-nosnippet>587</a> text_edit, |
| <a href=#588 id=588 data-nosnippet>588</a> is_snippet: <span class="self">self</span>.is_snippet, |
| <a href=#589 id=589 data-nosnippet>589</a> detail: <span class="self">self</span>.detail, |
| <a href=#590 id=590 data-nosnippet>590</a> documentation: <span class="self">self</span>.documentation, |
| <a href=#591 id=591 data-nosnippet>591</a> lookup, |
| <a href=#592 id=592 data-nosnippet>592</a> kind: <span class="self">self</span>.kind, |
| <a href=#593 id=593 data-nosnippet>593</a> deprecated: <span class="self">self</span>.deprecated, |
| <a href=#594 id=594 data-nosnippet>594</a> trigger_call_info: <span class="self">self</span>.trigger_call_info, |
| <a href=#595 id=595 data-nosnippet>595</a> relevance: <span class="self">self</span>.relevance, |
| <a href=#596 id=596 data-nosnippet>596</a> ref_match: <span class="self">self</span>.ref_match, |
| <a href=#597 id=597 data-nosnippet>597</a> import_to_add, |
| <a href=#598 id=598 data-nosnippet>598</a> } |
| <a href=#599 id=599 data-nosnippet>599</a> } |
| <a href=#600 id=600 data-nosnippet>600</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>lookup_by(<span class="kw-2">&mut </span><span class="self">self</span>, lookup: <span class="kw">impl </span>Into<SmolStr>) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#601 id=601 data-nosnippet>601</a> <span class="self">self</span>.lookup = <span class="prelude-val">Some</span>(lookup.into()); |
| <a href=#602 id=602 data-nosnippet>602</a> <span class="self">self |
| <a href=#603 id=603 data-nosnippet>603</a> </span>} |
| <a href=#604 id=604 data-nosnippet>604</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>label(<span class="kw-2">&mut </span><span class="self">self</span>, label: <span class="kw">impl </span>Into<SmolStr>) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#605 id=605 data-nosnippet>605</a> <span class="self">self</span>.label = label.into(); |
| <a href=#606 id=606 data-nosnippet>606</a> <span class="self">self |
| <a href=#607 id=607 data-nosnippet>607</a> </span>} |
| <a href=#608 id=608 data-nosnippet>608</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>trait_name(<span class="kw-2">&mut </span><span class="self">self</span>, trait_name: SmolStr) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#609 id=609 data-nosnippet>609</a> <span class="self">self</span>.trait_name = <span class="prelude-val">Some</span>(trait_name); |
| <a href=#610 id=610 data-nosnippet>610</a> <span class="self">self |
| <a href=#611 id=611 data-nosnippet>611</a> </span>} |
| <a href=#612 id=612 data-nosnippet>612</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>doc_aliases(<span class="kw-2">&mut </span><span class="self">self</span>, doc_aliases: Vec<SmolStr>) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#613 id=613 data-nosnippet>613</a> <span class="self">self</span>.doc_aliases = doc_aliases; |
| <a href=#614 id=614 data-nosnippet>614</a> <span class="self">self |
| <a href=#615 id=615 data-nosnippet>615</a> </span>} |
| <a href=#616 id=616 data-nosnippet>616</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>insert_text(<span class="kw-2">&mut </span><span class="self">self</span>, insert_text: <span class="kw">impl </span>Into<String>) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#617 id=617 data-nosnippet>617</a> <span class="self">self</span>.insert_text = <span class="prelude-val">Some</span>(insert_text.into()); |
| <a href=#618 id=618 data-nosnippet>618</a> <span class="self">self |
| <a href=#619 id=619 data-nosnippet>619</a> </span>} |
| <a href=#620 id=620 data-nosnippet>620</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>insert_snippet( |
| <a href=#621 id=621 data-nosnippet>621</a> <span class="kw-2">&mut </span><span class="self">self</span>, |
| <a href=#622 id=622 data-nosnippet>622</a> cap: SnippetCap, |
| <a href=#623 id=623 data-nosnippet>623</a> snippet: <span class="kw">impl </span>Into<String>, |
| <a href=#624 id=624 data-nosnippet>624</a> ) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#625 id=625 data-nosnippet>625</a> <span class="kw">let _ </span>= cap; |
| <a href=#626 id=626 data-nosnippet>626</a> <span class="self">self</span>.is_snippet = <span class="bool-val">true</span>; |
| <a href=#627 id=627 data-nosnippet>627</a> <span class="self">self</span>.insert_text(snippet) |
| <a href=#628 id=628 data-nosnippet>628</a> } |
| <a href=#629 id=629 data-nosnippet>629</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>text_edit(<span class="kw-2">&mut </span><span class="self">self</span>, edit: TextEdit) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#630 id=630 data-nosnippet>630</a> <span class="self">self</span>.text_edit = <span class="prelude-val">Some</span>(edit); |
| <a href=#631 id=631 data-nosnippet>631</a> <span class="self">self |
| <a href=#632 id=632 data-nosnippet>632</a> </span>} |
| <a href=#633 id=633 data-nosnippet>633</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>snippet_edit(<span class="kw-2">&mut </span><span class="self">self</span>, _cap: SnippetCap, edit: TextEdit) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#634 id=634 data-nosnippet>634</a> <span class="self">self</span>.is_snippet = <span class="bool-val">true</span>; |
| <a href=#635 id=635 data-nosnippet>635</a> <span class="self">self</span>.text_edit(edit) |
| <a href=#636 id=636 data-nosnippet>636</a> } |
| <a href=#637 id=637 data-nosnippet>637</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>detail(<span class="kw-2">&mut </span><span class="self">self</span>, detail: <span class="kw">impl </span>Into<String>) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#638 id=638 data-nosnippet>638</a> <span class="self">self</span>.set_detail(<span class="prelude-val">Some</span>(detail)) |
| <a href=#639 id=639 data-nosnippet>639</a> } |
| <a href=#640 id=640 data-nosnippet>640</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>set_detail(<span class="kw-2">&mut </span><span class="self">self</span>, detail: <span class="prelude-ty">Option</span><<span class="kw">impl </span>Into<String>>) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#641 id=641 data-nosnippet>641</a> <span class="self">self</span>.detail = detail.map(Into::into); |
| <a href=#642 id=642 data-nosnippet>642</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(detail) = <span class="kw-2">&</span><span class="self">self</span>.detail |
| <a href=#643 id=643 data-nosnippet>643</a> && <span class="macro">never!</span>(detail.contains(<span class="string">'\n'</span>), <span class="string">"multiline detail:\n{}"</span>, detail) |
| <a href=#644 id=644 data-nosnippet>644</a> { |
| <a href=#645 id=645 data-nosnippet>645</a> <span class="self">self</span>.detail = <span class="prelude-val">Some</span>(detail.split(<span class="string">'\n'</span>).next().unwrap().to_owned()); |
| <a href=#646 id=646 data-nosnippet>646</a> } |
| <a href=#647 id=647 data-nosnippet>647</a> <span class="self">self |
| <a href=#648 id=648 data-nosnippet>648</a> </span>} |
| <a href=#649 id=649 data-nosnippet>649</a> <span class="attr">#[allow(unused)] |
| <a href=#650 id=650 data-nosnippet>650</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>documentation(<span class="kw-2">&mut </span><span class="self">self</span>, docs: Documentation<<span class="lifetime">'_</span>>) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#651 id=651 data-nosnippet>651</a> <span class="self">self</span>.set_documentation(<span class="prelude-val">Some</span>(docs)) |
| <a href=#652 id=652 data-nosnippet>652</a> } |
| <a href=#653 id=653 data-nosnippet>653</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>set_documentation(<span class="kw-2">&mut </span><span class="self">self</span>, docs: <span class="prelude-ty">Option</span><Documentation<<span class="lifetime">'_</span>>>) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#654 id=654 data-nosnippet>654</a> <span class="self">self</span>.documentation = docs.map(Documentation::into_owned); |
| <a href=#655 id=655 data-nosnippet>655</a> <span class="self">self |
| <a href=#656 id=656 data-nosnippet>656</a> </span>} |
| <a href=#657 id=657 data-nosnippet>657</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>set_deprecated(<span class="kw-2">&mut </span><span class="self">self</span>, deprecated: bool) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#658 id=658 data-nosnippet>658</a> <span class="self">self</span>.deprecated = deprecated; |
| <a href=#659 id=659 data-nosnippet>659</a> <span class="self">self |
| <a href=#660 id=660 data-nosnippet>660</a> </span>} |
| <a href=#661 id=661 data-nosnippet>661</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>set_relevance(<span class="kw-2">&mut </span><span class="self">self</span>, relevance: CompletionRelevance) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#662 id=662 data-nosnippet>662</a> <span class="self">self</span>.relevance = relevance; |
| <a href=#663 id=663 data-nosnippet>663</a> <span class="self">self |
| <a href=#664 id=664 data-nosnippet>664</a> </span>} |
| <a href=#665 id=665 data-nosnippet>665</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>with_relevance( |
| <a href=#666 id=666 data-nosnippet>666</a> <span class="kw-2">&mut </span><span class="self">self</span>, |
| <a href=#667 id=667 data-nosnippet>667</a> relevance: <span class="kw">impl </span>FnOnce(CompletionRelevance) -> CompletionRelevance, |
| <a href=#668 id=668 data-nosnippet>668</a> ) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#669 id=669 data-nosnippet>669</a> <span class="self">self</span>.relevance = relevance(mem::take(<span class="kw-2">&mut </span><span class="self">self</span>.relevance)); |
| <a href=#670 id=670 data-nosnippet>670</a> <span class="self">self |
| <a href=#671 id=671 data-nosnippet>671</a> </span>} |
| <a href=#672 id=672 data-nosnippet>672</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>trigger_call_info(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#673 id=673 data-nosnippet>673</a> <span class="self">self</span>.trigger_call_info = <span class="bool-val">true</span>; |
| <a href=#674 id=674 data-nosnippet>674</a> <span class="self">self |
| <a href=#675 id=675 data-nosnippet>675</a> </span>} |
| <a href=#676 id=676 data-nosnippet>676</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>add_import(<span class="kw-2">&mut </span><span class="self">self</span>, import_to_add: LocatedImport) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#677 id=677 data-nosnippet>677</a> <span class="self">self</span>.imports_to_add.push(import_to_add); |
| <a href=#678 id=678 data-nosnippet>678</a> <span class="self">self |
| <a href=#679 id=679 data-nosnippet>679</a> </span>} |
| <a href=#680 id=680 data-nosnippet>680</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>ref_match( |
| <a href=#681 id=681 data-nosnippet>681</a> <span class="kw-2">&mut </span><span class="self">self</span>, |
| <a href=#682 id=682 data-nosnippet>682</a> ref_mode: CompletionItemRefMode, |
| <a href=#683 id=683 data-nosnippet>683</a> offset: TextSize, |
| <a href=#684 id=684 data-nosnippet>684</a> ) -> <span class="kw-2">&mut </span>Builder { |
| <a href=#685 id=685 data-nosnippet>685</a> <span class="self">self</span>.ref_match = <span class="prelude-val">Some</span>((ref_mode, offset)); |
| <a href=#686 id=686 data-nosnippet>686</a> <span class="self">self |
| <a href=#687 id=687 data-nosnippet>687</a> </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><span class="attr">#[cfg(test)] |
| <a href=#691 id=691 data-nosnippet>691</a></span><span class="kw">mod </span>tests { |
| <a href=#692 id=692 data-nosnippet>692</a> <span class="kw">use </span>itertools::Itertools; |
| <a href=#693 id=693 data-nosnippet>693</a> <span class="kw">use </span>test_utils::assert_eq_text; |
| <a href=#694 id=694 data-nosnippet>694</a> |
| <a href=#695 id=695 data-nosnippet>695</a> <span class="kw">use </span>super::{ |
| <a href=#696 id=696 data-nosnippet>696</a> CompletionRelevance, CompletionRelevancePostfixMatch, CompletionRelevanceTypeMatch, |
| <a href=#697 id=697 data-nosnippet>697</a> }; |
| <a href=#698 id=698 data-nosnippet>698</a> |
| <a href=#699 id=699 data-nosnippet>699</a> <span class="doccomment">/// Check that these are CompletionRelevance are sorted in ascending order |
| <a href=#700 id=700 data-nosnippet>700</a> /// by their relevance score. |
| <a href=#701 id=701 data-nosnippet>701</a> /// |
| <a href=#702 id=702 data-nosnippet>702</a> /// We want to avoid making assertions about the absolute score of any |
| <a href=#703 id=703 data-nosnippet>703</a> /// item, but we do want to assert whether each is >, <, or == to the |
| <a href=#704 id=704 data-nosnippet>704</a> /// others. |
| <a href=#705 id=705 data-nosnippet>705</a> /// |
| <a href=#706 id=706 data-nosnippet>706</a> /// If provided vec![vec![a], vec![b, c], vec![d]], then this will assert: |
| <a href=#707 id=707 data-nosnippet>707</a> /// a.score < b.score == c.score < d.score |
| <a href=#708 id=708 data-nosnippet>708</a> </span><span class="kw">fn </span>check_relevance_score_ordered(expected_relevance_order: Vec<Vec<CompletionRelevance>>) { |
| <a href=#709 id=709 data-nosnippet>709</a> <span class="kw">let </span>expected = <span class="macro">format!</span>(<span class="string">"{expected_relevance_order:#?}"</span>); |
| <a href=#710 id=710 data-nosnippet>710</a> |
| <a href=#711 id=711 data-nosnippet>711</a> <span class="kw">let </span>actual_relevance_order = expected_relevance_order |
| <a href=#712 id=712 data-nosnippet>712</a> .into_iter() |
| <a href=#713 id=713 data-nosnippet>713</a> .flatten() |
| <a href=#714 id=714 data-nosnippet>714</a> .map(|r| (r.score(), r)) |
| <a href=#715 id=715 data-nosnippet>715</a> .sorted_by_key(|(score, _r)| <span class="kw-2">*</span>score) |
| <a href=#716 id=716 data-nosnippet>716</a> .fold( |
| <a href=#717 id=717 data-nosnippet>717</a> (u32::MIN, <span class="macro">vec!</span>[<span class="macro">vec!</span>[]]), |
| <a href=#718 id=718 data-nosnippet>718</a> |(<span class="kw-2">mut </span>currently_collecting_score, <span class="kw-2">mut </span>out), (score, r)| { |
| <a href=#719 id=719 data-nosnippet>719</a> <span class="kw">if </span>currently_collecting_score == score { |
| <a href=#720 id=720 data-nosnippet>720</a> out.last_mut().unwrap().push(r); |
| <a href=#721 id=721 data-nosnippet>721</a> } <span class="kw">else </span>{ |
| <a href=#722 id=722 data-nosnippet>722</a> currently_collecting_score = score; |
| <a href=#723 id=723 data-nosnippet>723</a> out.push(<span class="macro">vec!</span>[r]); |
| <a href=#724 id=724 data-nosnippet>724</a> } |
| <a href=#725 id=725 data-nosnippet>725</a> (currently_collecting_score, out) |
| <a href=#726 id=726 data-nosnippet>726</a> }, |
| <a href=#727 id=727 data-nosnippet>727</a> ) |
| <a href=#728 id=728 data-nosnippet>728</a> .<span class="number">1</span>; |
| <a href=#729 id=729 data-nosnippet>729</a> |
| <a href=#730 id=730 data-nosnippet>730</a> <span class="kw">let </span>actual = <span class="macro">format!</span>(<span class="string">"{actual_relevance_order:#?}"</span>); |
| <a href=#731 id=731 data-nosnippet>731</a> |
| <a href=#732 id=732 data-nosnippet>732</a> <span class="macro">assert_eq_text!</span>(<span class="kw-2">&</span>expected, <span class="kw-2">&</span>actual); |
| <a href=#733 id=733 data-nosnippet>733</a> } |
| <a href=#734 id=734 data-nosnippet>734</a> |
| <a href=#735 id=735 data-nosnippet>735</a> <span class="attr">#[test] |
| <a href=#736 id=736 data-nosnippet>736</a> </span><span class="kw">fn </span>relevance_score() { |
| <a href=#737 id=737 data-nosnippet>737</a> <span class="kw">use </span>CompletionRelevance <span class="kw">as </span>Cr; |
| <a href=#738 id=738 data-nosnippet>738</a> <span class="kw">let </span>default = Cr::default(); |
| <a href=#739 id=739 data-nosnippet>739</a> <span class="comment">// This test asserts that the relevance score for these items is ascending, and |
| <a href=#740 id=740 data-nosnippet>740</a> // that any items in the same vec have the same score. |
| <a href=#741 id=741 data-nosnippet>741</a> </span><span class="kw">let </span>expected_relevance_order = <span class="macro">vec!</span>[ |
| <a href=#742 id=742 data-nosnippet>742</a> <span class="macro">vec!</span>[], |
| <a href=#743 id=743 data-nosnippet>743</a> <span class="macro">vec!</span>[Cr { |
| <a href=#744 id=744 data-nosnippet>744</a> trait_: <span class="prelude-val">Some</span>(<span class="kw">crate</span>::item::CompletionRelevanceTraitInfo { |
| <a href=#745 id=745 data-nosnippet>745</a> notable_trait: <span class="bool-val">false</span>, |
| <a href=#746 id=746 data-nosnippet>746</a> is_op_method: <span class="bool-val">true</span>, |
| <a href=#747 id=747 data-nosnippet>747</a> }), |
| <a href=#748 id=748 data-nosnippet>748</a> is_private_editable: <span class="bool-val">true</span>, |
| <a href=#749 id=749 data-nosnippet>749</a> ..default |
| <a href=#750 id=750 data-nosnippet>750</a> }], |
| <a href=#751 id=751 data-nosnippet>751</a> <span class="macro">vec!</span>[Cr { |
| <a href=#752 id=752 data-nosnippet>752</a> trait_: <span class="prelude-val">Some</span>(<span class="kw">crate</span>::item::CompletionRelevanceTraitInfo { |
| <a href=#753 id=753 data-nosnippet>753</a> notable_trait: <span class="bool-val">false</span>, |
| <a href=#754 id=754 data-nosnippet>754</a> is_op_method: <span class="bool-val">true</span>, |
| <a href=#755 id=755 data-nosnippet>755</a> }), |
| <a href=#756 id=756 data-nosnippet>756</a> ..default |
| <a href=#757 id=757 data-nosnippet>757</a> }], |
| <a href=#758 id=758 data-nosnippet>758</a> <span class="macro">vec!</span>[Cr { postfix_match: <span class="prelude-val">Some</span>(CompletionRelevancePostfixMatch::NonExact), ..default }], |
| <a href=#759 id=759 data-nosnippet>759</a> <span class="macro">vec!</span>[Cr { is_private_editable: <span class="bool-val">true</span>, ..default }], |
| <a href=#760 id=760 data-nosnippet>760</a> <span class="macro">vec!</span>[default], |
| <a href=#761 id=761 data-nosnippet>761</a> <span class="macro">vec!</span>[Cr { is_local: <span class="bool-val">true</span>, ..default }], |
| <a href=#762 id=762 data-nosnippet>762</a> <span class="macro">vec!</span>[Cr { type_match: <span class="prelude-val">Some</span>(CompletionRelevanceTypeMatch::CouldUnify), ..default }], |
| <a href=#763 id=763 data-nosnippet>763</a> <span class="macro">vec!</span>[Cr { type_match: <span class="prelude-val">Some</span>(CompletionRelevanceTypeMatch::Exact), ..default }], |
| <a href=#764 id=764 data-nosnippet>764</a> <span class="macro">vec!</span>[Cr { exact_name_match: <span class="bool-val">true</span>, ..default }], |
| <a href=#765 id=765 data-nosnippet>765</a> <span class="macro">vec!</span>[Cr { exact_name_match: <span class="bool-val">true</span>, is_local: <span class="bool-val">true</span>, ..default }], |
| <a href=#766 id=766 data-nosnippet>766</a> <span class="macro">vec!</span>[Cr { |
| <a href=#767 id=767 data-nosnippet>767</a> exact_name_match: <span class="bool-val">true</span>, |
| <a href=#768 id=768 data-nosnippet>768</a> type_match: <span class="prelude-val">Some</span>(CompletionRelevanceTypeMatch::Exact), |
| <a href=#769 id=769 data-nosnippet>769</a> ..default |
| <a href=#770 id=770 data-nosnippet>770</a> }], |
| <a href=#771 id=771 data-nosnippet>771</a> <span class="macro">vec!</span>[Cr { |
| <a href=#772 id=772 data-nosnippet>772</a> exact_name_match: <span class="bool-val">true</span>, |
| <a href=#773 id=773 data-nosnippet>773</a> type_match: <span class="prelude-val">Some</span>(CompletionRelevanceTypeMatch::Exact), |
| <a href=#774 id=774 data-nosnippet>774</a> is_local: <span class="bool-val">true</span>, |
| <a href=#775 id=775 data-nosnippet>775</a> ..default |
| <a href=#776 id=776 data-nosnippet>776</a> }], |
| <a href=#777 id=777 data-nosnippet>777</a> <span class="macro">vec!</span>[Cr { postfix_match: <span class="prelude-val">Some</span>(CompletionRelevancePostfixMatch::Exact), ..default }], |
| <a href=#778 id=778 data-nosnippet>778</a> ]; |
| <a href=#779 id=779 data-nosnippet>779</a> |
| <a href=#780 id=780 data-nosnippet>780</a> check_relevance_score_ordered(expected_relevance_order); |
| <a href=#781 id=781 data-nosnippet>781</a> } |
| <a href=#782 id=782 data-nosnippet>782</a>} |
| </code></pre></div></section></main></body></html> |
