| <!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/syntax_node.rs`."><title>syntax_node.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.1 (01f6ddf75 2026-02-11)" data-channel="1.93.1" 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/</div>syntax_node.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">//! This module defines Concrete Syntax Tree (CST), used by rust-analyzer. |
| <a href=#2 id=2 data-nosnippet>2</a>//! |
| <a href=#3 id=3 data-nosnippet>3</a>//! The CST includes comments and whitespace, provides a single node type, |
| <a href=#4 id=4 data-nosnippet>4</a>//! `SyntaxNode`, and a basic traversal API (parent, children, siblings). |
| <a href=#5 id=5 data-nosnippet>5</a>//! |
| <a href=#6 id=6 data-nosnippet>6</a>//! The *real* implementation is in the (language-agnostic) `rowan` crate, this |
| <a href=#7 id=7 data-nosnippet>7</a>//! module just wraps its API. |
| <a href=#8 id=8 data-nosnippet>8</a> |
| <a href=#9 id=9 data-nosnippet>9</a></span><span class="kw">use </span>rowan::{GreenNodeBuilder, Language}; |
| <a href=#10 id=10 data-nosnippet>10</a> |
| <a href=#11 id=11 data-nosnippet>11</a><span class="kw">use crate</span>::{Parse, SyntaxError, SyntaxKind, TextSize}; |
| <a href=#12 id=12 data-nosnippet>12</a> |
| <a href=#13 id=13 data-nosnippet>13</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>rowan::{GreenNode, GreenToken, NodeOrToken}; |
| <a href=#14 id=14 data-nosnippet>14</a> |
| <a href=#15 id=15 data-nosnippet>15</a><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] |
| <a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">pub enum </span>RustLanguage {} |
| <a href=#17 id=17 data-nosnippet>17</a><span class="kw">impl </span>Language <span class="kw">for </span>RustLanguage { |
| <a href=#18 id=18 data-nosnippet>18</a> <span class="kw">type </span>Kind = SyntaxKind; |
| <a href=#19 id=19 data-nosnippet>19</a> |
| <a href=#20 id=20 data-nosnippet>20</a> <span class="kw">fn </span>kind_from_raw(raw: rowan::SyntaxKind) -> SyntaxKind { |
| <a href=#21 id=21 data-nosnippet>21</a> SyntaxKind::from(raw.<span class="number">0</span>) |
| <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">fn </span>kind_to_raw(kind: SyntaxKind) -> rowan::SyntaxKind { |
| <a href=#25 id=25 data-nosnippet>25</a> rowan::SyntaxKind(kind.into()) |
| <a href=#26 id=26 data-nosnippet>26</a> } |
| <a href=#27 id=27 data-nosnippet>27</a>} |
| <a href=#28 id=28 data-nosnippet>28</a> |
| <a href=#29 id=29 data-nosnippet>29</a><span class="kw">pub type </span>SyntaxNode = rowan::SyntaxNode<RustLanguage>; |
| <a href=#30 id=30 data-nosnippet>30</a><span class="kw">pub type </span>SyntaxToken = rowan::SyntaxToken<RustLanguage>; |
| <a href=#31 id=31 data-nosnippet>31</a><span class="kw">pub type </span>SyntaxElement = rowan::SyntaxElement<RustLanguage>; |
| <a href=#32 id=32 data-nosnippet>32</a><span class="kw">pub type </span>SyntaxNodeChildren = rowan::SyntaxNodeChildren<RustLanguage>; |
| <a href=#33 id=33 data-nosnippet>33</a><span class="kw">pub type </span>SyntaxElementChildren = rowan::SyntaxElementChildren<RustLanguage>; |
| <a href=#34 id=34 data-nosnippet>34</a><span class="kw">pub type </span>PreorderWithTokens = rowan::api::PreorderWithTokens<RustLanguage>; |
| <a href=#35 id=35 data-nosnippet>35</a> |
| <a href=#36 id=36 data-nosnippet>36</a><span class="attr">#[derive(Default)] |
| <a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub struct </span>SyntaxTreeBuilder { |
| <a href=#38 id=38 data-nosnippet>38</a> errors: Vec<SyntaxError>, |
| <a href=#39 id=39 data-nosnippet>39</a> inner: GreenNodeBuilder<<span class="lifetime">'static</span>>, |
| <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><span class="kw">impl </span>SyntaxTreeBuilder { |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>finish_raw(<span class="self">self</span>) -> (GreenNode, Vec<SyntaxError>) { |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="kw">let </span>green = <span class="self">self</span>.inner.finish(); |
| <a href=#45 id=45 data-nosnippet>45</a> (green, <span class="self">self</span>.errors) |
| <a href=#46 id=46 data-nosnippet>46</a> } |
| <a href=#47 id=47 data-nosnippet>47</a> |
| <a href=#48 id=48 data-nosnippet>48</a> <span class="kw">pub fn </span>finish(<span class="self">self</span>) -> Parse<SyntaxNode> { |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="kw">let </span>(green, errors) = <span class="self">self</span>.finish_raw(); |
| <a href=#50 id=50 data-nosnippet>50</a> <span class="comment">// Disable block validation, see https://github.com/rust-lang/rust-analyzer/pull/10357 |
| <a href=#51 id=51 data-nosnippet>51</a> </span><span class="attr">#[allow(clippy::overly_complex_bool_expr)] |
| <a href=#52 id=52 data-nosnippet>52</a> </span><span class="kw">if </span><span class="macro">cfg!</span>(debug_assertions) && <span class="bool-val">false </span>{ |
| <a href=#53 id=53 data-nosnippet>53</a> <span class="kw">let </span>node = SyntaxNode::new_root(green.clone()); |
| <a href=#54 id=54 data-nosnippet>54</a> <span class="kw">crate</span>::validation::validate_block_structure(<span class="kw-2">&</span>node); |
| <a href=#55 id=55 data-nosnippet>55</a> } |
| <a href=#56 id=56 data-nosnippet>56</a> Parse::new(green, errors) |
| <a href=#57 id=57 data-nosnippet>57</a> } |
| <a href=#58 id=58 data-nosnippet>58</a> |
| <a href=#59 id=59 data-nosnippet>59</a> <span class="kw">pub fn </span>token(<span class="kw-2">&mut </span><span class="self">self</span>, kind: SyntaxKind, text: <span class="kw-2">&</span>str) { |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="kw">let </span>kind = RustLanguage::kind_to_raw(kind); |
| <a href=#61 id=61 data-nosnippet>61</a> <span class="self">self</span>.inner.token(kind, text); |
| <a href=#62 id=62 data-nosnippet>62</a> } |
| <a href=#63 id=63 data-nosnippet>63</a> |
| <a href=#64 id=64 data-nosnippet>64</a> <span class="kw">pub fn </span>start_node(<span class="kw-2">&mut </span><span class="self">self</span>, kind: SyntaxKind) { |
| <a href=#65 id=65 data-nosnippet>65</a> <span class="kw">let </span>kind = RustLanguage::kind_to_raw(kind); |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="self">self</span>.inner.start_node(kind); |
| <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> <span class="kw">pub fn </span>finish_node(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#70 id=70 data-nosnippet>70</a> <span class="self">self</span>.inner.finish_node(); |
| <a href=#71 id=71 data-nosnippet>71</a> } |
| <a href=#72 id=72 data-nosnippet>72</a> |
| <a href=#73 id=73 data-nosnippet>73</a> <span class="kw">pub fn </span>error(<span class="kw-2">&mut </span><span class="self">self</span>, error: String, text_pos: TextSize) { |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="self">self</span>.errors.push(SyntaxError::new_at_offset(error, text_pos)); |
| <a href=#75 id=75 data-nosnippet>75</a> } |
| <a href=#76 id=76 data-nosnippet>76</a>} |
| </code></pre></div></section></main></body></html> |
