| <!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/ptr.rs`."><title>ptr.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-84e720fa.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.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.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-fd3af306.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>ptr.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">//! In rust-analyzer, syntax trees are transient objects. |
| <a href=#2 id=2 data-nosnippet>2</a>//! |
| <a href=#3 id=3 data-nosnippet>3</a>//! That means that we create trees when we need them, and tear them down to |
| <a href=#4 id=4 data-nosnippet>4</a>//! save memory. In this architecture, hanging on to a particular syntax node |
| <a href=#5 id=5 data-nosnippet>5</a>//! for a long time is ill-advisable, as that keeps the whole tree resident. |
| <a href=#6 id=6 data-nosnippet>6</a>//! |
| <a href=#7 id=7 data-nosnippet>7</a>//! Instead, we provide a [`SyntaxNodePtr`] type, which stores information about |
| <a href=#8 id=8 data-nosnippet>8</a>//! *location* of a particular syntax node in a tree. Its a small type which can |
| <a href=#9 id=9 data-nosnippet>9</a>//! be cheaply stored, and which can be resolved to a real [`SyntaxNode`] when |
| <a href=#10 id=10 data-nosnippet>10</a>//! necessary. |
| <a href=#11 id=11 data-nosnippet>11</a> |
| <a href=#12 id=12 data-nosnippet>12</a></span><span class="kw">use </span>std::{ |
| <a href=#13 id=13 data-nosnippet>13</a> hash::{Hash, Hasher}, |
| <a href=#14 id=14 data-nosnippet>14</a> marker::PhantomData, |
| <a href=#15 id=15 data-nosnippet>15</a>}; |
| <a href=#16 id=16 data-nosnippet>16</a> |
| <a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>rowan::TextRange; |
| <a href=#18 id=18 data-nosnippet>18</a> |
| <a href=#19 id=19 data-nosnippet>19</a><span class="kw">use crate</span>::{AstNode, SyntaxNode, syntax_node::RustLanguage}; |
| <a href=#20 id=20 data-nosnippet>20</a> |
| <a href=#21 id=21 data-nosnippet>21</a><span class="doccomment">/// A "pointer" to a [`SyntaxNode`], via location in the source code. |
| <a href=#22 id=22 data-nosnippet>22</a></span><span class="kw">pub type </span>SyntaxNodePtr = rowan::ast::SyntaxNodePtr<RustLanguage>; |
| <a href=#23 id=23 data-nosnippet>23</a> |
| <a href=#24 id=24 data-nosnippet>24</a><span class="doccomment">/// Like `SyntaxNodePtr`, but remembers the type of node. |
| <a href=#25 id=25 data-nosnippet>25</a></span><span class="kw">pub struct </span>AstPtr<N: AstNode> { |
| <a href=#26 id=26 data-nosnippet>26</a> raw: SyntaxNodePtr, |
| <a href=#27 id=27 data-nosnippet>27</a> _ty: PhantomData<<span class="kw">fn</span>() -> N>, |
| <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">impl</span><N: AstNode> std::fmt::Debug <span class="kw">for </span>AstPtr<N> { |
| <a href=#31 id=31 data-nosnippet>31</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>std::fmt::Formatter<<span class="lifetime">'_</span>>) -> std::fmt::Result { |
| <a href=#32 id=32 data-nosnippet>32</a> f.debug_tuple(<span class="string">"AstPtr"</span>).field(<span class="kw-2">&</span><span class="self">self</span>.raw).finish() |
| <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> |
| <a href=#36 id=36 data-nosnippet>36</a><span class="kw">impl</span><N: AstNode> Copy <span class="kw">for </span>AstPtr<N> {} |
| <a href=#37 id=37 data-nosnippet>37</a><span class="kw">impl</span><N: AstNode> Clone <span class="kw">for </span>AstPtr<N> { |
| <a href=#38 id=38 data-nosnippet>38</a> <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> AstPtr<N> { |
| <a href=#39 id=39 data-nosnippet>39</a> <span class="kw-2">*</span><span class="self">self |
| <a href=#40 id=40 data-nosnippet>40</a> </span>} |
| <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><span class="kw">impl</span><N: AstNode> Eq <span class="kw">for </span>AstPtr<N> {} |
| <a href=#44 id=44 data-nosnippet>44</a> |
| <a href=#45 id=45 data-nosnippet>45</a><span class="kw">impl</span><N: AstNode> PartialEq <span class="kw">for </span>AstPtr<N> { |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>AstPtr<N>) -> bool { |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="self">self</span>.raw == other.raw |
| <a href=#48 id=48 data-nosnippet>48</a> } |
| <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><span class="kw">impl</span><N: AstNode> Hash <span class="kw">for </span>AstPtr<N> { |
| <a href=#52 id=52 data-nosnippet>52</a> <span class="kw">fn </span>hash<H: Hasher>(<span class="kw-2">&</span><span class="self">self</span>, state: <span class="kw-2">&mut </span>H) { |
| <a href=#53 id=53 data-nosnippet>53</a> <span class="self">self</span>.raw.hash(state); |
| <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> |
| <a href=#57 id=57 data-nosnippet>57</a><span class="kw">impl</span><N: AstNode> AstPtr<N> { |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="kw">pub fn </span>new(node: <span class="kw-2">&</span>N) -> AstPtr<N> { |
| <a href=#59 id=59 data-nosnippet>59</a> AstPtr { raw: SyntaxNodePtr::new(node.syntax()), _ty: PhantomData } |
| <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 fn </span>to_node(<span class="kw-2">&</span><span class="self">self</span>, root: <span class="kw-2">&</span>SyntaxNode) -> N { |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="kw">let </span>syntax_node = <span class="self">self</span>.raw.to_node(root); |
| <a href=#64 id=64 data-nosnippet>64</a> N::cast(syntax_node).unwrap() |
| <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">pub fn </span>syntax_node_ptr(<span class="kw-2">&</span><span class="self">self</span>) -> SyntaxNodePtr { |
| <a href=#68 id=68 data-nosnippet>68</a> <span class="self">self</span>.raw |
| <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> <span class="kw">pub fn </span>text_range(<span class="kw-2">&</span><span class="self">self</span>) -> TextRange { |
| <a href=#72 id=72 data-nosnippet>72</a> <span class="self">self</span>.raw.text_range() |
| <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="kw">pub fn </span>cast<U: AstNode>(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><AstPtr<U>> { |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="kw">if </span>!U::can_cast(<span class="self">self</span>.raw.kind()) { |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="kw">return </span><span class="prelude-val">None</span>; |
| <a href=#78 id=78 data-nosnippet>78</a> } |
| <a href=#79 id=79 data-nosnippet>79</a> <span class="prelude-val">Some</span>(AstPtr { raw: <span class="self">self</span>.raw, _ty: PhantomData }) |
| <a href=#80 id=80 data-nosnippet>80</a> } |
| <a href=#81 id=81 data-nosnippet>81</a> |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="kw">pub fn </span>kind(<span class="kw-2">&</span><span class="self">self</span>) -> parser::SyntaxKind { |
| <a href=#83 id=83 data-nosnippet>83</a> <span class="self">self</span>.raw.kind() |
| <a href=#84 id=84 data-nosnippet>84</a> } |
| <a href=#85 id=85 data-nosnippet>85</a> |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="kw">pub fn </span>upcast<M: AstNode>(<span class="self">self</span>) -> AstPtr<M> |
| <a href=#87 id=87 data-nosnippet>87</a> <span class="kw">where |
| <a href=#88 id=88 data-nosnippet>88</a> </span>N: Into<M>, |
| <a href=#89 id=89 data-nosnippet>89</a> { |
| <a href=#90 id=90 data-nosnippet>90</a> AstPtr { raw: <span class="self">self</span>.raw, _ty: PhantomData } |
| <a href=#91 id=91 data-nosnippet>91</a> } |
| <a href=#92 id=92 data-nosnippet>92</a> |
| <a href=#93 id=93 data-nosnippet>93</a> <span class="doccomment">/// Like `SyntaxNodePtr::cast` but the trait bounds work out. |
| <a href=#94 id=94 data-nosnippet>94</a> </span><span class="kw">pub fn </span>try_from_raw(raw: SyntaxNodePtr) -> <span class="prelude-ty">Option</span><AstPtr<N>> { |
| <a href=#95 id=95 data-nosnippet>95</a> N::can_cast(raw.kind()).then_some(AstPtr { raw, _ty: PhantomData }) |
| <a href=#96 id=96 data-nosnippet>96</a> } |
| <a href=#97 id=97 data-nosnippet>97</a> |
| <a href=#98 id=98 data-nosnippet>98</a> <span class="kw">pub fn </span>wrap_left<R>(<span class="self">self</span>) -> AstPtr<either::Either<N, R>> |
| <a href=#99 id=99 data-nosnippet>99</a> <span class="kw">where |
| <a href=#100 id=100 data-nosnippet>100</a> </span>either::Either<N, R>: AstNode, |
| <a href=#101 id=101 data-nosnippet>101</a> { |
| <a href=#102 id=102 data-nosnippet>102</a> AstPtr { raw: <span class="self">self</span>.raw, _ty: PhantomData } |
| <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">pub fn </span>wrap_right<L>(<span class="self">self</span>) -> AstPtr<either::Either<L, N>> |
| <a href=#106 id=106 data-nosnippet>106</a> <span class="kw">where |
| <a href=#107 id=107 data-nosnippet>107</a> </span>either::Either<L, N>: AstNode, |
| <a href=#108 id=108 data-nosnippet>108</a> { |
| <a href=#109 id=109 data-nosnippet>109</a> AstPtr { raw: <span class="self">self</span>.raw, _ty: PhantomData } |
| <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> |
| <a href=#113 id=113 data-nosnippet>113</a><span class="kw">impl</span><N: AstNode> From<AstPtr<N>> <span class="kw">for </span>SyntaxNodePtr { |
| <a href=#114 id=114 data-nosnippet>114</a> <span class="kw">fn </span>from(ptr: AstPtr<N>) -> SyntaxNodePtr { |
| <a href=#115 id=115 data-nosnippet>115</a> ptr.raw |
| <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> |
| <a href=#119 id=119 data-nosnippet>119</a><span class="attr">#[test] |
| <a href=#120 id=120 data-nosnippet>120</a></span><span class="kw">fn </span>test_local_syntax_ptr() { |
| <a href=#121 id=121 data-nosnippet>121</a> <span class="kw">use crate</span>::{AstNode, SourceFile, ast}; |
| <a href=#122 id=122 data-nosnippet>122</a> |
| <a href=#123 id=123 data-nosnippet>123</a> <span class="kw">let </span>file = SourceFile::parse(<span class="string">"struct Foo { f: u32, }"</span>, parser::Edition::CURRENT).ok().unwrap(); |
| <a href=#124 id=124 data-nosnippet>124</a> <span class="kw">let </span>field = file.syntax().descendants().find_map(ast::RecordField::cast).unwrap(); |
| <a href=#125 id=125 data-nosnippet>125</a> <span class="kw">let </span>ptr = SyntaxNodePtr::new(field.syntax()); |
| <a href=#126 id=126 data-nosnippet>126</a> <span class="kw">let </span>field_syntax = ptr.to_node(file.syntax()); |
| <a href=#127 id=127 data-nosnippet>127</a> <span class="macro">assert_eq!</span>(field.syntax(), <span class="kw-2">&</span>field_syntax); |
| <a href=#128 id=128 data-nosnippet>128</a>}</code></pre></div></section></main></body></html> |
