| <!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/intra_doc_links.rs`."><title>intra_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-e56847b5.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.91.1 (ed61e7d7e 2025-11-07)" data-channel="1.91.1" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.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-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.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/doc_links/</div>intra_doc_links.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Helper tools for intra doc links. |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">const </span>TYPES: (<span class="kw-2">&</span>[<span class="kw-2">&</span>str], <span class="kw-2">&</span>[<span class="kw-2">&</span>str]) = |
| <a href=#4 id=4 data-nosnippet>4</a> (<span class="kw-2">&</span>[<span class="string">"type"</span>, <span class="string">"struct"</span>, <span class="string">"enum"</span>, <span class="string">"mod"</span>, <span class="string">"trait"</span>, <span class="string">"union"</span>, <span class="string">"module"</span>, <span class="string">"prim"</span>, <span class="string">"primitive"</span>], <span class="kw-2">&</span>[]); |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">const </span>VALUES: (<span class="kw-2">&</span>[<span class="kw-2">&</span>str], <span class="kw-2">&</span>[<span class="kw-2">&</span>str]) = |
| <a href=#6 id=6 data-nosnippet>6</a> (<span class="kw-2">&</span>[<span class="string">"value"</span>, <span class="string">"function"</span>, <span class="string">"fn"</span>, <span class="string">"method"</span>, <span class="string">"const"</span>, <span class="string">"static"</span>, <span class="string">"mod"</span>, <span class="string">"module"</span>], <span class="kw-2">&</span>[<span class="string">"()"</span>]); |
| <a href=#7 id=7 data-nosnippet>7</a><span class="kw">const </span>MACROS: (<span class="kw-2">&</span>[<span class="kw-2">&</span>str], <span class="kw-2">&</span>[<span class="kw-2">&</span>str]) = (<span class="kw-2">&</span>[<span class="string">"macro"</span>, <span class="string">"derive"</span>], <span class="kw-2">&</span>[<span class="string">"!"</span>]); |
| <a href=#8 id=8 data-nosnippet>8</a> |
| <a href=#9 id=9 data-nosnippet>9</a><span class="doccomment">/// Extract the specified namespace from an intra-doc-link if one exists. |
| <a href=#10 id=10 data-nosnippet>10</a>/// |
| <a href=#11 id=11 data-nosnippet>11</a>/// # Examples |
| <a href=#12 id=12 data-nosnippet>12</a>/// |
| <a href=#13 id=13 data-nosnippet>13</a>/// * `struct MyStruct` -> ("MyStruct", `Namespace::Types`) |
| <a href=#14 id=14 data-nosnippet>14</a>/// * `panic!` -> ("panic", `Namespace::Macros`) |
| <a href=#15 id=15 data-nosnippet>15</a>/// * `fn@from_intra_spec` -> ("from_intra_spec", `Namespace::Values`) |
| <a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>parse_intra_doc_link(s: <span class="kw-2">&</span>str) -> (<span class="kw-2">&</span>str, <span class="prelude-ty">Option</span><hir::Namespace>) { |
| <a href=#17 id=17 data-nosnippet>17</a> <span class="kw">let </span>s = s.trim_matches(<span class="string">'`'</span>); |
| <a href=#18 id=18 data-nosnippet>18</a> |
| <a href=#19 id=19 data-nosnippet>19</a> [ |
| <a href=#20 id=20 data-nosnippet>20</a> (hir::Namespace::Types, TYPES), |
| <a href=#21 id=21 data-nosnippet>21</a> (hir::Namespace::Values, VALUES), |
| <a href=#22 id=22 data-nosnippet>22</a> (hir::Namespace::Macros, MACROS), |
| <a href=#23 id=23 data-nosnippet>23</a> ] |
| <a href=#24 id=24 data-nosnippet>24</a> .into_iter() |
| <a href=#25 id=25 data-nosnippet>25</a> .find_map(|(ns, (prefixes, suffixes))| { |
| <a href=#26 id=26 data-nosnippet>26</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(prefix) = prefixes.iter().find(|&&prefix| { |
| <a href=#27 id=27 data-nosnippet>27</a> s.starts_with(prefix) |
| <a href=#28 id=28 data-nosnippet>28</a> && s.chars().nth(prefix.len()).is_some_and(|c| c == <span class="string">'@' </span>|| c == <span class="string">' '</span>) |
| <a href=#29 id=29 data-nosnippet>29</a> }) { |
| <a href=#30 id=30 data-nosnippet>30</a> <span class="prelude-val">Some</span>((<span class="kw-2">&</span>s[prefix.len() + <span class="number">1</span>..], ns)) |
| <a href=#31 id=31 data-nosnippet>31</a> } <span class="kw">else </span>{ |
| <a href=#32 id=32 data-nosnippet>32</a> suffixes.iter().find_map(|<span class="kw-2">&</span>suffix| s.strip_suffix(suffix).zip(<span class="prelude-val">Some</span>(ns))) |
| <a href=#33 id=33 data-nosnippet>33</a> } |
| <a href=#34 id=34 data-nosnippet>34</a> }) |
| <a href=#35 id=35 data-nosnippet>35</a> .map_or((s, <span class="prelude-val">None</span>), |(s, ns)| (s, <span class="prelude-val">Some</span>(ns))) |
| <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="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>strip_prefixes_suffixes(s: <span class="kw-2">&</span>str) -> <span class="kw-2">&</span>str { |
| <a href=#39 id=39 data-nosnippet>39</a> [TYPES, VALUES, MACROS] |
| <a href=#40 id=40 data-nosnippet>40</a> .into_iter() |
| <a href=#41 id=41 data-nosnippet>41</a> .find_map(|(prefixes, suffixes)| { |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(prefix) = prefixes.iter().find(|&&prefix| { |
| <a href=#43 id=43 data-nosnippet>43</a> s.starts_with(prefix) |
| <a href=#44 id=44 data-nosnippet>44</a> && s.chars().nth(prefix.len()).is_some_and(|c| c == <span class="string">'@' </span>|| c == <span class="string">' '</span>) |
| <a href=#45 id=45 data-nosnippet>45</a> }) { |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="prelude-val">Some</span>(<span class="kw-2">&</span>s[prefix.len() + <span class="number">1</span>..]) |
| <a href=#47 id=47 data-nosnippet>47</a> } <span class="kw">else </span>{ |
| <a href=#48 id=48 data-nosnippet>48</a> suffixes.iter().find_map(|<span class="kw-2">&</span>suffix| s.strip_suffix(suffix)) |
| <a href=#49 id=49 data-nosnippet>49</a> } |
| <a href=#50 id=50 data-nosnippet>50</a> }) |
| <a href=#51 id=51 data-nosnippet>51</a> .unwrap_or(s) |
| <a href=#52 id=52 data-nosnippet>52</a>} |
| <a href=#53 id=53 data-nosnippet>53</a> |
| <a href=#54 id=54 data-nosnippet>54</a><span class="attr">#[cfg(test)] |
| <a href=#55 id=55 data-nosnippet>55</a></span><span class="kw">mod </span>tests { |
| <a href=#56 id=56 data-nosnippet>56</a> <span class="kw">use </span>expect_test::{Expect, expect}; |
| <a href=#57 id=57 data-nosnippet>57</a> |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| <a href=#59 id=59 data-nosnippet>59</a> |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="kw">fn </span>check(link: <span class="kw-2">&</span>str, expected: Expect) { |
| <a href=#61 id=61 data-nosnippet>61</a> <span class="kw">let </span>(l, a) = parse_intra_doc_link(link); |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="kw">let </span>a = a.map_or_else(String::new, |a| <span class="macro">format!</span>(<span class="string">" ({a:?})"</span>)); |
| <a href=#63 id=63 data-nosnippet>63</a> expected.assert_eq(<span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{l}{a}"</span>)); |
| <a href=#64 id=64 data-nosnippet>64</a> } |
| <a href=#65 id=65 data-nosnippet>65</a> |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="attr">#[test] |
| <a href=#67 id=67 data-nosnippet>67</a> </span><span class="kw">fn </span>test_name() { |
| <a href=#68 id=68 data-nosnippet>68</a> check(<span class="string">"foo"</span>, <span class="macro">expect!</span>[[<span class="string">r#"foo"#</span>]]); |
| <a href=#69 id=69 data-nosnippet>69</a> check(<span class="string">"struct Struct"</span>, <span class="macro">expect!</span>[[<span class="string">r#"Struct (Types)"#</span>]]); |
| <a href=#70 id=70 data-nosnippet>70</a> check(<span class="string">"makro!"</span>, <span class="macro">expect!</span>[[<span class="string">r#"makro (Macros)"#</span>]]); |
| <a href=#71 id=71 data-nosnippet>71</a> check(<span class="string">"fn@function"</span>, <span class="macro">expect!</span>[[<span class="string">r#"function (Values)"#</span>]]); |
| <a href=#72 id=72 data-nosnippet>72</a> } |
| <a href=#73 id=73 data-nosnippet>73</a>}</code></pre></div></section></main></body></html> |
