| <!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/traits.rs`."><title>traits.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-ca0dd0c4.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.93.0 (254b59607 2026-01-19)" data-channel="1.93.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.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-a410ff4d.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">syntax/ast/</div>traits.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">//! Various traits that are implemented by ast nodes. |
| <a href=#2 id=2 data-nosnippet>2</a>//! |
| <a href=#3 id=3 data-nosnippet>3</a>//! The implementations are usually trivial, and live in generated.rs |
| <a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">use </span>either::Either; |
| <a href=#5 id=5 data-nosnippet>5</a> |
| <a href=#6 id=6 data-nosnippet>6</a><span class="kw">use crate</span>::{ |
| <a href=#7 id=7 data-nosnippet>7</a> SyntaxElement, SyntaxNode, SyntaxToken, T, |
| <a href=#8 id=8 data-nosnippet>8</a> ast::{<span class="self">self</span>, AstChildren, AstNode, AstToken, support}, |
| <a href=#9 id=9 data-nosnippet>9</a> match_ast, |
| <a href=#10 id=10 data-nosnippet>10</a> syntax_node::SyntaxElementChildren, |
| <a href=#11 id=11 data-nosnippet>11</a>}; |
| <a href=#12 id=12 data-nosnippet>12</a> |
| <a href=#13 id=13 data-nosnippet>13</a><span class="kw">pub trait </span>HasName: AstNode { |
| <a href=#14 id=14 data-nosnippet>14</a> <span class="kw">fn </span>name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::Name> { |
| <a href=#15 id=15 data-nosnippet>15</a> support::child(<span class="self">self</span>.syntax()) |
| <a href=#16 id=16 data-nosnippet>16</a> } |
| <a href=#17 id=17 data-nosnippet>17</a>} |
| <a href=#18 id=18 data-nosnippet>18</a> |
| <a href=#19 id=19 data-nosnippet>19</a><span class="kw">pub trait </span>HasVisibility: AstNode { |
| <a href=#20 id=20 data-nosnippet>20</a> <span class="kw">fn </span>visibility(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::Visibility> { |
| <a href=#21 id=21 data-nosnippet>21</a> support::child(<span class="self">self</span>.syntax()) |
| <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> |
| <a href=#25 id=25 data-nosnippet>25</a><span class="kw">pub trait </span>HasLoopBody: AstNode { |
| <a href=#26 id=26 data-nosnippet>26</a> <span class="kw">fn </span>loop_body(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::BlockExpr> { |
| <a href=#27 id=27 data-nosnippet>27</a> support::child(<span class="self">self</span>.syntax()) |
| <a href=#28 id=28 data-nosnippet>28</a> } |
| <a href=#29 id=29 data-nosnippet>29</a> |
| <a href=#30 id=30 data-nosnippet>30</a> <span class="kw">fn </span>label(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::Label> { |
| <a href=#31 id=31 data-nosnippet>31</a> support::child(<span class="self">self</span>.syntax()) |
| <a href=#32 id=32 data-nosnippet>32</a> } |
| <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><span class="kw">pub trait </span>HasArgList: AstNode { |
| <a href=#36 id=36 data-nosnippet>36</a> <span class="kw">fn </span>arg_list(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::ArgList> { |
| <a href=#37 id=37 data-nosnippet>37</a> support::child(<span class="self">self</span>.syntax()) |
| <a href=#38 id=38 data-nosnippet>38</a> } |
| <a href=#39 id=39 data-nosnippet>39</a>} |
| <a href=#40 id=40 data-nosnippet>40</a> |
| <a href=#41 id=41 data-nosnippet>41</a><span class="kw">pub trait </span>HasModuleItem: AstNode { |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="kw">fn </span>items(<span class="kw-2">&</span><span class="self">self</span>) -> AstChildren<ast::Item> { |
| <a href=#43 id=43 data-nosnippet>43</a> support::children(<span class="self">self</span>.syntax()) |
| <a href=#44 id=44 data-nosnippet>44</a> } |
| <a href=#45 id=45 data-nosnippet>45</a>} |
| <a href=#46 id=46 data-nosnippet>46</a> |
| <a href=#47 id=47 data-nosnippet>47</a><span class="kw">pub trait </span>HasGenericParams: AstNode { |
| <a href=#48 id=48 data-nosnippet>48</a> <span class="kw">fn </span>generic_param_list(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::GenericParamList> { |
| <a href=#49 id=49 data-nosnippet>49</a> support::child(<span class="self">self</span>.syntax()) |
| <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>where_clause(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::WhereClause> { |
| <a href=#53 id=53 data-nosnippet>53</a> support::child(<span class="self">self</span>.syntax()) |
| <a href=#54 id=54 data-nosnippet>54</a> } |
| <a href=#55 id=55 data-nosnippet>55</a>} |
| <a href=#56 id=56 data-nosnippet>56</a><span class="kw">pub trait </span>HasGenericArgs: AstNode { |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="kw">fn </span>generic_arg_list(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::GenericArgList> { |
| <a href=#58 id=58 data-nosnippet>58</a> support::child(<span class="self">self</span>.syntax()) |
| <a href=#59 id=59 data-nosnippet>59</a> } |
| <a href=#60 id=60 data-nosnippet>60</a>} |
| <a href=#61 id=61 data-nosnippet>61</a> |
| <a href=#62 id=62 data-nosnippet>62</a><span class="kw">pub trait </span>HasTypeBounds: AstNode { |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="kw">fn </span>type_bound_list(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::TypeBoundList> { |
| <a href=#64 id=64 data-nosnippet>64</a> support::child(<span class="self">self</span>.syntax()) |
| <a href=#65 id=65 data-nosnippet>65</a> } |
| <a href=#66 id=66 data-nosnippet>66</a> |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="kw">fn </span>colon_token(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><SyntaxToken> { |
| <a href=#68 id=68 data-nosnippet>68</a> support::token(<span class="self">self</span>.syntax(), <span class="macro">T!</span>[:]) |
| <a href=#69 id=69 data-nosnippet>69</a> } |
| <a href=#70 id=70 data-nosnippet>70</a>} |
| <a href=#71 id=71 data-nosnippet>71</a> |
| <a href=#72 id=72 data-nosnippet>72</a><span class="kw">pub trait </span>HasAttrs: AstNode { |
| <a href=#73 id=73 data-nosnippet>73</a> <span class="kw">fn </span>attrs(<span class="kw-2">&</span><span class="self">self</span>) -> AstChildren<ast::Attr> { |
| <a href=#74 id=74 data-nosnippet>74</a> support::children(<span class="self">self</span>.syntax()) |
| <a href=#75 id=75 data-nosnippet>75</a> } |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="kw">fn </span>has_atom_attr(<span class="kw-2">&</span><span class="self">self</span>, atom: <span class="kw-2">&</span>str) -> bool { |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="self">self</span>.attrs().filter_map(|x| x.as_simple_atom()).any(|x| x == atom) |
| <a href=#78 id=78 data-nosnippet>78</a> } |
| <a href=#79 id=79 data-nosnippet>79</a> |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="doccomment">/// This may return the same node as called with (with `SourceFile`). The caller has the responsibility |
| <a href=#81 id=81 data-nosnippet>81</a> /// to avoid duplicate attributes. |
| <a href=#82 id=82 data-nosnippet>82</a> </span><span class="kw">fn </span>inner_attributes_node(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><SyntaxNode> { |
| <a href=#83 id=83 data-nosnippet>83</a> <span class="kw">let </span>syntax = <span class="self">self</span>.syntax(); |
| <a href=#84 id=84 data-nosnippet>84</a> <span class="prelude-val">Some</span>(<span class="macro">match_ast!</span> { |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="kw">match </span>syntax { |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="comment">// A `SourceFile` contains the inner attributes of itself. |
| <a href=#87 id=87 data-nosnippet>87</a> </span>ast::SourceFile(<span class="kw">_</span>) => syntax.clone(), |
| <a href=#88 id=88 data-nosnippet>88</a> ast::ExternBlock(it) => it.extern_item_list()<span class="question-mark">?</span>.syntax().clone(), |
| <a href=#89 id=89 data-nosnippet>89</a> ast::Fn(it) => it.body()<span class="question-mark">?</span>.stmt_list()<span class="question-mark">?</span>.syntax().clone(), |
| <a href=#90 id=90 data-nosnippet>90</a> ast::MatchExpr(it) => it.match_arm_list()<span class="question-mark">?</span>.syntax().clone(), |
| <a href=#91 id=91 data-nosnippet>91</a> ast::Impl(it) => it.assoc_item_list()<span class="question-mark">?</span>.syntax().clone(), |
| <a href=#92 id=92 data-nosnippet>92</a> ast::Trait(it) => it.assoc_item_list()<span class="question-mark">?</span>.syntax().clone(), |
| <a href=#93 id=93 data-nosnippet>93</a> ast::Module(it) => it.item_list()<span class="question-mark">?</span>.syntax().clone(), |
| <a href=#94 id=94 data-nosnippet>94</a> ast::BlockExpr(it) => { |
| <a href=#95 id=95 data-nosnippet>95</a> <span class="kw">if </span>!it.may_carry_attributes() { |
| <a href=#96 id=96 data-nosnippet>96</a> <span class="kw">return </span><span class="prelude-val">None</span>; |
| <a href=#97 id=97 data-nosnippet>97</a> } |
| <a href=#98 id=98 data-nosnippet>98</a> syntax.clone() |
| <a href=#99 id=99 data-nosnippet>99</a> }, |
| <a href=#100 id=100 data-nosnippet>100</a> <span class="kw">_ </span>=> <span class="kw">return </span><span class="prelude-val">None</span>, |
| <a href=#101 id=101 data-nosnippet>101</a> } |
| <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> |
| <a href=#106 id=106 data-nosnippet>106</a><span class="doccomment">/// Returns all attributes of this node, including inner attributes that may not be directly under this node |
| <a href=#107 id=107 data-nosnippet>107</a>/// but under a child. |
| <a href=#108 id=108 data-nosnippet>108</a></span><span class="kw">pub fn </span>attrs_including_inner(owner: <span class="kw-2">&</span><span class="kw">dyn </span>HasAttrs) -> <span class="kw">impl </span>Iterator<Item = ast::Attr> + Clone { |
| <a href=#109 id=109 data-nosnippet>109</a> owner.attrs().filter(|attr| attr.kind().is_outer()).chain( |
| <a href=#110 id=110 data-nosnippet>110</a> owner |
| <a href=#111 id=111 data-nosnippet>111</a> .inner_attributes_node() |
| <a href=#112 id=112 data-nosnippet>112</a> .into_iter() |
| <a href=#113 id=113 data-nosnippet>113</a> .flat_map(|node| support::children::<ast::Attr>(<span class="kw-2">&</span>node)) |
| <a href=#114 id=114 data-nosnippet>114</a> .filter(|attr| attr.kind().is_inner()), |
| <a href=#115 id=115 data-nosnippet>115</a> ) |
| <a href=#116 id=116 data-nosnippet>116</a>} |
| <a href=#117 id=117 data-nosnippet>117</a> |
| <a href=#118 id=118 data-nosnippet>118</a><span class="kw">pub trait </span>HasDocComments: HasAttrs { |
| <a href=#119 id=119 data-nosnippet>119</a> <span class="kw">fn </span>doc_comments(<span class="kw-2">&</span><span class="self">self</span>) -> DocCommentIter { |
| <a href=#120 id=120 data-nosnippet>120</a> DocCommentIter { iter: <span class="self">self</span>.syntax().children_with_tokens() } |
| <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> |
| <a href=#124 id=124 data-nosnippet>124</a><span class="kw">impl </span>DocCommentIter { |
| <a href=#125 id=125 data-nosnippet>125</a> <span class="kw">pub fn </span>from_syntax_node(syntax_node: <span class="kw-2">&</span>ast::SyntaxNode) -> DocCommentIter { |
| <a href=#126 id=126 data-nosnippet>126</a> DocCommentIter { iter: syntax_node.children_with_tokens() } |
| <a href=#127 id=127 data-nosnippet>127</a> } |
| <a href=#128 id=128 data-nosnippet>128</a> |
| <a href=#129 id=129 data-nosnippet>129</a> <span class="attr">#[cfg(test)] |
| <a href=#130 id=130 data-nosnippet>130</a> </span><span class="kw">pub fn </span>doc_comment_text(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><String> { |
| <a href=#131 id=131 data-nosnippet>131</a> <span class="kw">let </span>docs = itertools::Itertools::join( |
| <a href=#132 id=132 data-nosnippet>132</a> <span class="kw-2">&mut </span><span class="self">self</span>.filter_map(|comment| comment.doc_comment().map(|it| it.<span class="number">0</span>.to_owned())), |
| <a href=#133 id=133 data-nosnippet>133</a> <span class="string">"\n"</span>, |
| <a href=#134 id=134 data-nosnippet>134</a> ); |
| <a href=#135 id=135 data-nosnippet>135</a> <span class="kw">if </span>docs.is_empty() { <span class="prelude-val">None </span>} <span class="kw">else </span>{ <span class="prelude-val">Some</span>(docs) } |
| <a href=#136 id=136 data-nosnippet>136</a> } |
| <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><span class="kw">pub struct </span>DocCommentIter { |
| <a href=#140 id=140 data-nosnippet>140</a> iter: SyntaxElementChildren, |
| <a href=#141 id=141 data-nosnippet>141</a>} |
| <a href=#142 id=142 data-nosnippet>142</a> |
| <a href=#143 id=143 data-nosnippet>143</a><span class="kw">impl </span>Iterator <span class="kw">for </span>DocCommentIter { |
| <a href=#144 id=144 data-nosnippet>144</a> <span class="kw">type </span>Item = ast::Comment; |
| <a href=#145 id=145 data-nosnippet>145</a> <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><ast::Comment> { |
| <a href=#146 id=146 data-nosnippet>146</a> <span class="self">self</span>.iter.by_ref().find_map(|el| { |
| <a href=#147 id=147 data-nosnippet>147</a> el.into_token().and_then(ast::Comment::cast).filter(ast::Comment::is_doc) |
| <a href=#148 id=148 data-nosnippet>148</a> }) |
| <a href=#149 id=149 data-nosnippet>149</a> } |
| <a href=#150 id=150 data-nosnippet>150</a>} |
| <a href=#151 id=151 data-nosnippet>151</a> |
| <a href=#152 id=152 data-nosnippet>152</a><span class="kw">pub struct </span>AttrDocCommentIter { |
| <a href=#153 id=153 data-nosnippet>153</a> iter: SyntaxElementChildren, |
| <a href=#154 id=154 data-nosnippet>154</a>} |
| <a href=#155 id=155 data-nosnippet>155</a> |
| <a href=#156 id=156 data-nosnippet>156</a><span class="kw">impl </span>AttrDocCommentIter { |
| <a href=#157 id=157 data-nosnippet>157</a> <span class="kw">pub fn </span>from_syntax_node(syntax_node: <span class="kw-2">&</span>ast::SyntaxNode) -> AttrDocCommentIter { |
| <a href=#158 id=158 data-nosnippet>158</a> AttrDocCommentIter { iter: syntax_node.children_with_tokens() } |
| <a href=#159 id=159 data-nosnippet>159</a> } |
| <a href=#160 id=160 data-nosnippet>160</a>} |
| <a href=#161 id=161 data-nosnippet>161</a> |
| <a href=#162 id=162 data-nosnippet>162</a><span class="kw">impl </span>Iterator <span class="kw">for </span>AttrDocCommentIter { |
| <a href=#163 id=163 data-nosnippet>163</a> <span class="kw">type </span>Item = Either<ast::Attr, ast::Comment>; |
| <a href=#164 id=164 data-nosnippet>164</a> <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> { |
| <a href=#165 id=165 data-nosnippet>165</a> <span class="self">self</span>.iter.find_map(|el| <span class="kw">match </span>el { |
| <a href=#166 id=166 data-nosnippet>166</a> SyntaxElement::Node(node) => ast::Attr::cast(node).map(Either::Left), |
| <a href=#167 id=167 data-nosnippet>167</a> SyntaxElement::Token(tok) => { |
| <a href=#168 id=168 data-nosnippet>168</a> ast::Comment::cast(tok).filter(ast::Comment::is_doc).map(Either::Right) |
| <a href=#169 id=169 data-nosnippet>169</a> } |
| <a href=#170 id=170 data-nosnippet>170</a> }) |
| <a href=#171 id=171 data-nosnippet>171</a> } |
| <a href=#172 id=172 data-nosnippet>172</a>} |
| <a href=#173 id=173 data-nosnippet>173</a> |
| <a href=#174 id=174 data-nosnippet>174</a><span class="kw">impl</span><A: HasName, B: HasName> HasName <span class="kw">for </span>Either<A, B> {} |
| </code></pre></div></section></main></body></html> |
