Google Git
Sign in
fuchsia/third_party/github.com/rust-lang/rust-analyzer/refs/heads/upstream/gh-pages/./src/ide/doc_links.rs.html
blob: e11c108e47b8f7e7a6e13333198677ebbb6a299e [file] [log] [blame] [edit]
<!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/doc_links.rs`."><title>doc_links.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" 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/</div>doc_links.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">//! Extracts, resolves and rewrites links and intra-doc links in markdown documentation.
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="attr">#[cfg(test)]
<a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">mod </span>tests;
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">mod </span>intra_doc_links;
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>std::ops::Range;
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">use </span>pulldown_cmark::{BrokenLink, CowStr, Event, InlineStr, LinkType, Options, Parser, Tag};
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span>pulldown_cmark_to_cmark::{Options <span class="kw">as </span>CMarkOptions, cmark_with_options};
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">use </span>stdx::format_to;
<a href=#13 id=13 data-nosnippet>13</a><span class="kw">use </span>url::Url;
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">use </span>hir::{
<a href=#16 id=16 data-nosnippet>16</a> Adt, AsAssocItem, AssocItem, AssocItemContainer, AttrsWithOwner, HasAttrs, db::HirDatabase,
<a href=#17 id=17 data-nosnippet>17</a>};
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>ide_db::{
<a href=#19 id=19 data-nosnippet>19</a> RootDatabase,
<a href=#20 id=20 data-nosnippet>20</a> base_db::{CrateOrigin, LangCrateOrigin, ReleaseChannel, RootQueryDb},
<a href=#21 id=21 data-nosnippet>21</a> defs::{Definition, NameClass, NameRefClass},
<a href=#22 id=22 data-nosnippet>22</a> documentation::{Documentation, HasDocs},
<a href=#23 id=23 data-nosnippet>23</a> helpers::pick_best_token,
<a href=#24 id=24 data-nosnippet>24</a>};
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>syntax::{
<a href=#26 id=26 data-nosnippet>26</a> AstNode, AstToken,
<a href=#27 id=27 data-nosnippet>27</a> SyntaxKind::<span class="kw-2">*</span>,
<a href=#28 id=28 data-nosnippet>28</a> SyntaxNode, SyntaxToken, T, TextRange, TextSize,
<a href=#29 id=29 data-nosnippet>29</a> ast::{<span class="self">self</span>, IsString},
<a href=#30 id=30 data-nosnippet>30</a> match_ast,
<a href=#31 id=31 data-nosnippet>31</a>};
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">use </span>crate::{
<a href=#34 id=34 data-nosnippet>34</a> FilePosition, Semantics,
<a href=#35 id=35 data-nosnippet>35</a> doc_links::intra_doc_links::{parse_intra_doc_link, strip_prefixes_suffixes},
<a href=#36 id=36 data-nosnippet>36</a>};
<a href=#37 id=37 data-nosnippet>37</a>
<a href=#38 id=38 data-nosnippet>38</a><span class="doccomment">/// Web and local links to an item's documentation.
<a href=#39 id=39 data-nosnippet>39</a></span><span class="attr">#[derive(Default, Debug, Clone, PartialEq, Eq)]
<a href=#40 id=40 data-nosnippet>40</a></span><span class="kw">pub struct </span>DocumentationLinks {
<a href=#41 id=41 data-nosnippet>41</a> <span class="doccomment">/// The URL to the documentation on docs.rs.
<a href=#42 id=42 data-nosnippet>42</a> /// May not lead anywhere.
<a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">pub </span>web_url: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#44 id=44 data-nosnippet>44</a> <span class="doccomment">/// The URL to the documentation in the local file system.
<a href=#45 id=45 data-nosnippet>45</a> /// May not lead anywhere.
<a href=#46 id=46 data-nosnippet>46</a> </span><span class="kw">pub </span>local_url: <span class="prelude-ty">Option</span>&lt;String&gt;,
<a href=#47 id=47 data-nosnippet>47</a>}
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a><span class="kw">const </span>MARKDOWN_OPTIONS: Options =
<a href=#50 id=50 data-nosnippet>50</a> Options::ENABLE_FOOTNOTES.union(Options::ENABLE_TABLES).union(Options::ENABLE_TASKLISTS);
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a><span class="doccomment">/// Rewrite documentation links in markdown to point to an online host (e.g. docs.rs)
<a href=#53 id=53 data-nosnippet>53</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>rewrite_links(
<a href=#54 id=54 data-nosnippet>54</a> db: <span class="kw-2">&amp;</span>RootDatabase,
<a href=#55 id=55 data-nosnippet>55</a> markdown: <span class="kw-2">&amp;</span>str,
<a href=#56 id=56 data-nosnippet>56</a> definition: Definition,
<a href=#57 id=57 data-nosnippet>57</a> range_map: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>hir::Docs&gt;,
<a href=#58 id=58 data-nosnippet>58</a>) -&gt; String {
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">let </span><span class="kw-2">mut </span>cb = broken_link_clone_cb;
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">let </span>doc = Parser::new_with_broken_link_callback(markdown, MARKDOWN_OPTIONS, <span class="prelude-val">Some</span>(<span class="kw-2">&amp;mut </span>cb))
<a href=#61 id=61 data-nosnippet>61</a> .into_offset_iter();
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>doc = map_links(doc, |target, title, range, link_type| {
<a href=#64 id=64 data-nosnippet>64</a> <span class="comment">// This check is imperfect, there's some overlap between valid intra-doc links
<a href=#65 id=65 data-nosnippet>65</a> // and valid URLs so we choose to be too eager to try to resolve what might be
<a href=#66 id=66 data-nosnippet>66</a> // a URL.
<a href=#67 id=67 data-nosnippet>67</a> </span><span class="kw">if </span>target.contains(<span class="string">"://"</span>) {
<a href=#68 id=68 data-nosnippet>68</a> (<span class="prelude-val">Some</span>(LinkType::Inline), target.to_owned(), title.to_owned())
<a href=#69 id=69 data-nosnippet>69</a> } <span class="kw">else </span>{
<a href=#70 id=70 data-nosnippet>70</a> <span class="comment">// Two possibilities:
<a href=#71 id=71 data-nosnippet>71</a> // * path-based links: `../../module/struct.MyStruct.html`
<a href=#72 id=72 data-nosnippet>72</a> // * module-based links (AKA intra-doc links): `super::super::module::MyStruct`
<a href=#73 id=73 data-nosnippet>73</a> </span><span class="kw">let </span>text_range =
<a href=#74 id=74 data-nosnippet>74</a> TextRange::new(range.start.try_into().unwrap(), range.end.try_into().unwrap());
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">let </span>is_inner_doc = range_map
<a href=#76 id=76 data-nosnippet>76</a> .as_ref()
<a href=#77 id=77 data-nosnippet>77</a> .and_then(|range_map| range_map.find_ast_range(text_range))
<a href=#78 id=78 data-nosnippet>78</a> .map(|(<span class="kw">_</span>, is_inner)| is_inner)
<a href=#79 id=79 data-nosnippet>79</a> .unwrap_or(hir::IsInnerDoc::No);
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw">if let </span><span class="prelude-val">Some</span>((target, title)) =
<a href=#81 id=81 data-nosnippet>81</a> rewrite_intra_doc_link(db, definition, target, title, is_inner_doc, link_type)
<a href=#82 id=82 data-nosnippet>82</a> {
<a href=#83 id=83 data-nosnippet>83</a> (<span class="prelude-val">None</span>, target, title)
<a href=#84 id=84 data-nosnippet>84</a> } <span class="kw">else if let </span><span class="prelude-val">Some</span>(target) = rewrite_url_link(db, definition, target) {
<a href=#85 id=85 data-nosnippet>85</a> (<span class="prelude-val">Some</span>(LinkType::Inline), target, title.to_owned())
<a href=#86 id=86 data-nosnippet>86</a> } <span class="kw">else </span>{
<a href=#87 id=87 data-nosnippet>87</a> (<span class="prelude-val">None</span>, target.to_owned(), title.to_owned())
<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> });
<a href=#91 id=91 data-nosnippet>91</a> <span class="kw">let </span><span class="kw-2">mut </span>out = String::new();
<a href=#92 id=92 data-nosnippet>92</a> cmark_with_options(
<a href=#93 id=93 data-nosnippet>93</a> doc,
<a href=#94 id=94 data-nosnippet>94</a> <span class="kw-2">&amp;mut </span>out,
<a href=#95 id=95 data-nosnippet>95</a> CMarkOptions { code_block_token_count: <span class="number">3</span>, ..Default::default() },
<a href=#96 id=96 data-nosnippet>96</a> )
<a href=#97 id=97 data-nosnippet>97</a> .ok();
<a href=#98 id=98 data-nosnippet>98</a> out
<a href=#99 id=99 data-nosnippet>99</a>}
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a><span class="doccomment">/// Remove all links in markdown documentation.
<a href=#102 id=102 data-nosnippet>102</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>remove_links(markdown: <span class="kw-2">&amp;</span>str) -&gt; String {
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">let </span><span class="kw-2">mut </span>drop_link = <span class="bool-val">false</span>;
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a> <span class="kw">let </span><span class="kw-2">mut </span>cb = |<span class="kw">_</span>: BrokenLink&lt;<span class="lifetime">'_</span>&gt;| {
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">let </span>empty = InlineStr::try_from(<span class="string">""</span>).unwrap();
<a href=#107 id=107 data-nosnippet>107</a> <span class="prelude-val">Some</span>((CowStr::Inlined(empty), CowStr::Inlined(empty)))
<a href=#108 id=108 data-nosnippet>108</a> };
<a href=#109 id=109 data-nosnippet>109</a> <span class="kw">let </span>doc = Parser::new_with_broken_link_callback(markdown, MARKDOWN_OPTIONS, <span class="prelude-val">Some</span>(<span class="kw-2">&amp;mut </span>cb));
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw">let </span>doc = doc.filter_map(<span class="kw">move </span>|evt| <span class="kw">match </span>evt {
<a href=#111 id=111 data-nosnippet>111</a> Event::Start(Tag::Link(link_type, target, title)) =&gt; {
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">if </span>link_type == LinkType::Inline &amp;&amp; target.contains(<span class="string">"://"</span>) {
<a href=#113 id=113 data-nosnippet>113</a> <span class="prelude-val">Some</span>(Event::Start(Tag::Link(link_type, target, title)))
<a href=#114 id=114 data-nosnippet>114</a> } <span class="kw">else </span>{
<a href=#115 id=115 data-nosnippet>115</a> drop_link = <span class="bool-val">true</span>;
<a href=#116 id=116 data-nosnippet>116</a> <span class="prelude-val">None
<a href=#117 id=117 data-nosnippet>117</a> </span>}
<a href=#118 id=118 data-nosnippet>118</a> }
<a href=#119 id=119 data-nosnippet>119</a> Event::End(<span class="kw">_</span>) <span class="kw">if </span>drop_link =&gt; {
<a href=#120 id=120 data-nosnippet>120</a> drop_link = <span class="bool-val">false</span>;
<a href=#121 id=121 data-nosnippet>121</a> <span class="prelude-val">None
<a href=#122 id=122 data-nosnippet>122</a> </span>}
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Some</span>(evt),
<a href=#124 id=124 data-nosnippet>124</a> });
<a href=#125 id=125 data-nosnippet>125</a>
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">let </span><span class="kw-2">mut </span>out = String::new();
<a href=#127 id=127 data-nosnippet>127</a> cmark_with_options(
<a href=#128 id=128 data-nosnippet>128</a> doc,
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw-2">&amp;mut </span>out,
<a href=#130 id=130 data-nosnippet>130</a> CMarkOptions { code_block_token_count: <span class="number">3</span>, ..Default::default() },
<a href=#131 id=131 data-nosnippet>131</a> )
<a href=#132 id=132 data-nosnippet>132</a> .ok();
<a href=#133 id=133 data-nosnippet>133</a> out
<a href=#134 id=134 data-nosnippet>134</a>}
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a><span class="comment">// Feature: Open Docs
<a href=#137 id=137 data-nosnippet>137</a>//
<a href=#138 id=138 data-nosnippet>138</a>// Retrieve a links to documentation for the given symbol.
<a href=#139 id=139 data-nosnippet>139</a>//
<a href=#140 id=140 data-nosnippet>140</a>// The simplest way to use this feature is via the context menu. Right-click on
<a href=#141 id=141 data-nosnippet>141</a>// the selected item. The context menu opens. Select **Open Docs**.
<a href=#142 id=142 data-nosnippet>142</a>//
<a href=#143 id=143 data-nosnippet>143</a>// | Editor | Action Name |
<a href=#144 id=144 data-nosnippet>144</a>// |---------|-------------|
<a href=#145 id=145 data-nosnippet>145</a>// | VS Code | **rust-analyzer: Open Docs** |
<a href=#146 id=146 data-nosnippet>146</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>external_docs(
<a href=#147 id=147 data-nosnippet>147</a> db: <span class="kw-2">&amp;</span>RootDatabase,
<a href=#148 id=148 data-nosnippet>148</a> FilePosition { file_id, offset }: FilePosition,
<a href=#149 id=149 data-nosnippet>149</a> target_dir: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
<a href=#150 id=150 data-nosnippet>150</a> sysroot: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
<a href=#151 id=151 data-nosnippet>151</a>) -&gt; <span class="prelude-ty">Option</span>&lt;DocumentationLinks&gt; {
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">let </span>sema = <span class="kw-2">&amp;</span>Semantics::new(db);
<a href=#153 id=153 data-nosnippet>153</a> <span class="kw">let </span>file = sema.parse_guess_edition(file_id).syntax().clone();
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">let </span>token = pick_best_token(file.token_at_offset(offset), |kind| <span class="kw">match </span>kind {
<a href=#155 id=155 data-nosnippet>155</a> IDENT | INT_NUMBER | <span class="macro">T!</span>[<span class="self">self</span>] =&gt; <span class="number">3</span>,
<a href=#156 id=156 data-nosnippet>156</a> <span class="macro">T!</span>[<span class="string">'('</span>] | <span class="macro">T!</span>[<span class="string">')'</span>] =&gt; <span class="number">2</span>,
<a href=#157 id=157 data-nosnippet>157</a> kind <span class="kw">if </span>kind.is_trivia() =&gt; <span class="number">0</span>,
<a href=#158 id=158 data-nosnippet>158</a> <span class="kw">_ </span>=&gt; <span class="number">1</span>,
<a href=#159 id=159 data-nosnippet>159</a> })<span class="question-mark">?</span>;
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">let </span>token = sema.descend_into_macros_single_exact(token);
<a href=#161 id=161 data-nosnippet>161</a>
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">let </span>node = token.parent()<span class="question-mark">?</span>;
<a href=#163 id=163 data-nosnippet>163</a> <span class="kw">let </span>definition = <span class="macro">match_ast!</span> {
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">match </span>node {
<a href=#165 id=165 data-nosnippet>165</a> ast::NameRef(name_ref) =&gt; <span class="kw">match </span>NameRefClass::classify(sema, <span class="kw-2">&amp;</span>name_ref)<span class="question-mark">? </span>{
<a href=#166 id=166 data-nosnippet>166</a> NameRefClass::Definition(def, <span class="kw">_</span>) =&gt; def,
<a href=#167 id=167 data-nosnippet>167</a> NameRefClass::FieldShorthand { local_ref: <span class="kw">_</span>, field_ref, adt_subst: <span class="kw">_ </span>} =&gt; {
<a href=#168 id=168 data-nosnippet>168</a> Definition::Field(field_ref)
<a href=#169 id=169 data-nosnippet>169</a> }
<a href=#170 id=170 data-nosnippet>170</a> NameRefClass::ExternCrateShorthand { decl, .. } =&gt; {
<a href=#171 id=171 data-nosnippet>171</a> Definition::ExternCrateDecl(decl)
<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> ast::Name(name) =&gt; <span class="kw">match </span>NameClass::classify(sema, <span class="kw-2">&amp;</span>name)<span class="question-mark">? </span>{
<a href=#175 id=175 data-nosnippet>175</a> NameClass::Definition(it) | NameClass::ConstReference(it) =&gt; it,
<a href=#176 id=176 data-nosnippet>176</a> NameClass::PatFieldShorthand { local_def: <span class="kw">_</span>, field_ref, adt_subst: <span class="kw">_ </span>} =&gt; Definition::Field(field_ref),
<a href=#177 id=177 data-nosnippet>177</a> },
<a href=#178 id=178 data-nosnippet>178</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">None
<a href=#179 id=179 data-nosnippet>179</a> </span>}
<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="prelude-val">Some</span>(get_doc_links(db, definition, target_dir, sysroot))
<a href=#183 id=183 data-nosnippet>183</a>}
<a href=#184 id=184 data-nosnippet>184</a>
<a href=#185 id=185 data-nosnippet>185</a><span class="doccomment">/// Extracts all links from a given markdown text returning the definition text range, link-text
<a href=#186 id=186 data-nosnippet>186</a>/// and the namespace if known.
<a href=#187 id=187 data-nosnippet>187</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>extract_definitions_from_docs(
<a href=#188 id=188 data-nosnippet>188</a> docs: <span class="kw-2">&amp;</span>Documentation&lt;<span class="lifetime">'_</span>&gt;,
<a href=#189 id=189 data-nosnippet>189</a>) -&gt; Vec&lt;(TextRange, String, <span class="prelude-ty">Option</span>&lt;hir::Namespace&gt;)&gt; {
<a href=#190 id=190 data-nosnippet>190</a> Parser::new_with_broken_link_callback(
<a href=#191 id=191 data-nosnippet>191</a> docs.as_str(),
<a href=#192 id=192 data-nosnippet>192</a> MARKDOWN_OPTIONS,
<a href=#193 id=193 data-nosnippet>193</a> <span class="prelude-val">Some</span>(<span class="kw-2">&amp;mut </span>broken_link_clone_cb),
<a href=#194 id=194 data-nosnippet>194</a> )
<a href=#195 id=195 data-nosnippet>195</a> .into_offset_iter()
<a href=#196 id=196 data-nosnippet>196</a> .filter_map(|(event, range)| <span class="kw">match </span>event {
<a href=#197 id=197 data-nosnippet>197</a> Event::Start(Tag::Link(<span class="kw">_</span>, target, <span class="kw">_</span>)) =&gt; {
<a href=#198 id=198 data-nosnippet>198</a> <span class="kw">let </span>(link, ns) = parse_intra_doc_link(<span class="kw-2">&amp;</span>target);
<a href=#199 id=199 data-nosnippet>199</a> <span class="prelude-val">Some</span>((
<a href=#200 id=200 data-nosnippet>200</a> TextRange::new(range.start.try_into().ok()<span class="question-mark">?</span>, range.end.try_into().ok()<span class="question-mark">?</span>),
<a href=#201 id=201 data-nosnippet>201</a> link.to_owned(),
<a href=#202 id=202 data-nosnippet>202</a> ns,
<a href=#203 id=203 data-nosnippet>203</a> ))
<a href=#204 id=204 data-nosnippet>204</a> }
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
<a href=#206 id=206 data-nosnippet>206</a> })
<a href=#207 id=207 data-nosnippet>207</a> .collect()
<a href=#208 id=208 data-nosnippet>208</a>}
<a href=#209 id=209 data-nosnippet>209</a>
<a href=#210 id=210 data-nosnippet>210</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>resolve_doc_path_for_def(
<a href=#211 id=211 data-nosnippet>211</a> db: <span class="kw-2">&amp;</span><span class="kw">dyn </span>HirDatabase,
<a href=#212 id=212 data-nosnippet>212</a> def: Definition,
<a href=#213 id=213 data-nosnippet>213</a> link: <span class="kw-2">&amp;</span>str,
<a href=#214 id=214 data-nosnippet>214</a> ns: <span class="prelude-ty">Option</span>&lt;hir::Namespace&gt;,
<a href=#215 id=215 data-nosnippet>215</a> is_inner_doc: hir::IsInnerDoc,
<a href=#216 id=216 data-nosnippet>216</a>) -&gt; <span class="prelude-ty">Option</span>&lt;Definition&gt; {
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">match </span>def {
<a href=#218 id=218 data-nosnippet>218</a> Definition::Module(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#219 id=219 data-nosnippet>219</a> Definition::Crate(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#220 id=220 data-nosnippet>220</a> Definition::Function(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#221 id=221 data-nosnippet>221</a> Definition::Adt(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#222 id=222 data-nosnippet>222</a> Definition::Variant(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#223 id=223 data-nosnippet>223</a> Definition::Const(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#224 id=224 data-nosnippet>224</a> Definition::Static(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#225 id=225 data-nosnippet>225</a> Definition::Trait(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#226 id=226 data-nosnippet>226</a> Definition::TypeAlias(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#227 id=227 data-nosnippet>227</a> Definition::Macro(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#228 id=228 data-nosnippet>228</a> Definition::Field(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#229 id=229 data-nosnippet>229</a> Definition::SelfType(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#230 id=230 data-nosnippet>230</a> Definition::ExternCrateDecl(it) =&gt; it.resolve_doc_path(db, link, ns, is_inner_doc),
<a href=#231 id=231 data-nosnippet>231</a> Definition::BuiltinAttr(<span class="kw">_</span>)
<a href=#232 id=232 data-nosnippet>232</a> | Definition::BuiltinType(<span class="kw">_</span>)
<a href=#233 id=233 data-nosnippet>233</a> | Definition::BuiltinLifetime(<span class="kw">_</span>)
<a href=#234 id=234 data-nosnippet>234</a> | Definition::ToolModule(<span class="kw">_</span>)
<a href=#235 id=235 data-nosnippet>235</a> | Definition::TupleField(<span class="kw">_</span>)
<a href=#236 id=236 data-nosnippet>236</a> | Definition::Local(<span class="kw">_</span>)
<a href=#237 id=237 data-nosnippet>237</a> | Definition::GenericParam(<span class="kw">_</span>)
<a href=#238 id=238 data-nosnippet>238</a> | Definition::Label(<span class="kw">_</span>)
<a href=#239 id=239 data-nosnippet>239</a> | Definition::DeriveHelper(<span class="kw">_</span>)
<a href=#240 id=240 data-nosnippet>240</a> | Definition::InlineAsmRegOrRegClass(<span class="kw">_</span>)
<a href=#241 id=241 data-nosnippet>241</a> | Definition::InlineAsmOperand(<span class="kw">_</span>) =&gt; <span class="prelude-val">None</span>,
<a href=#242 id=242 data-nosnippet>242</a> }
<a href=#243 id=243 data-nosnippet>243</a> .map(Definition::from)
<a href=#244 id=244 data-nosnippet>244</a>}
<a href=#245 id=245 data-nosnippet>245</a>
<a href=#246 id=246 data-nosnippet>246</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>doc_attributes(
<a href=#247 id=247 data-nosnippet>247</a> sema: <span class="kw-2">&amp;</span>Semantics&lt;<span class="lifetime">'_</span>, RootDatabase&gt;,
<a href=#248 id=248 data-nosnippet>248</a> node: <span class="kw-2">&amp;</span>SyntaxNode,
<a href=#249 id=249 data-nosnippet>249</a>) -&gt; <span class="prelude-ty">Option</span>&lt;(hir::AttrsWithOwner, Definition)&gt; {
<a href=#250 id=250 data-nosnippet>250</a> <span class="macro">match_ast!</span> {
<a href=#251 id=251 data-nosnippet>251</a> <span class="kw">match </span>node {
<a href=#252 id=252 data-nosnippet>252</a> ast::SourceFile(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#253 id=253 data-nosnippet>253</a> ast::Module(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#254 id=254 data-nosnippet>254</a> ast::Fn(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#255 id=255 data-nosnippet>255</a> ast::Struct(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(hir::Adt::Struct(def)))),
<a href=#256 id=256 data-nosnippet>256</a> ast::Union(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(hir::Adt::Union(def)))),
<a href=#257 id=257 data-nosnippet>257</a> ast::Enum(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(hir::Adt::Enum(def)))),
<a href=#258 id=258 data-nosnippet>258</a> ast::Variant(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#259 id=259 data-nosnippet>259</a> ast::Trait(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#260 id=260 data-nosnippet>260</a> ast::Static(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#261 id=261 data-nosnippet>261</a> ast::Const(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#262 id=262 data-nosnippet>262</a> ast::TypeAlias(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#263 id=263 data-nosnippet>263</a> ast::Impl(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#264 id=264 data-nosnippet>264</a> ast::RecordField(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#265 id=265 data-nosnippet>265</a> ast::TupleField(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#266 id=266 data-nosnippet>266</a> ast::Macro(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#267 id=267 data-nosnippet>267</a> ast::ExternCrate(it) =&gt; sema.to_def(<span class="kw-2">&amp;</span>it).map(|def| (def.attrs(sema.db), Definition::from(def))),
<a href=#268 id=268 data-nosnippet>268</a> <span class="comment">// ast::Use(it) =&gt; sema.to_def(&amp;it).map(|def| (Box::new(it) as _, def.attrs(sema.db))),
<a href=#269 id=269 data-nosnippet>269</a> </span><span class="kw">_ </span>=&gt; <span class="prelude-val">None
<a href=#270 id=270 data-nosnippet>270</a> </span>}
<a href=#271 id=271 data-nosnippet>271</a> }
<a href=#272 id=272 data-nosnippet>272</a>}
<a href=#273 id=273 data-nosnippet>273</a>
<a href=#274 id=274 data-nosnippet>274</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>DocCommentToken {
<a href=#275 id=275 data-nosnippet>275</a> doc_token: SyntaxToken,
<a href=#276 id=276 data-nosnippet>276</a> prefix_len: TextSize,
<a href=#277 id=277 data-nosnippet>277</a>}
<a href=#278 id=278 data-nosnippet>278</a>
<a href=#279 id=279 data-nosnippet>279</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>token_as_doc_comment(doc_token: <span class="kw-2">&amp;</span>SyntaxToken) -&gt; <span class="prelude-ty">Option</span>&lt;DocCommentToken&gt; {
<a href=#280 id=280 data-nosnippet>280</a> (<span class="macro">match_ast!</span> {
<a href=#281 id=281 data-nosnippet>281</a> <span class="kw">match </span>doc_token {
<a href=#282 id=282 data-nosnippet>282</a> ast::Comment(comment) =&gt; TextSize::try_from(comment.prefix().len()).ok(),
<a href=#283 id=283 data-nosnippet>283</a> ast::String(string) =&gt; {
<a href=#284 id=284 data-nosnippet>284</a> doc_token.parent_ancestors().find_map(ast::Attr::cast).filter(|attr| attr.simple_name().as_deref() == <span class="prelude-val">Some</span>(<span class="string">"doc"</span>))<span class="question-mark">?</span>;
<a href=#285 id=285 data-nosnippet>285</a> <span class="kw">if </span>doc_token.parent_ancestors().find_map(ast::MacroCall::cast).filter(|mac| mac.path().and_then(|p| p.segment()<span class="question-mark">?</span>.name_ref()).as_ref().map(|n| n.text()).as_deref() == <span class="prelude-val">Some</span>(<span class="string">"include_str"</span>)).is_some() {
<a href=#286 id=286 data-nosnippet>286</a> <span class="kw">return </span><span class="prelude-val">None</span>;
<a href=#287 id=287 data-nosnippet>287</a> }
<a href=#288 id=288 data-nosnippet>288</a> string.open_quote_text_range().map(|it| it.len())
<a href=#289 id=289 data-nosnippet>289</a> },
<a href=#290 id=290 data-nosnippet>290</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
<a href=#291 id=291 data-nosnippet>291</a> }
<a href=#292 id=292 data-nosnippet>292</a> }).map(|prefix_len| DocCommentToken { prefix_len, doc_token: doc_token.clone() })
<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">impl </span>DocCommentToken {
<a href=#296 id=296 data-nosnippet>296</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>get_definition_with_descend_at&lt;T&gt;(
<a href=#297 id=297 data-nosnippet>297</a> <span class="self">self</span>,
<a href=#298 id=298 data-nosnippet>298</a> sema: <span class="kw-2">&amp;</span>Semantics&lt;<span class="lifetime">'_</span>, RootDatabase&gt;,
<a href=#299 id=299 data-nosnippet>299</a> offset: TextSize,
<a href=#300 id=300 data-nosnippet>300</a> <span class="comment">// Definition, CommentOwner, range of intra doc link in original file
<a href=#301 id=301 data-nosnippet>301</a> </span><span class="kw-2">mut </span>cb: <span class="kw">impl </span>FnMut(Definition, SyntaxNode, TextRange) -&gt; <span class="prelude-ty">Option</span>&lt;T&gt;,
<a href=#302 id=302 data-nosnippet>302</a> ) -&gt; <span class="prelude-ty">Option</span>&lt;T&gt; {
<a href=#303 id=303 data-nosnippet>303</a> <span class="kw">let </span>DocCommentToken { prefix_len, doc_token } = <span class="self">self</span>;
<a href=#304 id=304 data-nosnippet>304</a> <span class="comment">// offset relative to the comments contents
<a href=#305 id=305 data-nosnippet>305</a> </span><span class="kw">let </span>original_start = doc_token.text_range().start();
<a href=#306 id=306 data-nosnippet>306</a> <span class="kw">let </span>relative_comment_offset = offset - original_start - prefix_len;
<a href=#307 id=307 data-nosnippet>307</a>
<a href=#308 id=308 data-nosnippet>308</a> sema.descend_into_macros(doc_token).into_iter().find_map(|t| {
<a href=#309 id=309 data-nosnippet>309</a> <span class="kw">let </span>(node, descended_prefix_len, is_inner) = <span class="macro">match_ast!</span>{
<a href=#310 id=310 data-nosnippet>310</a> <span class="kw">match </span>t {
<a href=#311 id=311 data-nosnippet>311</a> ast::Comment(comment) =&gt; {
<a href=#312 id=312 data-nosnippet>312</a> (t.parent()<span class="question-mark">?</span>, TextSize::try_from(comment.prefix().len()).ok()<span class="question-mark">?</span>, comment.is_inner())
<a href=#313 id=313 data-nosnippet>313</a> },
<a href=#314 id=314 data-nosnippet>314</a> ast::String(string) =&gt; {
<a href=#315 id=315 data-nosnippet>315</a> <span class="kw">let </span>attr = t.parent_ancestors().find_map(ast::Attr::cast)<span class="question-mark">?</span>;
<a href=#316 id=316 data-nosnippet>316</a> <span class="kw">let </span>attr_is_inner = attr.excl_token().map(|excl| excl.kind() == BANG).unwrap_or(<span class="bool-val">false</span>);
<a href=#317 id=317 data-nosnippet>317</a> (attr.syntax().parent()<span class="question-mark">?</span>, string.open_quote_text_range()<span class="question-mark">?</span>.len(), attr_is_inner)
<a href=#318 id=318 data-nosnippet>318</a> },
<a href=#319 id=319 data-nosnippet>319</a> <span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
<a href=#320 id=320 data-nosnippet>320</a> }
<a href=#321 id=321 data-nosnippet>321</a> };
<a href=#322 id=322 data-nosnippet>322</a> <span class="kw">let </span>token_start = t.text_range().start();
<a href=#323 id=323 data-nosnippet>323</a> <span class="kw">let </span>abs_in_expansion_offset = token_start + relative_comment_offset + descended_prefix_len;
<a href=#324 id=324 data-nosnippet>324</a> <span class="kw">let </span>(attributes, def) = <span class="self">Self</span>::doc_attributes(sema, <span class="kw-2">&amp;</span>node, is_inner)<span class="question-mark">?</span>;
<a href=#325 id=325 data-nosnippet>325</a> <span class="kw">let </span>doc_mapping = attributes.hir_docs(sema.db)<span class="question-mark">?</span>;
<a href=#326 id=326 data-nosnippet>326</a> <span class="kw">let </span>(in_expansion_range, link, ns, is_inner) =
<a href=#327 id=327 data-nosnippet>327</a> extract_definitions_from_docs(<span class="kw-2">&amp;</span>Documentation::new_borrowed(doc_mapping.docs())).into_iter().find_map(|(range, link, ns)| {
<a href=#328 id=328 data-nosnippet>328</a> <span class="kw">let </span>(mapped, is_inner) = doc_mapping.find_ast_range(range)<span class="question-mark">?</span>;
<a href=#329 id=329 data-nosnippet>329</a> (mapped.value.contains(abs_in_expansion_offset)).then_some((mapped.value, link, ns, is_inner))
<a href=#330 id=330 data-nosnippet>330</a> })<span class="question-mark">?</span>;
<a href=#331 id=331 data-nosnippet>331</a> <span class="comment">// get the relative range to the doc/attribute in the expansion
<a href=#332 id=332 data-nosnippet>332</a> </span><span class="kw">let </span>in_expansion_relative_range = in_expansion_range - descended_prefix_len - token_start;
<a href=#333 id=333 data-nosnippet>333</a> <span class="comment">// Apply relative range to the original input comment
<a href=#334 id=334 data-nosnippet>334</a> </span><span class="kw">let </span>absolute_range = in_expansion_relative_range + original_start + prefix_len;
<a href=#335 id=335 data-nosnippet>335</a> <span class="kw">let </span>def = resolve_doc_path_for_def(sema.db, def, <span class="kw-2">&amp;</span>link, ns, is_inner)<span class="question-mark">?</span>;
<a href=#336 id=336 data-nosnippet>336</a> cb(def, node, absolute_range)
<a href=#337 id=337 data-nosnippet>337</a> })
<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> <span class="doccomment">/// When we hover a inner doc item, this find a attached definition.
<a href=#341 id=341 data-nosnippet>341</a> /// ```
<a href=#342 id=342 data-nosnippet>342</a> /// // node == ITEM_LIST
<a href=#343 id=343 data-nosnippet>343</a> /// // node.parent == EXPR_BLOCK
<a href=#344 id=344 data-nosnippet>344</a> /// // node.parent().parent() == FN
<a href=#345 id=345 data-nosnippet>345</a> /// fn f() {
<a href=#346 id=346 data-nosnippet>346</a> /// //! [`S$0`]
<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><span class="kw">fn </span>doc_attributes(
<a href=#350 id=350 data-nosnippet>350</a> sema: <span class="kw-2">&amp;</span>Semantics&lt;<span class="lifetime">'_</span>, RootDatabase&gt;,
<a href=#351 id=351 data-nosnippet>351</a> node: <span class="kw-2">&amp;</span>SyntaxNode,
<a href=#352 id=352 data-nosnippet>352</a> is_inner_doc: bool,
<a href=#353 id=353 data-nosnippet>353</a> ) -&gt; <span class="prelude-ty">Option</span>&lt;(AttrsWithOwner, Definition)&gt; {
<a href=#354 id=354 data-nosnippet>354</a> <span class="kw">if </span>is_inner_doc &amp;&amp; node.kind() != SOURCE_FILE {
<a href=#355 id=355 data-nosnippet>355</a> <span class="kw">let </span>parent = node.parent()<span class="question-mark">?</span>;
<a href=#356 id=356 data-nosnippet>356</a> doc_attributes(sema, <span class="kw-2">&amp;</span>parent).or(doc_attributes(sema, <span class="kw-2">&amp;</span>parent.parent()<span class="question-mark">?</span>))
<a href=#357 id=357 data-nosnippet>357</a> } <span class="kw">else </span>{
<a href=#358 id=358 data-nosnippet>358</a> doc_attributes(sema, node)
<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>}
<a href=#362 id=362 data-nosnippet>362</a>
<a href=#363 id=363 data-nosnippet>363</a><span class="kw">fn </span>broken_link_clone_cb(link: BrokenLink&lt;<span class="lifetime">'_</span>&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;(CowStr&lt;<span class="lifetime">'_</span>&gt;, CowStr&lt;<span class="lifetime">'_</span>&gt;)&gt; {
<a href=#364 id=364 data-nosnippet>364</a> <span class="prelude-val">Some</span>((<span class="comment">/*url*/ </span>link.reference.clone(), <span class="comment">/*title*/ </span>link.reference))
<a href=#365 id=365 data-nosnippet>365</a>}
<a href=#366 id=366 data-nosnippet>366</a>
<a href=#367 id=367 data-nosnippet>367</a><span class="comment">// FIXME:
<a href=#368 id=368 data-nosnippet>368</a>// BUG: For Option::Some
<a href=#369 id=369 data-nosnippet>369</a>// Returns https://doc.rust-lang.org/nightly/core/prelude/v1/enum.Option.html#variant.Some
<a href=#370 id=370 data-nosnippet>370</a>// Instead of https://doc.rust-lang.org/nightly/core/option/enum.Option.html
<a href=#371 id=371 data-nosnippet>371</a>//
<a href=#372 id=372 data-nosnippet>372</a>// This should cease to be a problem if RFC2988 (Stable Rustdoc URLs) is implemented
<a href=#373 id=373 data-nosnippet>373</a>// https://github.com/rust-lang/rfcs/pull/2988
<a href=#374 id=374 data-nosnippet>374</a></span><span class="kw">fn </span>get_doc_links(
<a href=#375 id=375 data-nosnippet>375</a> db: <span class="kw-2">&amp;</span>RootDatabase,
<a href=#376 id=376 data-nosnippet>376</a> def: Definition,
<a href=#377 id=377 data-nosnippet>377</a> target_dir: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
<a href=#378 id=378 data-nosnippet>378</a> sysroot: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
<a href=#379 id=379 data-nosnippet>379</a>) -&gt; DocumentationLinks {
<a href=#380 id=380 data-nosnippet>380</a> <span class="kw">let </span>join_url = |base_url: <span class="prelude-ty">Option</span>&lt;Url&gt;, path: <span class="kw-2">&amp;</span>str| -&gt; <span class="prelude-ty">Option</span>&lt;Url&gt; {
<a href=#381 id=381 data-nosnippet>381</a> base_url.and_then(|url| url.join(path).ok())
<a href=#382 id=382 data-nosnippet>382</a> };
<a href=#383 id=383 data-nosnippet>383</a>
<a href=#384 id=384 data-nosnippet>384</a> <span class="kw">let </span><span class="prelude-val">Some</span>((target, file, frag)) = filename_and_frag_for_def(db, def) <span class="kw">else </span>{
<a href=#385 id=385 data-nosnippet>385</a> <span class="kw">return </span>Default::default();
<a href=#386 id=386 data-nosnippet>386</a> };
<a href=#387 id=387 data-nosnippet>387</a>
<a href=#388 id=388 data-nosnippet>388</a> <span class="kw">let </span>(<span class="kw-2">mut </span>web_url, <span class="kw-2">mut </span>local_url) = get_doc_base_urls(db, target, target_dir, sysroot);
<a href=#389 id=389 data-nosnippet>389</a>
<a href=#390 id=390 data-nosnippet>390</a> <span class="kw">let </span>append_mod = !<span class="macro">matches!</span>(def, Definition::Macro(m) <span class="kw">if </span>m.is_macro_export(db));
<a href=#391 id=391 data-nosnippet>391</a> <span class="kw">if </span>append_mod &amp;&amp; <span class="kw">let </span><span class="prelude-val">Some</span>(path) = mod_path_of_def(db, target) {
<a href=#392 id=392 data-nosnippet>392</a> web_url = join_url(web_url, <span class="kw-2">&amp;</span>path);
<a href=#393 id=393 data-nosnippet>393</a> local_url = join_url(local_url, <span class="kw-2">&amp;</span>path);
<a href=#394 id=394 data-nosnippet>394</a> }
<a href=#395 id=395 data-nosnippet>395</a>
<a href=#396 id=396 data-nosnippet>396</a> web_url = join_url(web_url, <span class="kw-2">&amp;</span>file);
<a href=#397 id=397 data-nosnippet>397</a> local_url = join_url(local_url, <span class="kw-2">&amp;</span>file);
<a href=#398 id=398 data-nosnippet>398</a>
<a href=#399 id=399 data-nosnippet>399</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(url) = web_url.as_mut() {
<a href=#400 id=400 data-nosnippet>400</a> url.set_fragment(frag.as_deref())
<a href=#401 id=401 data-nosnippet>401</a> }
<a href=#402 id=402 data-nosnippet>402</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(url) = local_url.as_mut() {
<a href=#403 id=403 data-nosnippet>403</a> url.set_fragment(frag.as_deref())
<a href=#404 id=404 data-nosnippet>404</a> }
<a href=#405 id=405 data-nosnippet>405</a>
<a href=#406 id=406 data-nosnippet>406</a> DocumentationLinks {
<a href=#407 id=407 data-nosnippet>407</a> web_url: web_url.map(|it| it.into()),
<a href=#408 id=408 data-nosnippet>408</a> local_url: local_url.map(|it| it.into()),
<a href=#409 id=409 data-nosnippet>409</a> }
<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">fn </span>rewrite_intra_doc_link(
<a href=#413 id=413 data-nosnippet>413</a> db: <span class="kw-2">&amp;</span>RootDatabase,
<a href=#414 id=414 data-nosnippet>414</a> def: Definition,
<a href=#415 id=415 data-nosnippet>415</a> target: <span class="kw-2">&amp;</span>str,
<a href=#416 id=416 data-nosnippet>416</a> title: <span class="kw-2">&amp;</span>str,
<a href=#417 id=417 data-nosnippet>417</a> is_inner_doc: hir::IsInnerDoc,
<a href=#418 id=418 data-nosnippet>418</a> link_type: LinkType,
<a href=#419 id=419 data-nosnippet>419</a>) -&gt; <span class="prelude-ty">Option</span>&lt;(String, String)&gt; {
<a href=#420 id=420 data-nosnippet>420</a> <span class="kw">let </span>(link, ns) = parse_intra_doc_link(target);
<a href=#421 id=421 data-nosnippet>421</a>
<a href=#422 id=422 data-nosnippet>422</a> <span class="kw">let </span>(link, anchor) = <span class="kw">match </span>link.split_once(<span class="string">'#'</span>) {
<a href=#423 id=423 data-nosnippet>423</a> <span class="prelude-val">Some</span>((new_link, anchor)) =&gt; (new_link, <span class="prelude-val">Some</span>(anchor)),
<a href=#424 id=424 data-nosnippet>424</a> <span class="prelude-val">None </span>=&gt; (link, <span class="prelude-val">None</span>),
<a href=#425 id=425 data-nosnippet>425</a> };
<a href=#426 id=426 data-nosnippet>426</a>
<a href=#427 id=427 data-nosnippet>427</a> <span class="kw">let </span>resolved = resolve_doc_path_for_def(db, def, link, ns, is_inner_doc)<span class="question-mark">?</span>;
<a href=#428 id=428 data-nosnippet>428</a> <span class="kw">let </span><span class="kw-2">mut </span>url = get_doc_base_urls(db, resolved, <span class="prelude-val">None</span>, <span class="prelude-val">None</span>).<span class="number">0</span><span class="question-mark">?</span>;
<a href=#429 id=429 data-nosnippet>429</a>
<a href=#430 id=430 data-nosnippet>430</a> <span class="kw">let </span>(<span class="kw">_</span>, file, frag) = filename_and_frag_for_def(db, resolved)<span class="question-mark">?</span>;
<a href=#431 id=431 data-nosnippet>431</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(path) = mod_path_of_def(db, resolved) {
<a href=#432 id=432 data-nosnippet>432</a> url = url.join(<span class="kw-2">&amp;</span>path).ok()<span class="question-mark">?</span>;
<a href=#433 id=433 data-nosnippet>433</a> }
<a href=#434 id=434 data-nosnippet>434</a>
<a href=#435 id=435 data-nosnippet>435</a> <span class="kw">let </span>frag = anchor.or(frag.as_deref());
<a href=#436 id=436 data-nosnippet>436</a>
<a href=#437 id=437 data-nosnippet>437</a> url = url.join(<span class="kw-2">&amp;</span>file).ok()<span class="question-mark">?</span>;
<a href=#438 id=438 data-nosnippet>438</a> url.set_fragment(frag);
<a href=#439 id=439 data-nosnippet>439</a>
<a href=#440 id=440 data-nosnippet>440</a> <span class="comment">// We want to strip the keyword prefix from the title, but only if the target is implicitly the same
<a href=#441 id=441 data-nosnippet>441</a> // as the title.
<a href=#442 id=442 data-nosnippet>442</a> </span><span class="kw">let </span>title = <span class="kw">match </span>link_type {
<a href=#443 id=443 data-nosnippet>443</a> LinkType::Email
<a href=#444 id=444 data-nosnippet>444</a> | LinkType::Autolink
<a href=#445 id=445 data-nosnippet>445</a> | LinkType::Shortcut
<a href=#446 id=446 data-nosnippet>446</a> | LinkType::Collapsed
<a href=#447 id=447 data-nosnippet>447</a> | LinkType::Reference
<a href=#448 id=448 data-nosnippet>448</a> | LinkType::Inline =&gt; title.to_owned(),
<a href=#449 id=449 data-nosnippet>449</a> LinkType::ShortcutUnknown | LinkType::CollapsedUnknown | LinkType::ReferenceUnknown =&gt; {
<a href=#450 id=450 data-nosnippet>450</a> strip_prefixes_suffixes(title).to_owned()
<a href=#451 id=451 data-nosnippet>451</a> }
<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="prelude-val">Some</span>((url.into(), title))
<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">/// Try to resolve path to local documentation via path-based links (i.e. `../gateway/struct.Shard.html`).
<a href=#458 id=458 data-nosnippet>458</a></span><span class="kw">fn </span>rewrite_url_link(db: <span class="kw-2">&amp;</span>RootDatabase, def: Definition, target: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;String&gt; {
<a href=#459 id=459 data-nosnippet>459</a> <span class="kw">if </span>!(target.contains(<span class="string">'#'</span>) || target.contains(<span class="string">".html"</span>)) {
<a href=#460 id=460 data-nosnippet>460</a> <span class="kw">return </span><span class="prelude-val">None</span>;
<a href=#461 id=461 data-nosnippet>461</a> }
<a href=#462 id=462 data-nosnippet>462</a>
<a href=#463 id=463 data-nosnippet>463</a> <span class="kw">let </span><span class="kw-2">mut </span>url = get_doc_base_urls(db, def, <span class="prelude-val">None</span>, <span class="prelude-val">None</span>).<span class="number">0</span><span class="question-mark">?</span>;
<a href=#464 id=464 data-nosnippet>464</a> <span class="kw">let </span>(def, file, frag) = filename_and_frag_for_def(db, def)<span class="question-mark">?</span>;
<a href=#465 id=465 data-nosnippet>465</a>
<a href=#466 id=466 data-nosnippet>466</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(path) = mod_path_of_def(db, def) {
<a href=#467 id=467 data-nosnippet>467</a> url = url.join(<span class="kw-2">&amp;</span>path).ok()<span class="question-mark">?</span>;
<a href=#468 id=468 data-nosnippet>468</a> }
<a href=#469 id=469 data-nosnippet>469</a>
<a href=#470 id=470 data-nosnippet>470</a> url = url.join(<span class="kw-2">&amp;</span>file).ok()<span class="question-mark">?</span>;
<a href=#471 id=471 data-nosnippet>471</a> url.set_fragment(frag.as_deref());
<a href=#472 id=472 data-nosnippet>472</a> url.join(target).ok().map(Into::into)
<a href=#473 id=473 data-nosnippet>473</a>}
<a href=#474 id=474 data-nosnippet>474</a>
<a href=#475 id=475 data-nosnippet>475</a><span class="kw">fn </span>mod_path_of_def(db: <span class="kw-2">&amp;</span>RootDatabase, def: Definition) -&gt; <span class="prelude-ty">Option</span>&lt;String&gt; {
<a href=#476 id=476 data-nosnippet>476</a> def.canonical_module_path(db).map(|it| {
<a href=#477 id=477 data-nosnippet>477</a> <span class="kw">let </span><span class="kw-2">mut </span>path = String::new();
<a href=#478 id=478 data-nosnippet>478</a> it.flat_map(|it| it.name(db)).for_each(|name| <span class="macro">format_to!</span>(path, <span class="string">"{}/"</span>, name.as_str()));
<a href=#479 id=479 data-nosnippet>479</a> path
<a href=#480 id=480 data-nosnippet>480</a> })
<a href=#481 id=481 data-nosnippet>481</a>}
<a href=#482 id=482 data-nosnippet>482</a>
<a href=#483 id=483 data-nosnippet>483</a><span class="doccomment">/// Rewrites a markdown document, applying 'callback' to each link.
<a href=#484 id=484 data-nosnippet>484</a></span><span class="kw">fn </span>map_links&lt;<span class="lifetime">'e</span>&gt;(
<a href=#485 id=485 data-nosnippet>485</a> events: <span class="kw">impl </span>Iterator&lt;Item = (Event&lt;<span class="lifetime">'e</span>&gt;, Range&lt;usize&gt;)&gt;,
<a href=#486 id=486 data-nosnippet>486</a> callback: <span class="kw">impl </span>Fn(<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>str, Range&lt;usize&gt;, LinkType) -&gt; (<span class="prelude-ty">Option</span>&lt;LinkType&gt;, String, String),
<a href=#487 id=487 data-nosnippet>487</a>) -&gt; <span class="kw">impl </span>Iterator&lt;Item = Event&lt;<span class="lifetime">'e</span>&gt;&gt; {
<a href=#488 id=488 data-nosnippet>488</a> <span class="kw">let </span><span class="kw-2">mut </span>in_link = <span class="bool-val">false</span>;
<a href=#489 id=489 data-nosnippet>489</a> <span class="comment">// holds the origin link target on start event and the rewritten one on end event
<a href=#490 id=490 data-nosnippet>490</a> </span><span class="kw">let </span><span class="kw-2">mut </span>end_link_target: <span class="prelude-ty">Option</span>&lt;CowStr&lt;<span class="lifetime">'_</span>&gt;&gt; = <span class="prelude-val">None</span>;
<a href=#491 id=491 data-nosnippet>491</a> <span class="comment">// normally link's type is determined by the type of link tag in the end event,
<a href=#492 id=492 data-nosnippet>492</a> // however in some cases we want to change the link type, for example,
<a href=#493 id=493 data-nosnippet>493</a> // `Shortcut` type parsed from Start/End tags doesn't make sense for url links
<a href=#494 id=494 data-nosnippet>494</a> </span><span class="kw">let </span><span class="kw-2">mut </span>end_link_type: <span class="prelude-ty">Option</span>&lt;LinkType&gt; = <span class="prelude-val">None</span>;
<a href=#495 id=495 data-nosnippet>495</a>
<a href=#496 id=496 data-nosnippet>496</a> events.map(<span class="kw">move </span>|(evt, range)| <span class="kw">match </span>evt {
<a href=#497 id=497 data-nosnippet>497</a> Event::Start(Tag::Link(link_type, <span class="kw-2">ref </span>target, <span class="kw">_</span>)) =&gt; {
<a href=#498 id=498 data-nosnippet>498</a> in_link = <span class="bool-val">true</span>;
<a href=#499 id=499 data-nosnippet>499</a> end_link_target = <span class="prelude-val">Some</span>(target.clone());
<a href=#500 id=500 data-nosnippet>500</a> end_link_type = <span class="prelude-val">Some</span>(link_type);
<a href=#501 id=501 data-nosnippet>501</a> evt
<a href=#502 id=502 data-nosnippet>502</a> }
<a href=#503 id=503 data-nosnippet>503</a> Event::End(Tag::Link(link_type, target, <span class="kw">_</span>)) =&gt; {
<a href=#504 id=504 data-nosnippet>504</a> in_link = <span class="bool-val">false</span>;
<a href=#505 id=505 data-nosnippet>505</a> Event::End(Tag::Link(
<a href=#506 id=506 data-nosnippet>506</a> end_link_type.take().unwrap_or(link_type),
<a href=#507 id=507 data-nosnippet>507</a> end_link_target.take().unwrap_or(target),
<a href=#508 id=508 data-nosnippet>508</a> CowStr::Borrowed(<span class="string">""</span>),
<a href=#509 id=509 data-nosnippet>509</a> ))
<a href=#510 id=510 data-nosnippet>510</a> }
<a href=#511 id=511 data-nosnippet>511</a> Event::Text(s) <span class="kw">if </span>in_link =&gt; {
<a href=#512 id=512 data-nosnippet>512</a> <span class="kw">let </span>(link_type, link_target_s, link_name) =
<a href=#513 id=513 data-nosnippet>513</a> callback(<span class="kw-2">&amp;</span>end_link_target.take().unwrap(), <span class="kw-2">&amp;</span>s, range, end_link_type.unwrap());
<a href=#514 id=514 data-nosnippet>514</a> end_link_target = <span class="prelude-val">Some</span>(CowStr::Boxed(link_target_s.into()));
<a href=#515 id=515 data-nosnippet>515</a> <span class="kw">if </span>!<span class="macro">matches!</span>(end_link_type, <span class="prelude-val">Some</span>(LinkType::Autolink)) &amp;&amp; link_type.is_some() {
<a href=#516 id=516 data-nosnippet>516</a> end_link_type = link_type;
<a href=#517 id=517 data-nosnippet>517</a> }
<a href=#518 id=518 data-nosnippet>518</a> Event::Text(CowStr::Boxed(link_name.into()))
<a href=#519 id=519 data-nosnippet>519</a> }
<a href=#520 id=520 data-nosnippet>520</a> Event::Code(s) <span class="kw">if </span>in_link =&gt; {
<a href=#521 id=521 data-nosnippet>521</a> <span class="kw">let </span>(link_type, link_target_s, link_name) =
<a href=#522 id=522 data-nosnippet>522</a> callback(<span class="kw-2">&amp;</span>end_link_target.take().unwrap(), <span class="kw-2">&amp;</span>s, range, end_link_type.unwrap());
<a href=#523 id=523 data-nosnippet>523</a> end_link_target = <span class="prelude-val">Some</span>(CowStr::Boxed(link_target_s.into()));
<a href=#524 id=524 data-nosnippet>524</a> <span class="kw">if </span>!<span class="macro">matches!</span>(end_link_type, <span class="prelude-val">Some</span>(LinkType::Autolink)) &amp;&amp; link_type.is_some() {
<a href=#525 id=525 data-nosnippet>525</a> end_link_type = link_type;
<a href=#526 id=526 data-nosnippet>526</a> }
<a href=#527 id=527 data-nosnippet>527</a> Event::Code(CowStr::Boxed(link_name.into()))
<a href=#528 id=528 data-nosnippet>528</a> }
<a href=#529 id=529 data-nosnippet>529</a> <span class="kw">_ </span>=&gt; evt,
<a href=#530 id=530 data-nosnippet>530</a> })
<a href=#531 id=531 data-nosnippet>531</a>}
<a href=#532 id=532 data-nosnippet>532</a>
<a href=#533 id=533 data-nosnippet>533</a><span class="doccomment">/// Get the root URL for the documentation of a definition.
<a href=#534 id=534 data-nosnippet>534</a>///
<a href=#535 id=535 data-nosnippet>535</a>/// ```ignore
<a href=#536 id=536 data-nosnippet>536</a>/// https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next
<a href=#537 id=537 data-nosnippet>537</a>/// ^^^^^^^^^^^^^^^^^^^^^^^^^^
<a href=#538 id=538 data-nosnippet>538</a>/// file:///project/root/target/doc/std/iter/trait.Iterator.html#tymethod.next
<a href=#539 id=539 data-nosnippet>539</a>/// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
<a href=#540 id=540 data-nosnippet>540</a>/// ```
<a href=#541 id=541 data-nosnippet>541</a></span><span class="kw">fn </span>get_doc_base_urls(
<a href=#542 id=542 data-nosnippet>542</a> db: <span class="kw-2">&amp;</span>RootDatabase,
<a href=#543 id=543 data-nosnippet>543</a> def: Definition,
<a href=#544 id=544 data-nosnippet>544</a> target_dir: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
<a href=#545 id=545 data-nosnippet>545</a> sysroot: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
<a href=#546 id=546 data-nosnippet>546</a>) -&gt; (<span class="prelude-ty">Option</span>&lt;Url&gt;, <span class="prelude-ty">Option</span>&lt;Url&gt;) {
<a href=#547 id=547 data-nosnippet>547</a> <span class="kw">let </span>local_doc = target_dir
<a href=#548 id=548 data-nosnippet>548</a> .and_then(|path| Url::parse(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">"file:///{path}/"</span>)).ok())
<a href=#549 id=549 data-nosnippet>549</a> .and_then(|it| it.join(<span class="string">"doc/"</span>).ok());
<a href=#550 id=550 data-nosnippet>550</a> <span class="kw">let </span>system_doc = sysroot
<a href=#551 id=551 data-nosnippet>551</a> .map(|sysroot| <span class="macro">format!</span>(<span class="string">"file:///{sysroot}/share/doc/rust/html/"</span>))
<a href=#552 id=552 data-nosnippet>552</a> .and_then(|it| Url::parse(<span class="kw-2">&amp;</span>it).ok());
<a href=#553 id=553 data-nosnippet>553</a> <span class="kw">let </span>krate = def.krate(db);
<a href=#554 id=554 data-nosnippet>554</a> <span class="kw">let </span>channel = krate
<a href=#555 id=555 data-nosnippet>555</a> .and_then(|krate| db.toolchain_channel(krate.into()))
<a href=#556 id=556 data-nosnippet>556</a> .unwrap_or(ReleaseChannel::Nightly)
<a href=#557 id=557 data-nosnippet>557</a> .as_str();
<a href=#558 id=558 data-nosnippet>558</a>
<a href=#559 id=559 data-nosnippet>559</a> <span class="comment">// special case base url of `BuiltinType` to core
<a href=#560 id=560 data-nosnippet>560</a> // https://github.com/rust-lang/rust-analyzer/issues/12250
<a href=#561 id=561 data-nosnippet>561</a> </span><span class="kw">if let </span>Definition::BuiltinType(..) = def {
<a href=#562 id=562 data-nosnippet>562</a> <span class="kw">let </span>web_link = Url::parse(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">"https://doc.rust-lang.org/{channel}/core/"</span>)).ok();
<a href=#563 id=563 data-nosnippet>563</a> <span class="kw">let </span>system_link = system_doc.and_then(|it| it.join(<span class="string">"core/"</span>).ok());
<a href=#564 id=564 data-nosnippet>564</a> <span class="kw">return </span>(web_link, system_link);
<a href=#565 id=565 data-nosnippet>565</a> };
<a href=#566 id=566 data-nosnippet>566</a>
<a href=#567 id=567 data-nosnippet>567</a> <span class="kw">let </span><span class="prelude-val">Some</span>(krate) = krate <span class="kw">else </span>{ <span class="kw">return </span>Default::default() };
<a href=#568 id=568 data-nosnippet>568</a> <span class="kw">let </span><span class="prelude-val">Some</span>(display_name) = krate.display_name(db) <span class="kw">else </span>{ <span class="kw">return </span>Default::default() };
<a href=#569 id=569 data-nosnippet>569</a> <span class="kw">let </span>(web_base, local_base) = <span class="kw">match </span>krate.origin(db) {
<a href=#570 id=570 data-nosnippet>570</a> <span class="comment">// std and co do not specify `html_root_url` any longer so we gotta handwrite this ourself.
<a href=#571 id=571 data-nosnippet>571</a> // FIXME: Use the toolchains channel instead of nightly
<a href=#572 id=572 data-nosnippet>572</a> </span>CrateOrigin::Lang(
<a href=#573 id=573 data-nosnippet>573</a> origin @ (LangCrateOrigin::Alloc
<a href=#574 id=574 data-nosnippet>574</a> | LangCrateOrigin::Core
<a href=#575 id=575 data-nosnippet>575</a> | LangCrateOrigin::ProcMacro
<a href=#576 id=576 data-nosnippet>576</a> | LangCrateOrigin::Std
<a href=#577 id=577 data-nosnippet>577</a> | LangCrateOrigin::Test),
<a href=#578 id=578 data-nosnippet>578</a> ) =&gt; {
<a href=#579 id=579 data-nosnippet>579</a> <span class="kw">let </span>system_url = system_doc.and_then(|it| it.join(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">"{origin}"</span>)).ok());
<a href=#580 id=580 data-nosnippet>580</a> <span class="kw">let </span>web_url = <span class="macro">format!</span>(<span class="string">"https://doc.rust-lang.org/{channel}/{origin}"</span>);
<a href=#581 id=581 data-nosnippet>581</a> (<span class="prelude-val">Some</span>(web_url), system_url)
<a href=#582 id=582 data-nosnippet>582</a> }
<a href=#583 id=583 data-nosnippet>583</a> CrateOrigin::Lang(<span class="kw">_</span>) =&gt; <span class="kw">return </span>(<span class="prelude-val">None</span>, <span class="prelude-val">None</span>),
<a href=#584 id=584 data-nosnippet>584</a> CrateOrigin::Rustc { name: <span class="kw">_ </span>} =&gt; {
<a href=#585 id=585 data-nosnippet>585</a> (<span class="prelude-val">Some</span>(<span class="macro">format!</span>(<span class="string">"https://doc.rust-lang.org/{channel}/nightly-rustc/"</span>)), <span class="prelude-val">None</span>)
<a href=#586 id=586 data-nosnippet>586</a> }
<a href=#587 id=587 data-nosnippet>587</a> CrateOrigin::Local { repo: <span class="kw">_</span>, name: <span class="kw">_ </span>} =&gt; {
<a href=#588 id=588 data-nosnippet>588</a> <span class="comment">// FIXME: These should not attempt to link to docs.rs!
<a href=#589 id=589 data-nosnippet>589</a> </span><span class="kw">let </span>weblink = krate.get_html_root_url(db).or_else(|| {
<a href=#590 id=590 data-nosnippet>590</a> <span class="kw">let </span>version = krate.version(db);
<a href=#591 id=591 data-nosnippet>591</a> <span class="comment">// Fallback to docs.rs. This uses `display_name` and can never be
<a href=#592 id=592 data-nosnippet>592</a> // correct, but that's what fallbacks are about.
<a href=#593 id=593 data-nosnippet>593</a> //
<a href=#594 id=594 data-nosnippet>594</a> // FIXME: clicking on the link should just open the file in the editor,
<a href=#595 id=595 data-nosnippet>595</a> // instead of falling back to external urls.
<a href=#596 id=596 data-nosnippet>596</a> </span><span class="prelude-val">Some</span>(<span class="macro">format!</span>(
<a href=#597 id=597 data-nosnippet>597</a> <span class="string">"https://docs.rs/{krate}/{version}/"</span>,
<a href=#598 id=598 data-nosnippet>598</a> krate = display_name,
<a href=#599 id=599 data-nosnippet>599</a> version = version.as_deref().unwrap_or(<span class="string">"*"</span>)
<a href=#600 id=600 data-nosnippet>600</a> ))
<a href=#601 id=601 data-nosnippet>601</a> });
<a href=#602 id=602 data-nosnippet>602</a> (weblink, local_doc)
<a href=#603 id=603 data-nosnippet>603</a> }
<a href=#604 id=604 data-nosnippet>604</a> CrateOrigin::Library { repo: <span class="kw">_</span>, name } =&gt; {
<a href=#605 id=605 data-nosnippet>605</a> <span class="kw">let </span>weblink = krate.get_html_root_url(db).or_else(|| {
<a href=#606 id=606 data-nosnippet>606</a> <span class="kw">let </span>version = krate.version(db);
<a href=#607 id=607 data-nosnippet>607</a> <span class="comment">// Fallback to docs.rs. This uses `display_name` and can never be
<a href=#608 id=608 data-nosnippet>608</a> // correct, but that's what fallbacks are about.
<a href=#609 id=609 data-nosnippet>609</a> //
<a href=#610 id=610 data-nosnippet>610</a> // FIXME: clicking on the link should just open the file in the editor,
<a href=#611 id=611 data-nosnippet>611</a> // instead of falling back to external urls.
<a href=#612 id=612 data-nosnippet>612</a> </span><span class="prelude-val">Some</span>(<span class="macro">format!</span>(
<a href=#613 id=613 data-nosnippet>613</a> <span class="string">"https://docs.rs/{krate}/{version}/"</span>,
<a href=#614 id=614 data-nosnippet>614</a> krate = name,
<a href=#615 id=615 data-nosnippet>615</a> version = version.as_deref().unwrap_or(<span class="string">"*"</span>)
<a href=#616 id=616 data-nosnippet>616</a> ))
<a href=#617 id=617 data-nosnippet>617</a> });
<a href=#618 id=618 data-nosnippet>618</a> (weblink, local_doc)
<a href=#619 id=619 data-nosnippet>619</a> }
<a href=#620 id=620 data-nosnippet>620</a> };
<a href=#621 id=621 data-nosnippet>621</a> <span class="kw">let </span>web_base = web_base
<a href=#622 id=622 data-nosnippet>622</a> .and_then(|it| Url::parse(<span class="kw-2">&amp;</span>it).ok())
<a href=#623 id=623 data-nosnippet>623</a> .and_then(|it| it.join(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">"{display_name}/"</span>)).ok());
<a href=#624 id=624 data-nosnippet>624</a> <span class="kw">let </span>local_base = local_base.and_then(|it| it.join(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">"{display_name}/"</span>)).ok());
<a href=#625 id=625 data-nosnippet>625</a>
<a href=#626 id=626 data-nosnippet>626</a> (web_base, local_base)
<a href=#627 id=627 data-nosnippet>627</a>}
<a href=#628 id=628 data-nosnippet>628</a>
<a href=#629 id=629 data-nosnippet>629</a><span class="doccomment">/// Get the filename and extension generated for a symbol by rustdoc.
<a href=#630 id=630 data-nosnippet>630</a>///
<a href=#631 id=631 data-nosnippet>631</a>/// ```ignore
<a href=#632 id=632 data-nosnippet>632</a>/// https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next
<a href=#633 id=633 data-nosnippet>633</a>/// ^^^^^^^^^^^^^^^^^^^
<a href=#634 id=634 data-nosnippet>634</a>/// ```
<a href=#635 id=635 data-nosnippet>635</a></span><span class="kw">fn </span>filename_and_frag_for_def(
<a href=#636 id=636 data-nosnippet>636</a> db: <span class="kw-2">&amp;</span><span class="kw">dyn </span>HirDatabase,
<a href=#637 id=637 data-nosnippet>637</a> def: Definition,
<a href=#638 id=638 data-nosnippet>638</a>) -&gt; <span class="prelude-ty">Option</span>&lt;(Definition, String, <span class="prelude-ty">Option</span>&lt;String&gt;)&gt; {
<a href=#639 id=639 data-nosnippet>639</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(assoc_item) = def.as_assoc_item(db) {
<a href=#640 id=640 data-nosnippet>640</a> <span class="kw">let </span>def = <span class="kw">match </span>assoc_item.container(db) {
<a href=#641 id=641 data-nosnippet>641</a> AssocItemContainer::Trait(t) =&gt; t.into(),
<a href=#642 id=642 data-nosnippet>642</a> AssocItemContainer::Impl(i) =&gt; i.self_ty(db).as_adt()<span class="question-mark">?</span>.into(),
<a href=#643 id=643 data-nosnippet>643</a> };
<a href=#644 id=644 data-nosnippet>644</a> <span class="kw">let </span>(<span class="kw">_</span>, file, <span class="kw">_</span>) = filename_and_frag_for_def(db, def)<span class="question-mark">?</span>;
<a href=#645 id=645 data-nosnippet>645</a> <span class="kw">let </span>frag = get_assoc_item_fragment(db, assoc_item)<span class="question-mark">?</span>;
<a href=#646 id=646 data-nosnippet>646</a> <span class="kw">return </span><span class="prelude-val">Some</span>((def, file, <span class="prelude-val">Some</span>(frag)));
<a href=#647 id=647 data-nosnippet>647</a> }
<a href=#648 id=648 data-nosnippet>648</a>
<a href=#649 id=649 data-nosnippet>649</a> <span class="kw">let </span>res = <span class="kw">match </span>def {
<a href=#650 id=650 data-nosnippet>650</a> Definition::Adt(adt) =&gt; <span class="kw">match </span>adt {
<a href=#651 id=651 data-nosnippet>651</a> Adt::Struct(s) =&gt; {
<a href=#652 id=652 data-nosnippet>652</a> <span class="macro">format!</span>(<span class="string">"struct.{}.html"</span>, s.name(db).as_str())
<a href=#653 id=653 data-nosnippet>653</a> }
<a href=#654 id=654 data-nosnippet>654</a> Adt::Enum(e) =&gt; <span class="macro">format!</span>(<span class="string">"enum.{}.html"</span>, e.name(db).as_str()),
<a href=#655 id=655 data-nosnippet>655</a> Adt::Union(u) =&gt; <span class="macro">format!</span>(<span class="string">"union.{}.html"</span>, u.name(db).as_str()),
<a href=#656 id=656 data-nosnippet>656</a> },
<a href=#657 id=657 data-nosnippet>657</a> Definition::Crate(<span class="kw">_</span>) =&gt; String::from(<span class="string">"index.html"</span>),
<a href=#658 id=658 data-nosnippet>658</a> Definition::Module(m) =&gt; <span class="kw">match </span>m.name(db) {
<a href=#659 id=659 data-nosnippet>659</a> <span class="comment">// `#[doc(keyword = "...")]` is internal used only by rust compiler
<a href=#660 id=660 data-nosnippet>660</a> </span><span class="prelude-val">Some</span>(name) =&gt; <span class="kw">match </span>m.doc_keyword(db) {
<a href=#661 id=661 data-nosnippet>661</a> <span class="prelude-val">Some</span>(kw) =&gt; {
<a href=#662 id=662 data-nosnippet>662</a> <span class="macro">format!</span>(<span class="string">"keyword.{kw}.html"</span>)
<a href=#663 id=663 data-nosnippet>663</a> }
<a href=#664 id=664 data-nosnippet>664</a> <span class="prelude-val">None </span>=&gt; <span class="macro">format!</span>(<span class="string">"{}/index.html"</span>, name.as_str()),
<a href=#665 id=665 data-nosnippet>665</a> },
<a href=#666 id=666 data-nosnippet>666</a> <span class="prelude-val">None </span>=&gt; String::from(<span class="string">"index.html"</span>),
<a href=#667 id=667 data-nosnippet>667</a> },
<a href=#668 id=668 data-nosnippet>668</a> Definition::Trait(t) =&gt; {
<a href=#669 id=669 data-nosnippet>669</a> <span class="comment">// FIXME(trait-alias): url should be traitalias. for aliases
<a href=#670 id=670 data-nosnippet>670</a> </span><span class="macro">format!</span>(<span class="string">"trait.{}.html"</span>, t.name(db).as_str())
<a href=#671 id=671 data-nosnippet>671</a> }
<a href=#672 id=672 data-nosnippet>672</a> Definition::TypeAlias(t) =&gt; {
<a href=#673 id=673 data-nosnippet>673</a> <span class="macro">format!</span>(<span class="string">"type.{}.html"</span>, t.name(db).as_str())
<a href=#674 id=674 data-nosnippet>674</a> }
<a href=#675 id=675 data-nosnippet>675</a> Definition::BuiltinType(t) =&gt; {
<a href=#676 id=676 data-nosnippet>676</a> <span class="macro">format!</span>(<span class="string">"primitive.{}.html"</span>, t.name().as_str())
<a href=#677 id=677 data-nosnippet>677</a> }
<a href=#678 id=678 data-nosnippet>678</a> Definition::Function(f) =&gt; {
<a href=#679 id=679 data-nosnippet>679</a> <span class="macro">format!</span>(<span class="string">"fn.{}.html"</span>, f.name(db).as_str())
<a href=#680 id=680 data-nosnippet>680</a> }
<a href=#681 id=681 data-nosnippet>681</a> Definition::Variant(ev) =&gt; {
<a href=#682 id=682 data-nosnippet>682</a> <span class="kw">let </span>def = Definition::Adt(ev.parent_enum(db).into());
<a href=#683 id=683 data-nosnippet>683</a> <span class="kw">let </span>(<span class="kw">_</span>, file, <span class="kw">_</span>) = filename_and_frag_for_def(db, def)<span class="question-mark">?</span>;
<a href=#684 id=684 data-nosnippet>684</a> <span class="kw">return </span><span class="prelude-val">Some</span>((def, file, <span class="prelude-val">Some</span>(<span class="macro">format!</span>(<span class="string">"variant.{}"</span>, ev.name(db).as_str()))));
<a href=#685 id=685 data-nosnippet>685</a> }
<a href=#686 id=686 data-nosnippet>686</a> Definition::Const(c) =&gt; {
<a href=#687 id=687 data-nosnippet>687</a> <span class="macro">format!</span>(<span class="string">"constant.{}.html"</span>, c.name(db)<span class="question-mark">?</span>.as_str())
<a href=#688 id=688 data-nosnippet>688</a> }
<a href=#689 id=689 data-nosnippet>689</a> Definition::Static(s) =&gt; {
<a href=#690 id=690 data-nosnippet>690</a> <span class="macro">format!</span>(<span class="string">"static.{}.html"</span>, s.name(db).as_str())
<a href=#691 id=691 data-nosnippet>691</a> }
<a href=#692 id=692 data-nosnippet>692</a> Definition::Macro(mac) =&gt; <span class="kw">match </span>mac.kind(db) {
<a href=#693 id=693 data-nosnippet>693</a> hir::MacroKind::Declarative
<a href=#694 id=694 data-nosnippet>694</a> | hir::MacroKind::AttrBuiltIn
<a href=#695 id=695 data-nosnippet>695</a> | hir::MacroKind::DeclarativeBuiltIn
<a href=#696 id=696 data-nosnippet>696</a> | hir::MacroKind::Attr
<a href=#697 id=697 data-nosnippet>697</a> | hir::MacroKind::ProcMacro =&gt; {
<a href=#698 id=698 data-nosnippet>698</a> <span class="macro">format!</span>(<span class="string">"macro.{}.html"</span>, mac.name(db).as_str())
<a href=#699 id=699 data-nosnippet>699</a> }
<a href=#700 id=700 data-nosnippet>700</a> hir::MacroKind::Derive | hir::MacroKind::DeriveBuiltIn =&gt; {
<a href=#701 id=701 data-nosnippet>701</a> <span class="macro">format!</span>(<span class="string">"derive.{}.html"</span>, mac.name(db).as_str())
<a href=#702 id=702 data-nosnippet>702</a> }
<a href=#703 id=703 data-nosnippet>703</a> },
<a href=#704 id=704 data-nosnippet>704</a> Definition::Field(field) =&gt; {
<a href=#705 id=705 data-nosnippet>705</a> <span class="kw">let </span>def = <span class="kw">match </span>field.parent_def(db) {
<a href=#706 id=706 data-nosnippet>706</a> hir::VariantDef::Struct(it) =&gt; Definition::Adt(it.into()),
<a href=#707 id=707 data-nosnippet>707</a> hir::VariantDef::Union(it) =&gt; Definition::Adt(it.into()),
<a href=#708 id=708 data-nosnippet>708</a> hir::VariantDef::Variant(it) =&gt; Definition::Variant(it),
<a href=#709 id=709 data-nosnippet>709</a> };
<a href=#710 id=710 data-nosnippet>710</a> <span class="kw">let </span>(<span class="kw">_</span>, file, <span class="kw">_</span>) = filename_and_frag_for_def(db, def)<span class="question-mark">?</span>;
<a href=#711 id=711 data-nosnippet>711</a> <span class="kw">return </span><span class="prelude-val">Some</span>((def, file, <span class="prelude-val">Some</span>(<span class="macro">format!</span>(<span class="string">"structfield.{}"</span>, field.name(db).as_str()))));
<a href=#712 id=712 data-nosnippet>712</a> }
<a href=#713 id=713 data-nosnippet>713</a> Definition::SelfType(impl_) =&gt; {
<a href=#714 id=714 data-nosnippet>714</a> <span class="kw">let </span>adt = impl_.self_ty(db).as_adt()<span class="question-mark">?</span>.into();
<a href=#715 id=715 data-nosnippet>715</a> <span class="kw">let </span>(<span class="kw">_</span>, file, <span class="kw">_</span>) = filename_and_frag_for_def(db, adt)<span class="question-mark">?</span>;
<a href=#716 id=716 data-nosnippet>716</a> <span class="comment">// FIXME fragment numbering
<a href=#717 id=717 data-nosnippet>717</a> </span><span class="kw">return </span><span class="prelude-val">Some</span>((adt, file, <span class="prelude-val">Some</span>(String::from(<span class="string">"impl"</span>))));
<a href=#718 id=718 data-nosnippet>718</a> }
<a href=#719 id=719 data-nosnippet>719</a> Definition::ExternCrateDecl(it) =&gt; {
<a href=#720 id=720 data-nosnippet>720</a> <span class="macro">format!</span>(<span class="string">"{}/index.html"</span>, it.name(db).as_str())
<a href=#721 id=721 data-nosnippet>721</a> }
<a href=#722 id=722 data-nosnippet>722</a> Definition::Local(<span class="kw">_</span>)
<a href=#723 id=723 data-nosnippet>723</a> | Definition::GenericParam(<span class="kw">_</span>)
<a href=#724 id=724 data-nosnippet>724</a> | Definition::TupleField(<span class="kw">_</span>)
<a href=#725 id=725 data-nosnippet>725</a> | Definition::Label(<span class="kw">_</span>)
<a href=#726 id=726 data-nosnippet>726</a> | Definition::BuiltinAttr(<span class="kw">_</span>)
<a href=#727 id=727 data-nosnippet>727</a> | Definition::BuiltinLifetime(<span class="kw">_</span>)
<a href=#728 id=728 data-nosnippet>728</a> | Definition::ToolModule(<span class="kw">_</span>)
<a href=#729 id=729 data-nosnippet>729</a> | Definition::DeriveHelper(<span class="kw">_</span>)
<a href=#730 id=730 data-nosnippet>730</a> | Definition::InlineAsmRegOrRegClass(<span class="kw">_</span>)
<a href=#731 id=731 data-nosnippet>731</a> | Definition::InlineAsmOperand(<span class="kw">_</span>) =&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
<a href=#732 id=732 data-nosnippet>732</a> };
<a href=#733 id=733 data-nosnippet>733</a>
<a href=#734 id=734 data-nosnippet>734</a> <span class="prelude-val">Some</span>((def, res, <span class="prelude-val">None</span>))
<a href=#735 id=735 data-nosnippet>735</a>}
<a href=#736 id=736 data-nosnippet>736</a>
<a href=#737 id=737 data-nosnippet>737</a><span class="doccomment">/// Get the fragment required to link to a specific field, method, associated type, or associated constant.
<a href=#738 id=738 data-nosnippet>738</a>///
<a href=#739 id=739 data-nosnippet>739</a>/// ```ignore
<a href=#740 id=740 data-nosnippet>740</a>/// https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next
<a href=#741 id=741 data-nosnippet>741</a>/// ^^^^^^^^^^^^^^
<a href=#742 id=742 data-nosnippet>742</a>/// ```
<a href=#743 id=743 data-nosnippet>743</a></span><span class="kw">fn </span>get_assoc_item_fragment(db: <span class="kw-2">&amp;</span><span class="kw">dyn </span>HirDatabase, assoc_item: hir::AssocItem) -&gt; <span class="prelude-ty">Option</span>&lt;String&gt; {
<a href=#744 id=744 data-nosnippet>744</a> <span class="prelude-val">Some</span>(<span class="kw">match </span>assoc_item {
<a href=#745 id=745 data-nosnippet>745</a> AssocItem::Function(function) =&gt; {
<a href=#746 id=746 data-nosnippet>746</a> <span class="kw">let </span>is_trait_method =
<a href=#747 id=747 data-nosnippet>747</a> function.as_assoc_item(db).and_then(|assoc| assoc.container_trait(db)).is_some();
<a href=#748 id=748 data-nosnippet>748</a> <span class="comment">// This distinction may get more complicated when specialization is available.
<a href=#749 id=749 data-nosnippet>749</a> // Rustdoc makes this decision based on whether a method 'has defaultness'.
<a href=#750 id=750 data-nosnippet>750</a> // Currently this is only the case for provided trait methods.
<a href=#751 id=751 data-nosnippet>751</a> </span><span class="kw">if </span>is_trait_method &amp;&amp; !function.has_body(db) {
<a href=#752 id=752 data-nosnippet>752</a> <span class="macro">format!</span>(<span class="string">"tymethod.{}"</span>, function.name(db).as_str())
<a href=#753 id=753 data-nosnippet>753</a> } <span class="kw">else </span>{
<a href=#754 id=754 data-nosnippet>754</a> <span class="macro">format!</span>(<span class="string">"method.{}"</span>, function.name(db).as_str())
<a href=#755 id=755 data-nosnippet>755</a> }
<a href=#756 id=756 data-nosnippet>756</a> }
<a href=#757 id=757 data-nosnippet>757</a> AssocItem::Const(constant) =&gt; {
<a href=#758 id=758 data-nosnippet>758</a> <span class="macro">format!</span>(<span class="string">"associatedconstant.{}"</span>, constant.name(db)<span class="question-mark">?</span>.as_str())
<a href=#759 id=759 data-nosnippet>759</a> }
<a href=#760 id=760 data-nosnippet>760</a> AssocItem::TypeAlias(ty) =&gt; {
<a href=#761 id=761 data-nosnippet>761</a> <span class="macro">format!</span>(<span class="string">"associatedtype.{}"</span>, ty.name(db).as_str())
<a href=#762 id=762 data-nosnippet>762</a> }
<a href=#763 id=763 data-nosnippet>763</a> })
<a href=#764 id=764 data-nosnippet>764</a>}
</code></pre></div></section></main></body></html>