| <!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/child_modules.rs`."><title>child_modules.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>child_modules.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="kw">use </span>hir::Semantics; |
| <a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>ide_db::{FilePosition, RootDatabase}; |
| <a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>syntax::{ |
| <a href=#4 id=4 data-nosnippet>4</a> algo::find_node_at_offset, |
| <a href=#5 id=5 data-nosnippet>5</a> ast::{<span class="self">self</span>, AstNode}, |
| <a href=#6 id=6 data-nosnippet>6</a>}; |
| <a href=#7 id=7 data-nosnippet>7</a> |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span><span class="kw">crate</span>::NavigationTarget; |
| <a href=#9 id=9 data-nosnippet>9</a> |
| <a href=#10 id=10 data-nosnippet>10</a><span class="comment">// Feature: Child Modules |
| <a href=#11 id=11 data-nosnippet>11</a>// |
| <a href=#12 id=12 data-nosnippet>12</a>// Navigates to the child modules of the current module. |
| <a href=#13 id=13 data-nosnippet>13</a>// |
| <a href=#14 id=14 data-nosnippet>14</a>// | Editor | Action Name | |
| <a href=#15 id=15 data-nosnippet>15</a>// |---------|-------------| |
| <a href=#16 id=16 data-nosnippet>16</a>// | VS Code | **rust-analyzer: Locate child modules** | |
| <a href=#17 id=17 data-nosnippet>17</a> |
| <a href=#18 id=18 data-nosnippet>18</a></span><span class="doccomment">/// This returns `Vec` because a module may be included from several places. |
| <a href=#19 id=19 data-nosnippet>19</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>child_modules(db: <span class="kw-2">&</span>RootDatabase, position: FilePosition) -> Vec<NavigationTarget> { |
| <a href=#20 id=20 data-nosnippet>20</a> <span class="kw">let </span>sema = Semantics::new(db); |
| <a href=#21 id=21 data-nosnippet>21</a> <span class="kw">let </span>source_file = sema.parse_guess_edition(position.file_id); |
| <a href=#22 id=22 data-nosnippet>22</a> <span class="comment">// First go to the parent module which contains the cursor |
| <a href=#23 id=23 data-nosnippet>23</a> </span><span class="kw">let </span>module = find_node_at_offset::<ast::Module>(source_file.syntax(), position.offset); |
| <a href=#24 id=24 data-nosnippet>24</a> |
| <a href=#25 id=25 data-nosnippet>25</a> <span class="kw">match </span>module { |
| <a href=#26 id=26 data-nosnippet>26</a> <span class="prelude-val">Some</span>(module) => { |
| <a href=#27 id=27 data-nosnippet>27</a> <span class="comment">// Return all child modules inside the ItemList of the parent module |
| <a href=#28 id=28 data-nosnippet>28</a> </span>sema.to_def(<span class="kw-2">&</span>module) |
| <a href=#29 id=29 data-nosnippet>29</a> .into_iter() |
| <a href=#30 id=30 data-nosnippet>30</a> .flat_map(|module| module.children(db)) |
| <a href=#31 id=31 data-nosnippet>31</a> .map(|module| NavigationTarget::from_module_to_decl(db, module).call_site()) |
| <a href=#32 id=32 data-nosnippet>32</a> .collect() |
| <a href=#33 id=33 data-nosnippet>33</a> } |
| <a href=#34 id=34 data-nosnippet>34</a> <span class="prelude-val">None </span>=> { |
| <a href=#35 id=35 data-nosnippet>35</a> <span class="comment">// Return all the child modules inside the source file |
| <a href=#36 id=36 data-nosnippet>36</a> </span>sema.file_to_module_defs(position.file_id) |
| <a href=#37 id=37 data-nosnippet>37</a> .flat_map(|module| module.children(db)) |
| <a href=#38 id=38 data-nosnippet>38</a> .map(|module| NavigationTarget::from_module_to_decl(db, module).call_site()) |
| <a href=#39 id=39 data-nosnippet>39</a> .collect() |
| <a href=#40 id=40 data-nosnippet>40</a> } |
| <a href=#41 id=41 data-nosnippet>41</a> } |
| <a href=#42 id=42 data-nosnippet>42</a>} |
| <a href=#43 id=43 data-nosnippet>43</a> |
| <a href=#44 id=44 data-nosnippet>44</a><span class="attr">#[cfg(test)] |
| <a href=#45 id=45 data-nosnippet>45</a></span><span class="kw">mod </span>tests { |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">use </span>ide_db::FileRange; |
| <a href=#47 id=47 data-nosnippet>47</a> |
| <a href=#48 id=48 data-nosnippet>48</a> <span class="kw">use </span><span class="kw">crate</span>::fixture; |
| <a href=#49 id=49 data-nosnippet>49</a> |
| <a href=#50 id=50 data-nosnippet>50</a> <span class="kw">fn </span>check_child_module(<span class="attr">#[rust_analyzer::rust_fixture] </span>ra_fixture: <span class="kw-2">&</span>str) { |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="kw">let </span>(analysis, position, expected) = fixture::annotations(ra_fixture); |
| <a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>navs = analysis.child_modules(position).unwrap(); |
| <a href=#53 id=53 data-nosnippet>53</a> <span class="kw">let </span>navs = navs |
| <a href=#54 id=54 data-nosnippet>54</a> .iter() |
| <a href=#55 id=55 data-nosnippet>55</a> .map(|nav| FileRange { file_id: nav.file_id, range: nav.focus_or_full_range() }) |
| <a href=#56 id=56 data-nosnippet>56</a> .collect::<Vec<<span class="kw">_</span>>>(); |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="macro">assert_eq!</span>(expected.into_iter().map(|(fr, <span class="kw">_</span>)| fr).collect::<Vec<<span class="kw">_</span>>>(), navs); |
| <a href=#58 id=58 data-nosnippet>58</a> } |
| <a href=#59 id=59 data-nosnippet>59</a> |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="attr">#[test] |
| <a href=#61 id=61 data-nosnippet>61</a> </span><span class="kw">fn </span>test_resolve_child_module() { |
| <a href=#62 id=62 data-nosnippet>62</a> check_child_module( |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="string">r#" |
| <a href=#64 id=64 data-nosnippet>64</a>//- /lib.rs |
| <a href=#65 id=65 data-nosnippet>65</a>$0 |
| <a href=#66 id=66 data-nosnippet>66</a>mod foo; |
| <a href=#67 id=67 data-nosnippet>67</a> //^^^ |
| <a href=#68 id=68 data-nosnippet>68</a> |
| <a href=#69 id=69 data-nosnippet>69</a>//- /foo.rs |
| <a href=#70 id=70 data-nosnippet>70</a>// empty |
| <a href=#71 id=71 data-nosnippet>71</a>"#</span>, |
| <a href=#72 id=72 data-nosnippet>72</a> ); |
| <a href=#73 id=73 data-nosnippet>73</a> } |
| <a href=#74 id=74 data-nosnippet>74</a> |
| <a href=#75 id=75 data-nosnippet>75</a> <span class="attr">#[test] |
| <a href=#76 id=76 data-nosnippet>76</a> </span><span class="kw">fn </span>test_resolve_child_module_on_module_decl() { |
| <a href=#77 id=77 data-nosnippet>77</a> check_child_module( |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="string">r#" |
| <a href=#79 id=79 data-nosnippet>79</a>//- /lib.rs |
| <a href=#80 id=80 data-nosnippet>80</a>mod $0foo; |
| <a href=#81 id=81 data-nosnippet>81</a>//- /foo.rs |
| <a href=#82 id=82 data-nosnippet>82</a>mod bar; |
| <a href=#83 id=83 data-nosnippet>83</a> //^^^ |
| <a href=#84 id=84 data-nosnippet>84</a> |
| <a href=#85 id=85 data-nosnippet>85</a>//- /foo/bar.rs |
| <a href=#86 id=86 data-nosnippet>86</a>// empty |
| <a href=#87 id=87 data-nosnippet>87</a>"#</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> |
| <a href=#91 id=91 data-nosnippet>91</a> <span class="attr">#[test] |
| <a href=#92 id=92 data-nosnippet>92</a> </span><span class="kw">fn </span>test_resolve_child_module_for_inline() { |
| <a href=#93 id=93 data-nosnippet>93</a> check_child_module( |
| <a href=#94 id=94 data-nosnippet>94</a> <span class="string">r#" |
| <a href=#95 id=95 data-nosnippet>95</a>//- /lib.rs |
| <a href=#96 id=96 data-nosnippet>96</a>mod foo { |
| <a href=#97 id=97 data-nosnippet>97</a> mod $0bar { |
| <a href=#98 id=98 data-nosnippet>98</a> mod baz {} |
| <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>, |
| <a href=#102 id=102 data-nosnippet>102</a> ); |
| <a href=#103 id=103 data-nosnippet>103</a> } |
| <a href=#104 id=104 data-nosnippet>104</a> |
| <a href=#105 id=105 data-nosnippet>105</a> <span class="attr">#[test] |
| <a href=#106 id=106 data-nosnippet>106</a> </span><span class="kw">fn </span>test_resolve_multi_child_module() { |
| <a href=#107 id=107 data-nosnippet>107</a> check_child_module( |
| <a href=#108 id=108 data-nosnippet>108</a> <span class="string">r#" |
| <a href=#109 id=109 data-nosnippet>109</a>//- /main.rs |
| <a href=#110 id=110 data-nosnippet>110</a>$0 |
| <a href=#111 id=111 data-nosnippet>111</a>mod foo; |
| <a href=#112 id=112 data-nosnippet>112</a> //^^^ |
| <a href=#113 id=113 data-nosnippet>113</a>mod bar; |
| <a href=#114 id=114 data-nosnippet>114</a> //^^^ |
| <a href=#115 id=115 data-nosnippet>115</a>//- /foo.rs |
| <a href=#116 id=116 data-nosnippet>116</a>// empty |
| <a href=#117 id=117 data-nosnippet>117</a> |
| <a href=#118 id=118 data-nosnippet>118</a>//- /bar.rs |
| <a href=#119 id=119 data-nosnippet>119</a>// empty |
| <a href=#120 id=120 data-nosnippet>120</a>"#</span>, |
| <a href=#121 id=121 data-nosnippet>121</a> ); |
| <a href=#122 id=122 data-nosnippet>122</a> } |
| <a href=#123 id=123 data-nosnippet>123</a>} |
| </code></pre></div></section></main></body></html> |
