| <!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/syntax/src/ast.rs`."><title>ast.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="syntax" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0 (1159e78c4 2025-09-14)" data-channel="1.90.0" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-68b7e25d.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">syntax/</div>ast.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">//! Abstract Syntax Tree, layered on top of untyped `SyntaxNode`s |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">pub mod </span>edit; |
| <a href=#4 id=4 data-nosnippet>4</a><span class="kw">pub mod </span>edit_in_place; |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">mod </span>expr_ext; |
| <a href=#6 id=6 data-nosnippet>6</a><span class="kw">mod </span>generated; |
| <a href=#7 id=7 data-nosnippet>7</a><span class="kw">pub mod </span>make; |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">mod </span>node_ext; |
| <a href=#9 id=9 data-nosnippet>9</a><span class="kw">mod </span>operators; |
| <a href=#10 id=10 data-nosnippet>10</a><span class="kw">pub mod </span>prec; |
| <a href=#11 id=11 data-nosnippet>11</a><span class="kw">pub mod </span>syntax_factory; |
| <a href=#12 id=12 data-nosnippet>12</a><span class="kw">mod </span>token_ext; |
| <a href=#13 id=13 data-nosnippet>13</a><span class="kw">mod </span>traits; |
| <a href=#14 id=14 data-nosnippet>14</a> |
| <a href=#15 id=15 data-nosnippet>15</a><span class="kw">use </span>std::marker::PhantomData; |
| <a href=#16 id=16 data-nosnippet>16</a> |
| <a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>either::Either; |
| <a href=#18 id=18 data-nosnippet>18</a> |
| <a href=#19 id=19 data-nosnippet>19</a><span class="kw">use crate</span>::{ |
| <a href=#20 id=20 data-nosnippet>20</a> SyntaxKind, |
| <a href=#21 id=21 data-nosnippet>21</a> syntax_node::{SyntaxNode, SyntaxNodeChildren, SyntaxToken}, |
| <a href=#22 id=22 data-nosnippet>22</a>}; |
| <a href=#23 id=23 data-nosnippet>23</a> |
| <a href=#24 id=24 data-nosnippet>24</a><span class="kw">pub use </span><span class="self">self</span>::{ |
| <a href=#25 id=25 data-nosnippet>25</a> expr_ext::{ArrayExprKind, BlockModifier, CallableExpr, ElseBranch, LiteralKind}, |
| <a href=#26 id=26 data-nosnippet>26</a> generated::{nodes::<span class="kw-2">*</span>, tokens::<span class="kw-2">*</span>}, |
| <a href=#27 id=27 data-nosnippet>27</a> node_ext::{ |
| <a href=#28 id=28 data-nosnippet>28</a> AttrKind, FieldKind, Macro, NameLike, NameOrNameRef, PathSegmentKind, SelfParamKind, |
| <a href=#29 id=29 data-nosnippet>29</a> SlicePatComponents, StructKind, TypeBoundKind, TypeOrConstParam, VisibilityKind, |
| <a href=#30 id=30 data-nosnippet>30</a> }, |
| <a href=#31 id=31 data-nosnippet>31</a> operators::{ArithOp, BinaryOp, CmpOp, LogicOp, Ordering, RangeOp, UnaryOp}, |
| <a href=#32 id=32 data-nosnippet>32</a> token_ext::{CommentKind, CommentPlacement, CommentShape, IsString, QuoteOffsets, Radix}, |
| <a href=#33 id=33 data-nosnippet>33</a> traits::{ |
| <a href=#34 id=34 data-nosnippet>34</a> AttrDocCommentIter, DocCommentIter, HasArgList, HasAttrs, HasDocComments, HasGenericArgs, |
| <a href=#35 id=35 data-nosnippet>35</a> HasGenericParams, HasLoopBody, HasModuleItem, HasName, HasTypeBounds, HasVisibility, |
| <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> |
| <a href=#39 id=39 data-nosnippet>39</a><span class="doccomment">/// The main trait to go from untyped `SyntaxNode` to a typed ast. The |
| <a href=#40 id=40 data-nosnippet>40</a>/// conversion itself has zero runtime cost: ast and syntax nodes have exactly |
| <a href=#41 id=41 data-nosnippet>41</a>/// the same representation: a pointer to the tree root and a pointer to the |
| <a href=#42 id=42 data-nosnippet>42</a>/// node itself. |
| <a href=#43 id=43 data-nosnippet>43</a></span><span class="kw">pub trait </span>AstNode { |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="doccomment">/// This panics if the `SyntaxKind` is not statically known. |
| <a href=#45 id=45 data-nosnippet>45</a> </span><span class="kw">fn </span>kind() -> SyntaxKind |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">where |
| <a href=#47 id=47 data-nosnippet>47</a> </span><span class="self">Self</span>: Sized, |
| <a href=#48 id=48 data-nosnippet>48</a> { |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="macro">panic!</span>(<span class="string">"dynamic `SyntaxKind` for `AstNode::kind()`"</span>) |
| <a href=#50 id=50 data-nosnippet>50</a> } |
| <a href=#51 id=51 data-nosnippet>51</a> |
| <a href=#52 id=52 data-nosnippet>52</a> <span class="kw">fn </span>can_cast(kind: SyntaxKind) -> bool |
| <a href=#53 id=53 data-nosnippet>53</a> <span class="kw">where |
| <a href=#54 id=54 data-nosnippet>54</a> </span><span class="self">Self</span>: Sized; |
| <a href=#55 id=55 data-nosnippet>55</a> |
| <a href=#56 id=56 data-nosnippet>56</a> <span class="kw">fn </span>cast(syntax: SyntaxNode) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>> |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="kw">where |
| <a href=#58 id=58 data-nosnippet>58</a> </span><span class="self">Self</span>: Sized; |
| <a href=#59 id=59 data-nosnippet>59</a> |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="kw">fn </span>syntax(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>SyntaxNode; |
| <a href=#61 id=61 data-nosnippet>61</a> <span class="kw">fn </span>clone_for_update(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self |
| <a href=#62 id=62 data-nosnippet>62</a> </span><span class="kw">where |
| <a href=#63 id=63 data-nosnippet>63</a> </span><span class="self">Self</span>: Sized, |
| <a href=#64 id=64 data-nosnippet>64</a> { |
| <a href=#65 id=65 data-nosnippet>65</a> <span class="self">Self</span>::cast(<span class="self">self</span>.syntax().clone_for_update()).unwrap() |
| <a href=#66 id=66 data-nosnippet>66</a> } |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="kw">fn </span>clone_subtree(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self |
| <a href=#68 id=68 data-nosnippet>68</a> </span><span class="kw">where |
| <a href=#69 id=69 data-nosnippet>69</a> </span><span class="self">Self</span>: Sized, |
| <a href=#70 id=70 data-nosnippet>70</a> { |
| <a href=#71 id=71 data-nosnippet>71</a> <span class="self">Self</span>::cast(<span class="self">self</span>.syntax().clone_subtree()).unwrap() |
| <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="doccomment">/// Like `AstNode`, but wraps tokens rather than interior nodes. |
| <a href=#76 id=76 data-nosnippet>76</a></span><span class="kw">pub trait </span>AstToken { |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="kw">fn </span>can_cast(token: SyntaxKind) -> bool |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="kw">where |
| <a href=#79 id=79 data-nosnippet>79</a> </span><span class="self">Self</span>: Sized; |
| <a href=#80 id=80 data-nosnippet>80</a> |
| <a href=#81 id=81 data-nosnippet>81</a> <span class="kw">fn </span>cast(syntax: SyntaxToken) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>> |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="kw">where |
| <a href=#83 id=83 data-nosnippet>83</a> </span><span class="self">Self</span>: Sized; |
| <a href=#84 id=84 data-nosnippet>84</a> |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="kw">fn </span>syntax(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>SyntaxToken; |
| <a href=#86 id=86 data-nosnippet>86</a> |
| <a href=#87 id=87 data-nosnippet>87</a> <span class="kw">fn </span>text(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <a href=#88 id=88 data-nosnippet>88</a> <span class="self">self</span>.syntax().text() |
| <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> |
| <a href=#92 id=92 data-nosnippet>92</a><span class="doccomment">/// An iterator over `SyntaxNode` children of a particular AST type. |
| <a href=#93 id=93 data-nosnippet>93</a></span><span class="attr">#[derive(Debug, Clone)] |
| <a href=#94 id=94 data-nosnippet>94</a></span><span class="kw">pub struct </span>AstChildren<N> { |
| <a href=#95 id=95 data-nosnippet>95</a> inner: SyntaxNodeChildren, |
| <a href=#96 id=96 data-nosnippet>96</a> ph: PhantomData<N>, |
| <a href=#97 id=97 data-nosnippet>97</a>} |
| <a href=#98 id=98 data-nosnippet>98</a> |
| <a href=#99 id=99 data-nosnippet>99</a><span class="kw">impl</span><N> AstChildren<N> { |
| <a href=#100 id=100 data-nosnippet>100</a> <span class="kw">fn </span>new(parent: <span class="kw-2">&</span>SyntaxNode) -> <span class="self">Self </span>{ |
| <a href=#101 id=101 data-nosnippet>101</a> AstChildren { inner: parent.children(), ph: PhantomData } |
| <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="kw">impl</span><N: AstNode> Iterator <span class="kw">for </span>AstChildren<N> { |
| <a href=#106 id=106 data-nosnippet>106</a> <span class="kw">type </span>Item = N; |
| <a href=#107 id=107 data-nosnippet>107</a> <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><N> { |
| <a href=#108 id=108 data-nosnippet>108</a> <span class="self">self</span>.inner.find_map(N::cast) |
| <a href=#109 id=109 data-nosnippet>109</a> } |
| <a href=#110 id=110 data-nosnippet>110</a>} |
| <a href=#111 id=111 data-nosnippet>111</a> |
| <a href=#112 id=112 data-nosnippet>112</a><span class="kw">impl</span><L, R> AstNode <span class="kw">for </span>Either<L, R> |
| <a href=#113 id=113 data-nosnippet>113</a><span class="kw">where |
| <a href=#114 id=114 data-nosnippet>114</a> </span>L: AstNode, |
| <a href=#115 id=115 data-nosnippet>115</a> R: AstNode, |
| <a href=#116 id=116 data-nosnippet>116</a>{ |
| <a href=#117 id=117 data-nosnippet>117</a> <span class="kw">fn </span>can_cast(kind: SyntaxKind) -> bool |
| <a href=#118 id=118 data-nosnippet>118</a> <span class="kw">where |
| <a href=#119 id=119 data-nosnippet>119</a> </span><span class="self">Self</span>: Sized, |
| <a href=#120 id=120 data-nosnippet>120</a> { |
| <a href=#121 id=121 data-nosnippet>121</a> L::can_cast(kind) || R::can_cast(kind) |
| <a href=#122 id=122 data-nosnippet>122</a> } |
| <a href=#123 id=123 data-nosnippet>123</a> |
| <a href=#124 id=124 data-nosnippet>124</a> <span class="kw">fn </span>cast(syntax: SyntaxNode) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>> |
| <a href=#125 id=125 data-nosnippet>125</a> <span class="kw">where |
| <a href=#126 id=126 data-nosnippet>126</a> </span><span class="self">Self</span>: Sized, |
| <a href=#127 id=127 data-nosnippet>127</a> { |
| <a href=#128 id=128 data-nosnippet>128</a> <span class="kw">if </span>L::can_cast(syntax.kind()) { |
| <a href=#129 id=129 data-nosnippet>129</a> L::cast(syntax).map(Either::Left) |
| <a href=#130 id=130 data-nosnippet>130</a> } <span class="kw">else </span>{ |
| <a href=#131 id=131 data-nosnippet>131</a> R::cast(syntax).map(Either::Right) |
| <a href=#132 id=132 data-nosnippet>132</a> } |
| <a href=#133 id=133 data-nosnippet>133</a> } |
| <a href=#134 id=134 data-nosnippet>134</a> |
| <a href=#135 id=135 data-nosnippet>135</a> <span class="kw">fn </span>syntax(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>SyntaxNode { |
| <a href=#136 id=136 data-nosnippet>136</a> <span class="self">self</span>.as_ref().either(L::syntax, R::syntax) |
| <a href=#137 id=137 data-nosnippet>137</a> } |
| <a href=#138 id=138 data-nosnippet>138</a>} |
| <a href=#139 id=139 data-nosnippet>139</a> |
| <a href=#140 id=140 data-nosnippet>140</a><span class="kw">impl</span><L, R> HasAttrs <span class="kw">for </span>Either<L, R> |
| <a href=#141 id=141 data-nosnippet>141</a><span class="kw">where |
| <a href=#142 id=142 data-nosnippet>142</a> </span>L: HasAttrs, |
| <a href=#143 id=143 data-nosnippet>143</a> R: HasAttrs, |
| <a href=#144 id=144 data-nosnippet>144</a>{ |
| <a href=#145 id=145 data-nosnippet>145</a>} |
| <a href=#146 id=146 data-nosnippet>146</a> |
| <a href=#147 id=147 data-nosnippet>147</a><span class="doccomment">/// Trait to describe operations common to both `RangeExpr` and `RangePat`. |
| <a href=#148 id=148 data-nosnippet>148</a></span><span class="kw">pub trait </span>RangeItem { |
| <a href=#149 id=149 data-nosnippet>149</a> <span class="kw">type </span>Bound; |
| <a href=#150 id=150 data-nosnippet>150</a> |
| <a href=#151 id=151 data-nosnippet>151</a> <span class="kw">fn </span>start(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Bound>; |
| <a href=#152 id=152 data-nosnippet>152</a> <span class="kw">fn </span>end(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Bound>; |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="kw">fn </span>op_kind(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><RangeOp>; |
| <a href=#154 id=154 data-nosnippet>154</a> <span class="kw">fn </span>op_token(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><SyntaxToken>; |
| <a href=#155 id=155 data-nosnippet>155</a>} |
| <a href=#156 id=156 data-nosnippet>156</a> |
| <a href=#157 id=157 data-nosnippet>157</a><span class="kw">mod </span>support { |
| <a href=#158 id=158 data-nosnippet>158</a> <span class="kw">use super</span>::{AstChildren, AstNode, SyntaxKind, SyntaxNode, SyntaxToken}; |
| <a href=#159 id=159 data-nosnippet>159</a> |
| <a href=#160 id=160 data-nosnippet>160</a> <span class="attr">#[inline] |
| <a href=#161 id=161 data-nosnippet>161</a> </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>child<N: AstNode>(parent: <span class="kw-2">&</span>SyntaxNode) -> <span class="prelude-ty">Option</span><N> { |
| <a href=#162 id=162 data-nosnippet>162</a> parent.children().find_map(N::cast) |
| <a href=#163 id=163 data-nosnippet>163</a> } |
| <a href=#164 id=164 data-nosnippet>164</a> |
| <a href=#165 id=165 data-nosnippet>165</a> <span class="attr">#[inline] |
| <a href=#166 id=166 data-nosnippet>166</a> </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>children<N: AstNode>(parent: <span class="kw-2">&</span>SyntaxNode) -> AstChildren<N> { |
| <a href=#167 id=167 data-nosnippet>167</a> AstChildren::new(parent) |
| <a href=#168 id=168 data-nosnippet>168</a> } |
| <a href=#169 id=169 data-nosnippet>169</a> |
| <a href=#170 id=170 data-nosnippet>170</a> <span class="attr">#[inline] |
| <a href=#171 id=171 data-nosnippet>171</a> </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>token(parent: <span class="kw-2">&</span>SyntaxNode, kind: SyntaxKind) -> <span class="prelude-ty">Option</span><SyntaxToken> { |
| <a href=#172 id=172 data-nosnippet>172</a> parent.children_with_tokens().filter_map(|it| it.into_token()).find(|it| it.kind() == kind) |
| <a href=#173 id=173 data-nosnippet>173</a> } |
| <a href=#174 id=174 data-nosnippet>174</a>} |
| <a href=#175 id=175 data-nosnippet>175</a> |
| <a href=#176 id=176 data-nosnippet>176</a><span class="attr">#[test] |
| <a href=#177 id=177 data-nosnippet>177</a></span><span class="kw">fn </span>assert_ast_is_dyn_compatible() { |
| <a href=#178 id=178 data-nosnippet>178</a> <span class="kw">fn </span>_f(<span class="kw">_</span>: <span class="kw-2">&</span><span class="kw">dyn </span>AstNode, <span class="kw">_</span>: <span class="kw-2">&</span><span class="kw">dyn </span>HasName) {} |
| <a href=#179 id=179 data-nosnippet>179</a>} |
| <a href=#180 id=180 data-nosnippet>180</a> |
| <a href=#181 id=181 data-nosnippet>181</a><span class="attr">#[test] |
| <a href=#182 id=182 data-nosnippet>182</a></span><span class="kw">fn </span>test_doc_comment_none() { |
| <a href=#183 id=183 data-nosnippet>183</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#184 id=184 data-nosnippet>184</a> <span class="string">r#" |
| <a href=#185 id=185 data-nosnippet>185</a> // non-doc |
| <a href=#186 id=186 data-nosnippet>186</a> mod foo {} |
| <a href=#187 id=187 data-nosnippet>187</a> "#</span>, |
| <a href=#188 id=188 data-nosnippet>188</a> parser::Edition::CURRENT, |
| <a href=#189 id=189 data-nosnippet>189</a> ) |
| <a href=#190 id=190 data-nosnippet>190</a> .ok() |
| <a href=#191 id=191 data-nosnippet>191</a> .unwrap(); |
| <a href=#192 id=192 data-nosnippet>192</a> <span class="kw">let </span>module = file.syntax().descendants().find_map(Module::cast).unwrap(); |
| <a href=#193 id=193 data-nosnippet>193</a> <span class="macro">assert!</span>(module.doc_comments().doc_comment_text().is_none()); |
| <a href=#194 id=194 data-nosnippet>194</a>} |
| <a href=#195 id=195 data-nosnippet>195</a> |
| <a href=#196 id=196 data-nosnippet>196</a><span class="attr">#[test] |
| <a href=#197 id=197 data-nosnippet>197</a></span><span class="kw">fn </span>test_outer_doc_comment_of_items() { |
| <a href=#198 id=198 data-nosnippet>198</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#199 id=199 data-nosnippet>199</a> <span class="string">r#" |
| <a href=#200 id=200 data-nosnippet>200</a> /// doc |
| <a href=#201 id=201 data-nosnippet>201</a> // non-doc |
| <a href=#202 id=202 data-nosnippet>202</a> mod foo {} |
| <a href=#203 id=203 data-nosnippet>203</a> "#</span>, |
| <a href=#204 id=204 data-nosnippet>204</a> parser::Edition::CURRENT, |
| <a href=#205 id=205 data-nosnippet>205</a> ) |
| <a href=#206 id=206 data-nosnippet>206</a> .ok() |
| <a href=#207 id=207 data-nosnippet>207</a> .unwrap(); |
| <a href=#208 id=208 data-nosnippet>208</a> <span class="kw">let </span>module = file.syntax().descendants().find_map(Module::cast).unwrap(); |
| <a href=#209 id=209 data-nosnippet>209</a> <span class="macro">assert_eq!</span>(<span class="string">" doc"</span>, module.doc_comments().doc_comment_text().unwrap()); |
| <a href=#210 id=210 data-nosnippet>210</a>} |
| <a href=#211 id=211 data-nosnippet>211</a> |
| <a href=#212 id=212 data-nosnippet>212</a><span class="attr">#[test] |
| <a href=#213 id=213 data-nosnippet>213</a></span><span class="kw">fn </span>test_inner_doc_comment_of_items() { |
| <a href=#214 id=214 data-nosnippet>214</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#215 id=215 data-nosnippet>215</a> <span class="string">r#" |
| <a href=#216 id=216 data-nosnippet>216</a> //! doc |
| <a href=#217 id=217 data-nosnippet>217</a> // non-doc |
| <a href=#218 id=218 data-nosnippet>218</a> mod foo {} |
| <a href=#219 id=219 data-nosnippet>219</a> "#</span>, |
| <a href=#220 id=220 data-nosnippet>220</a> parser::Edition::CURRENT, |
| <a href=#221 id=221 data-nosnippet>221</a> ) |
| <a href=#222 id=222 data-nosnippet>222</a> .ok() |
| <a href=#223 id=223 data-nosnippet>223</a> .unwrap(); |
| <a href=#224 id=224 data-nosnippet>224</a> <span class="kw">let </span>module = file.syntax().descendants().find_map(Module::cast).unwrap(); |
| <a href=#225 id=225 data-nosnippet>225</a> <span class="macro">assert!</span>(module.doc_comments().doc_comment_text().is_none()); |
| <a href=#226 id=226 data-nosnippet>226</a>} |
| <a href=#227 id=227 data-nosnippet>227</a> |
| <a href=#228 id=228 data-nosnippet>228</a><span class="attr">#[test] |
| <a href=#229 id=229 data-nosnippet>229</a></span><span class="kw">fn </span>test_doc_comment_of_statics() { |
| <a href=#230 id=230 data-nosnippet>230</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#231 id=231 data-nosnippet>231</a> <span class="string">r#" |
| <a href=#232 id=232 data-nosnippet>232</a> /// Number of levels |
| <a href=#233 id=233 data-nosnippet>233</a> static LEVELS: i32 = 0; |
| <a href=#234 id=234 data-nosnippet>234</a> "#</span>, |
| <a href=#235 id=235 data-nosnippet>235</a> parser::Edition::CURRENT, |
| <a href=#236 id=236 data-nosnippet>236</a> ) |
| <a href=#237 id=237 data-nosnippet>237</a> .ok() |
| <a href=#238 id=238 data-nosnippet>238</a> .unwrap(); |
| <a href=#239 id=239 data-nosnippet>239</a> <span class="kw">let </span>st = file.syntax().descendants().find_map(Static::cast).unwrap(); |
| <a href=#240 id=240 data-nosnippet>240</a> <span class="macro">assert_eq!</span>(<span class="string">" Number of levels"</span>, st.doc_comments().doc_comment_text().unwrap()); |
| <a href=#241 id=241 data-nosnippet>241</a>} |
| <a href=#242 id=242 data-nosnippet>242</a> |
| <a href=#243 id=243 data-nosnippet>243</a><span class="attr">#[test] |
| <a href=#244 id=244 data-nosnippet>244</a></span><span class="kw">fn </span>test_doc_comment_preserves_indents() { |
| <a href=#245 id=245 data-nosnippet>245</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#246 id=246 data-nosnippet>246</a> <span class="string">r#" |
| <a href=#247 id=247 data-nosnippet>247</a> /// doc1 |
| <a href=#248 id=248 data-nosnippet>248</a> /// ``` |
| <a href=#249 id=249 data-nosnippet>249</a> /// fn foo() { |
| <a href=#250 id=250 data-nosnippet>250</a> /// // ... |
| <a href=#251 id=251 data-nosnippet>251</a> /// } |
| <a href=#252 id=252 data-nosnippet>252</a> /// ``` |
| <a href=#253 id=253 data-nosnippet>253</a> mod foo {} |
| <a href=#254 id=254 data-nosnippet>254</a> "#</span>, |
| <a href=#255 id=255 data-nosnippet>255</a> parser::Edition::CURRENT, |
| <a href=#256 id=256 data-nosnippet>256</a> ) |
| <a href=#257 id=257 data-nosnippet>257</a> .ok() |
| <a href=#258 id=258 data-nosnippet>258</a> .unwrap(); |
| <a href=#259 id=259 data-nosnippet>259</a> <span class="kw">let </span>module = file.syntax().descendants().find_map(Module::cast).unwrap(); |
| <a href=#260 id=260 data-nosnippet>260</a> <span class="macro">assert_eq!</span>( |
| <a href=#261 id=261 data-nosnippet>261</a> <span class="string">" doc1\n ```\n fn foo() {\n // ...\n }\n ```"</span>, |
| <a href=#262 id=262 data-nosnippet>262</a> module.doc_comments().doc_comment_text().unwrap() |
| <a href=#263 id=263 data-nosnippet>263</a> ); |
| <a href=#264 id=264 data-nosnippet>264</a>} |
| <a href=#265 id=265 data-nosnippet>265</a> |
| <a href=#266 id=266 data-nosnippet>266</a><span class="attr">#[test] |
| <a href=#267 id=267 data-nosnippet>267</a></span><span class="kw">fn </span>test_doc_comment_preserves_newlines() { |
| <a href=#268 id=268 data-nosnippet>268</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#269 id=269 data-nosnippet>269</a> <span class="string">r#" |
| <a href=#270 id=270 data-nosnippet>270</a> /// this |
| <a href=#271 id=271 data-nosnippet>271</a> /// is |
| <a href=#272 id=272 data-nosnippet>272</a> /// mod |
| <a href=#273 id=273 data-nosnippet>273</a> /// foo |
| <a href=#274 id=274 data-nosnippet>274</a> mod foo {} |
| <a href=#275 id=275 data-nosnippet>275</a> "#</span>, |
| <a href=#276 id=276 data-nosnippet>276</a> parser::Edition::CURRENT, |
| <a href=#277 id=277 data-nosnippet>277</a> ) |
| <a href=#278 id=278 data-nosnippet>278</a> .ok() |
| <a href=#279 id=279 data-nosnippet>279</a> .unwrap(); |
| <a href=#280 id=280 data-nosnippet>280</a> <span class="kw">let </span>module = file.syntax().descendants().find_map(Module::cast).unwrap(); |
| <a href=#281 id=281 data-nosnippet>281</a> <span class="macro">assert_eq!</span>(<span class="string">" this\n is\n mod\n foo"</span>, module.doc_comments().doc_comment_text().unwrap()); |
| <a href=#282 id=282 data-nosnippet>282</a>} |
| <a href=#283 id=283 data-nosnippet>283</a> |
| <a href=#284 id=284 data-nosnippet>284</a><span class="attr">#[test] |
| <a href=#285 id=285 data-nosnippet>285</a></span><span class="kw">fn </span>test_doc_comment_single_line_block_strips_suffix() { |
| <a href=#286 id=286 data-nosnippet>286</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#287 id=287 data-nosnippet>287</a> <span class="string">r#" |
| <a href=#288 id=288 data-nosnippet>288</a> /** this is mod foo*/ |
| <a href=#289 id=289 data-nosnippet>289</a> mod foo {} |
| <a href=#290 id=290 data-nosnippet>290</a> "#</span>, |
| <a href=#291 id=291 data-nosnippet>291</a> parser::Edition::CURRENT, |
| <a href=#292 id=292 data-nosnippet>292</a> ) |
| <a href=#293 id=293 data-nosnippet>293</a> .ok() |
| <a href=#294 id=294 data-nosnippet>294</a> .unwrap(); |
| <a href=#295 id=295 data-nosnippet>295</a> <span class="kw">let </span>module = file.syntax().descendants().find_map(Module::cast).unwrap(); |
| <a href=#296 id=296 data-nosnippet>296</a> <span class="macro">assert_eq!</span>(<span class="string">" this is mod foo"</span>, module.doc_comments().doc_comment_text().unwrap()); |
| <a href=#297 id=297 data-nosnippet>297</a>} |
| <a href=#298 id=298 data-nosnippet>298</a> |
| <a href=#299 id=299 data-nosnippet>299</a><span class="attr">#[test] |
| <a href=#300 id=300 data-nosnippet>300</a></span><span class="kw">fn </span>test_doc_comment_single_line_block_strips_suffix_whitespace() { |
| <a href=#301 id=301 data-nosnippet>301</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#302 id=302 data-nosnippet>302</a> <span class="string">r#" |
| <a href=#303 id=303 data-nosnippet>303</a> /** this is mod foo */ |
| <a href=#304 id=304 data-nosnippet>304</a> mod foo {} |
| <a href=#305 id=305 data-nosnippet>305</a> "#</span>, |
| <a href=#306 id=306 data-nosnippet>306</a> parser::Edition::CURRENT, |
| <a href=#307 id=307 data-nosnippet>307</a> ) |
| <a href=#308 id=308 data-nosnippet>308</a> .ok() |
| <a href=#309 id=309 data-nosnippet>309</a> .unwrap(); |
| <a href=#310 id=310 data-nosnippet>310</a> <span class="kw">let </span>module = file.syntax().descendants().find_map(Module::cast).unwrap(); |
| <a href=#311 id=311 data-nosnippet>311</a> <span class="macro">assert_eq!</span>(<span class="string">" this is mod foo "</span>, module.doc_comments().doc_comment_text().unwrap()); |
| <a href=#312 id=312 data-nosnippet>312</a>} |
| <a href=#313 id=313 data-nosnippet>313</a> |
| <a href=#314 id=314 data-nosnippet>314</a><span class="attr">#[test] |
| <a href=#315 id=315 data-nosnippet>315</a></span><span class="kw">fn </span>test_doc_comment_multi_line_block_strips_suffix() { |
| <a href=#316 id=316 data-nosnippet>316</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#317 id=317 data-nosnippet>317</a> <span class="string">r#" |
| <a href=#318 id=318 data-nosnippet>318</a> /** |
| <a href=#319 id=319 data-nosnippet>319</a> this |
| <a href=#320 id=320 data-nosnippet>320</a> is |
| <a href=#321 id=321 data-nosnippet>321</a> mod foo |
| <a href=#322 id=322 data-nosnippet>322</a> */ |
| <a href=#323 id=323 data-nosnippet>323</a> mod foo {} |
| <a href=#324 id=324 data-nosnippet>324</a> "#</span>, |
| <a href=#325 id=325 data-nosnippet>325</a> parser::Edition::CURRENT, |
| <a href=#326 id=326 data-nosnippet>326</a> ) |
| <a href=#327 id=327 data-nosnippet>327</a> .ok() |
| <a href=#328 id=328 data-nosnippet>328</a> .unwrap(); |
| <a href=#329 id=329 data-nosnippet>329</a> <span class="kw">let </span>module = file.syntax().descendants().find_map(Module::cast).unwrap(); |
| <a href=#330 id=330 data-nosnippet>330</a> <span class="macro">assert_eq!</span>( |
| <a href=#331 id=331 data-nosnippet>331</a> <span class="string">"\n this\n is\n mod foo\n "</span>, |
| <a href=#332 id=332 data-nosnippet>332</a> module.doc_comments().doc_comment_text().unwrap() |
| <a href=#333 id=333 data-nosnippet>333</a> ); |
| <a href=#334 id=334 data-nosnippet>334</a>} |
| <a href=#335 id=335 data-nosnippet>335</a> |
| <a href=#336 id=336 data-nosnippet>336</a><span class="attr">#[test] |
| <a href=#337 id=337 data-nosnippet>337</a></span><span class="kw">fn </span>test_comments_preserve_trailing_whitespace() { |
| <a href=#338 id=338 data-nosnippet>338</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#339 id=339 data-nosnippet>339</a> <span class="string">"\n/// Representation of a Realm. \n/// In the specification these are called Realm Records.\nstruct Realm {}"</span>, parser::Edition::CURRENT, |
| <a href=#340 id=340 data-nosnippet>340</a> ) |
| <a href=#341 id=341 data-nosnippet>341</a> .ok() |
| <a href=#342 id=342 data-nosnippet>342</a> .unwrap(); |
| <a href=#343 id=343 data-nosnippet>343</a> <span class="kw">let </span>def = file.syntax().descendants().find_map(Struct::cast).unwrap(); |
| <a href=#344 id=344 data-nosnippet>344</a> <span class="macro">assert_eq!</span>( |
| <a href=#345 id=345 data-nosnippet>345</a> <span class="string">" Representation of a Realm. \n In the specification these are called Realm Records."</span>, |
| <a href=#346 id=346 data-nosnippet>346</a> def.doc_comments().doc_comment_text().unwrap() |
| <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> |
| <a href=#350 id=350 data-nosnippet>350</a><span class="attr">#[test] |
| <a href=#351 id=351 data-nosnippet>351</a></span><span class="kw">fn </span>test_four_slash_line_comment() { |
| <a href=#352 id=352 data-nosnippet>352</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#353 id=353 data-nosnippet>353</a> <span class="string">r#" |
| <a href=#354 id=354 data-nosnippet>354</a> //// too many slashes to be a doc comment |
| <a href=#355 id=355 data-nosnippet>355</a> /// doc comment |
| <a href=#356 id=356 data-nosnippet>356</a> mod foo {} |
| <a href=#357 id=357 data-nosnippet>357</a> "#</span>, |
| <a href=#358 id=358 data-nosnippet>358</a> parser::Edition::CURRENT, |
| <a href=#359 id=359 data-nosnippet>359</a> ) |
| <a href=#360 id=360 data-nosnippet>360</a> .ok() |
| <a href=#361 id=361 data-nosnippet>361</a> .unwrap(); |
| <a href=#362 id=362 data-nosnippet>362</a> <span class="kw">let </span>module = file.syntax().descendants().find_map(Module::cast).unwrap(); |
| <a href=#363 id=363 data-nosnippet>363</a> <span class="macro">assert_eq!</span>(<span class="string">" doc comment"</span>, module.doc_comments().doc_comment_text().unwrap()); |
| <a href=#364 id=364 data-nosnippet>364</a>} |
| <a href=#365 id=365 data-nosnippet>365</a> |
| <a href=#366 id=366 data-nosnippet>366</a><span class="attr">#[test] |
| <a href=#367 id=367 data-nosnippet>367</a></span><span class="kw">fn </span>test_where_predicates() { |
| <a href=#368 id=368 data-nosnippet>368</a> <span class="kw">fn </span>assert_bound(text: <span class="kw-2">&</span>str, bound: <span class="prelude-ty">Option</span><TypeBound>) { |
| <a href=#369 id=369 data-nosnippet>369</a> <span class="macro">assert_eq!</span>(text, bound.unwrap().syntax().text().to_string()); |
| <a href=#370 id=370 data-nosnippet>370</a> } |
| <a href=#371 id=371 data-nosnippet>371</a> |
| <a href=#372 id=372 data-nosnippet>372</a> <span class="kw">let </span>file = SourceFile::parse( |
| <a href=#373 id=373 data-nosnippet>373</a> <span class="string">r#" |
| <a href=#374 id=374 data-nosnippet>374</a>fn foo() |
| <a href=#375 id=375 data-nosnippet>375</a>where |
| <a href=#376 id=376 data-nosnippet>376</a> T: Clone + Copy + Debug + 'static, |
| <a href=#377 id=377 data-nosnippet>377</a> 'a: 'b + 'c, |
| <a href=#378 id=378 data-nosnippet>378</a> Iterator::Item: 'a + Debug, |
| <a href=#379 id=379 data-nosnippet>379</a> Iterator::Item: Debug + 'a, |
| <a href=#380 id=380 data-nosnippet>380</a> <T as Iterator>::Item: Debug + 'a, |
| <a href=#381 id=381 data-nosnippet>381</a> for<'a> F: Fn(&'a str) |
| <a href=#382 id=382 data-nosnippet>382</a>{} |
| <a href=#383 id=383 data-nosnippet>383</a> "#</span>, |
| <a href=#384 id=384 data-nosnippet>384</a> parser::Edition::CURRENT, |
| <a href=#385 id=385 data-nosnippet>385</a> ) |
| <a href=#386 id=386 data-nosnippet>386</a> .ok() |
| <a href=#387 id=387 data-nosnippet>387</a> .unwrap(); |
| <a href=#388 id=388 data-nosnippet>388</a> <span class="kw">let </span>where_clause = file.syntax().descendants().find_map(WhereClause::cast).unwrap(); |
| <a href=#389 id=389 data-nosnippet>389</a> |
| <a href=#390 id=390 data-nosnippet>390</a> <span class="kw">let </span><span class="kw-2">mut </span>predicates = where_clause.predicates(); |
| <a href=#391 id=391 data-nosnippet>391</a> |
| <a href=#392 id=392 data-nosnippet>392</a> <span class="kw">let </span>pred = predicates.next().unwrap(); |
| <a href=#393 id=393 data-nosnippet>393</a> <span class="kw">let </span><span class="kw-2">mut </span>bounds = pred.type_bound_list().unwrap().bounds(); |
| <a href=#394 id=394 data-nosnippet>394</a> |
| <a href=#395 id=395 data-nosnippet>395</a> <span class="macro">assert!</span>(pred.for_binder().is_none()); |
| <a href=#396 id=396 data-nosnippet>396</a> <span class="macro">assert_eq!</span>(<span class="string">"T"</span>, pred.ty().unwrap().syntax().text().to_string()); |
| <a href=#397 id=397 data-nosnippet>397</a> assert_bound(<span class="string">"Clone"</span>, bounds.next()); |
| <a href=#398 id=398 data-nosnippet>398</a> assert_bound(<span class="string">"Copy"</span>, bounds.next()); |
| <a href=#399 id=399 data-nosnippet>399</a> assert_bound(<span class="string">"Debug"</span>, bounds.next()); |
| <a href=#400 id=400 data-nosnippet>400</a> assert_bound(<span class="string">"'static"</span>, bounds.next()); |
| <a href=#401 id=401 data-nosnippet>401</a> |
| <a href=#402 id=402 data-nosnippet>402</a> <span class="kw">let </span>pred = predicates.next().unwrap(); |
| <a href=#403 id=403 data-nosnippet>403</a> <span class="kw">let </span><span class="kw-2">mut </span>bounds = pred.type_bound_list().unwrap().bounds(); |
| <a href=#404 id=404 data-nosnippet>404</a> |
| <a href=#405 id=405 data-nosnippet>405</a> <span class="macro">assert_eq!</span>(<span class="string">"'a"</span>, pred.lifetime().unwrap().lifetime_ident_token().unwrap().text()); |
| <a href=#406 id=406 data-nosnippet>406</a> |
| <a href=#407 id=407 data-nosnippet>407</a> assert_bound(<span class="string">"'b"</span>, bounds.next()); |
| <a href=#408 id=408 data-nosnippet>408</a> assert_bound(<span class="string">"'c"</span>, bounds.next()); |
| <a href=#409 id=409 data-nosnippet>409</a> |
| <a href=#410 id=410 data-nosnippet>410</a> <span class="kw">let </span>pred = predicates.next().unwrap(); |
| <a href=#411 id=411 data-nosnippet>411</a> <span class="kw">let </span><span class="kw-2">mut </span>bounds = pred.type_bound_list().unwrap().bounds(); |
| <a href=#412 id=412 data-nosnippet>412</a> |
| <a href=#413 id=413 data-nosnippet>413</a> <span class="macro">assert_eq!</span>(<span class="string">"Iterator::Item"</span>, pred.ty().unwrap().syntax().text().to_string()); |
| <a href=#414 id=414 data-nosnippet>414</a> assert_bound(<span class="string">"'a"</span>, bounds.next()); |
| <a href=#415 id=415 data-nosnippet>415</a> |
| <a href=#416 id=416 data-nosnippet>416</a> <span class="kw">let </span>pred = predicates.next().unwrap(); |
| <a href=#417 id=417 data-nosnippet>417</a> <span class="kw">let </span><span class="kw-2">mut </span>bounds = pred.type_bound_list().unwrap().bounds(); |
| <a href=#418 id=418 data-nosnippet>418</a> |
| <a href=#419 id=419 data-nosnippet>419</a> <span class="macro">assert_eq!</span>(<span class="string">"Iterator::Item"</span>, pred.ty().unwrap().syntax().text().to_string()); |
| <a href=#420 id=420 data-nosnippet>420</a> assert_bound(<span class="string">"Debug"</span>, bounds.next()); |
| <a href=#421 id=421 data-nosnippet>421</a> assert_bound(<span class="string">"'a"</span>, bounds.next()); |
| <a href=#422 id=422 data-nosnippet>422</a> |
| <a href=#423 id=423 data-nosnippet>423</a> <span class="kw">let </span>pred = predicates.next().unwrap(); |
| <a href=#424 id=424 data-nosnippet>424</a> <span class="kw">let </span><span class="kw-2">mut </span>bounds = pred.type_bound_list().unwrap().bounds(); |
| <a href=#425 id=425 data-nosnippet>425</a> |
| <a href=#426 id=426 data-nosnippet>426</a> <span class="macro">assert_eq!</span>(<span class="string">"<T as Iterator>::Item"</span>, pred.ty().unwrap().syntax().text().to_string()); |
| <a href=#427 id=427 data-nosnippet>427</a> assert_bound(<span class="string">"Debug"</span>, bounds.next()); |
| <a href=#428 id=428 data-nosnippet>428</a> assert_bound(<span class="string">"'a"</span>, bounds.next()); |
| <a href=#429 id=429 data-nosnippet>429</a> |
| <a href=#430 id=430 data-nosnippet>430</a> <span class="kw">let </span>pred = predicates.next().unwrap(); |
| <a href=#431 id=431 data-nosnippet>431</a> <span class="kw">let </span><span class="kw-2">mut </span>bounds = pred.type_bound_list().unwrap().bounds(); |
| <a href=#432 id=432 data-nosnippet>432</a> |
| <a href=#433 id=433 data-nosnippet>433</a> <span class="macro">assert_eq!</span>( |
| <a href=#434 id=434 data-nosnippet>434</a> <span class="string">"<'a>"</span>, |
| <a href=#435 id=435 data-nosnippet>435</a> pred.for_binder().unwrap().generic_param_list().unwrap().syntax().text().to_string() |
| <a href=#436 id=436 data-nosnippet>436</a> ); |
| <a href=#437 id=437 data-nosnippet>437</a> <span class="macro">assert_eq!</span>(<span class="string">"F"</span>, pred.ty().unwrap().syntax().text().to_string()); |
| <a href=#438 id=438 data-nosnippet>438</a> assert_bound(<span class="string">"Fn(&'a str)"</span>, bounds.next()); |
| <a href=#439 id=439 data-nosnippet>439</a>}</code></pre></div></section></main></body></html> |
