| <!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/proc-macro-api/src/legacy_protocol.rs`."><title>legacy_protocol.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="proc_macro_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.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-ce535bd0.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">proc_macro_api/</div>legacy_protocol.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">//! The initial proc-macro-srv protocol, soon to be deprecated. |
| <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>json; |
| <a href=#4 id=4 data-nosnippet>4</a><span class="kw">pub mod </span>msg; |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">pub mod </span>postcard; |
| <a href=#6 id=6 data-nosnippet>6</a> |
| <a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>std::{ |
| <a href=#8 id=8 data-nosnippet>8</a> io::{BufRead, Write}, |
| <a href=#9 id=9 data-nosnippet>9</a> sync::Arc, |
| <a href=#10 id=10 data-nosnippet>10</a>}; |
| <a href=#11 id=11 data-nosnippet>11</a> |
| <a href=#12 id=12 data-nosnippet>12</a><span class="kw">use </span>paths::AbsPath; |
| <a href=#13 id=13 data-nosnippet>13</a><span class="kw">use </span>span::Span; |
| <a href=#14 id=14 data-nosnippet>14</a> |
| <a href=#15 id=15 data-nosnippet>15</a><span class="kw">use crate</span>::{ |
| <a href=#16 id=16 data-nosnippet>16</a> ProcMacro, ProcMacroKind, ServerError, |
| <a href=#17 id=17 data-nosnippet>17</a> codec::Codec, |
| <a href=#18 id=18 data-nosnippet>18</a> legacy_protocol::{ |
| <a href=#19 id=19 data-nosnippet>19</a> json::JsonProtocol, |
| <a href=#20 id=20 data-nosnippet>20</a> msg::{ |
| <a href=#21 id=21 data-nosnippet>21</a> ExpandMacro, ExpandMacroData, ExpnGlobals, FlatTree, Message, Request, Response, |
| <a href=#22 id=22 data-nosnippet>22</a> ServerConfig, SpanDataIndexMap, deserialize_span_data_index_map, |
| <a href=#23 id=23 data-nosnippet>23</a> flat::serialize_span_data_index_map, |
| <a href=#24 id=24 data-nosnippet>24</a> }, |
| <a href=#25 id=25 data-nosnippet>25</a> postcard::PostcardProtocol, |
| <a href=#26 id=26 data-nosnippet>26</a> }, |
| <a href=#27 id=27 data-nosnippet>27</a> process::ProcMacroServerProcess, |
| <a href=#28 id=28 data-nosnippet>28</a> version, |
| <a href=#29 id=29 data-nosnippet>29</a>}; |
| <a href=#30 id=30 data-nosnippet>30</a> |
| <a href=#31 id=31 data-nosnippet>31</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">crate</span>::legacy_protocol::msg::SpanMode; |
| <a href=#32 id=32 data-nosnippet>32</a> |
| <a href=#33 id=33 data-nosnippet>33</a><span class="doccomment">/// Legacy span type, only defined here as it is still used by the proc-macro server. |
| <a href=#34 id=34 data-nosnippet>34</a>/// While rust-analyzer doesn't use this anymore at all, RustRover relies on the legacy type for |
| <a href=#35 id=35 data-nosnippet>35</a>/// proc-macro expansion. |
| <a href=#36 id=36 data-nosnippet>36</a></span><span class="attr">#[derive(Clone, Copy, PartialEq, Eq, Hash)] |
| <a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub struct </span>SpanId(<span class="kw">pub </span>u32); |
| <a href=#38 id=38 data-nosnippet>38</a> |
| <a href=#39 id=39 data-nosnippet>39</a><span class="kw">impl </span>std::fmt::Debug <span class="kw">for </span>SpanId { |
| <a href=#40 id=40 data-nosnippet>40</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=#41 id=41 data-nosnippet>41</a> <span class="self">self</span>.<span class="number">0</span>.fmt(f) |
| <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> |
| <a href=#45 id=45 data-nosnippet>45</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>version_check(srv: <span class="kw-2">&</span>ProcMacroServerProcess) -> <span class="prelude-ty">Result</span><u32, ServerError> { |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span>request = Request::ApiVersionCheck {}; |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="kw">let </span>response = send_task(srv, request)<span class="question-mark">?</span>; |
| <a href=#48 id=48 data-nosnippet>48</a> |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="kw">match </span>response { |
| <a href=#50 id=50 data-nosnippet>50</a> Response::ApiVersionCheck(version) => <span class="prelude-val">Ok</span>(version), |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="kw">_ </span>=> <span class="prelude-val">Err</span>(ServerError { message: <span class="string">"unexpected response"</span>.to_owned(), io: <span class="prelude-val">None </span>}), |
| <a href=#52 id=52 data-nosnippet>52</a> } |
| <a href=#53 id=53 data-nosnippet>53</a>} |
| <a href=#54 id=54 data-nosnippet>54</a> |
| <a href=#55 id=55 data-nosnippet>55</a><span class="doccomment">/// Enable support for rust-analyzer span mode if the server supports it. |
| <a href=#56 id=56 data-nosnippet>56</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>enable_rust_analyzer_spans( |
| <a href=#57 id=57 data-nosnippet>57</a> srv: <span class="kw-2">&</span>ProcMacroServerProcess, |
| <a href=#58 id=58 data-nosnippet>58</a>) -> <span class="prelude-ty">Result</span><SpanMode, ServerError> { |
| <a href=#59 id=59 data-nosnippet>59</a> <span class="kw">let </span>request = Request::SetConfig(ServerConfig { span_mode: SpanMode::RustAnalyzer }); |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="kw">let </span>response = send_task(srv, request)<span class="question-mark">?</span>; |
| <a href=#61 id=61 data-nosnippet>61</a> |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="kw">match </span>response { |
| <a href=#63 id=63 data-nosnippet>63</a> Response::SetConfig(ServerConfig { span_mode }) => <span class="prelude-val">Ok</span>(span_mode), |
| <a href=#64 id=64 data-nosnippet>64</a> <span class="kw">_ </span>=> <span class="prelude-val">Err</span>(ServerError { message: <span class="string">"unexpected response"</span>.to_owned(), io: <span class="prelude-val">None </span>}), |
| <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> |
| <a href=#68 id=68 data-nosnippet>68</a><span class="doccomment">/// Finds proc-macros in a given dynamic library. |
| <a href=#69 id=69 data-nosnippet>69</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>find_proc_macros( |
| <a href=#70 id=70 data-nosnippet>70</a> srv: <span class="kw-2">&</span>ProcMacroServerProcess, |
| <a href=#71 id=71 data-nosnippet>71</a> dylib_path: <span class="kw-2">&</span>AbsPath, |
| <a href=#72 id=72 data-nosnippet>72</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Result</span><Vec<(String, ProcMacroKind)>, String>, ServerError> { |
| <a href=#73 id=73 data-nosnippet>73</a> <span class="kw">let </span>request = Request::ListMacros { dylib_path: dylib_path.to_path_buf().into() }; |
| <a href=#74 id=74 data-nosnippet>74</a> |
| <a href=#75 id=75 data-nosnippet>75</a> <span class="kw">let </span>response = send_task(srv, request)<span class="question-mark">?</span>; |
| <a href=#76 id=76 data-nosnippet>76</a> |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="kw">match </span>response { |
| <a href=#78 id=78 data-nosnippet>78</a> Response::ListMacros(it) => <span class="prelude-val">Ok</span>(it), |
| <a href=#79 id=79 data-nosnippet>79</a> <span class="kw">_ </span>=> <span class="prelude-val">Err</span>(ServerError { message: <span class="string">"unexpected response"</span>.to_owned(), io: <span class="prelude-val">None </span>}), |
| <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> |
| <a href=#83 id=83 data-nosnippet>83</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>expand( |
| <a href=#84 id=84 data-nosnippet>84</a> proc_macro: <span class="kw-2">&</span>ProcMacro, |
| <a href=#85 id=85 data-nosnippet>85</a> subtree: tt::SubtreeView<<span class="lifetime">'_</span>, Span>, |
| <a href=#86 id=86 data-nosnippet>86</a> attr: <span class="prelude-ty">Option</span><tt::SubtreeView<<span class="lifetime">'_</span>, Span>>, |
| <a href=#87 id=87 data-nosnippet>87</a> env: Vec<(String, String)>, |
| <a href=#88 id=88 data-nosnippet>88</a> def_site: Span, |
| <a href=#89 id=89 data-nosnippet>89</a> call_site: Span, |
| <a href=#90 id=90 data-nosnippet>90</a> mixed_site: Span, |
| <a href=#91 id=91 data-nosnippet>91</a> current_dir: String, |
| <a href=#92 id=92 data-nosnippet>92</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Result</span><tt::TopSubtree<span::SpanData<span::SyntaxContext>>, String>, <span class="kw">crate</span>::ServerError> |
| <a href=#93 id=93 data-nosnippet>93</a>{ |
| <a href=#94 id=94 data-nosnippet>94</a> <span class="kw">let </span>version = proc_macro.process.version(); |
| <a href=#95 id=95 data-nosnippet>95</a> <span class="kw">let </span><span class="kw-2">mut </span>span_data_table = SpanDataIndexMap::default(); |
| <a href=#96 id=96 data-nosnippet>96</a> <span class="kw">let </span>def_site = span_data_table.insert_full(def_site).<span class="number">0</span>; |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="kw">let </span>call_site = span_data_table.insert_full(call_site).<span class="number">0</span>; |
| <a href=#98 id=98 data-nosnippet>98</a> <span class="kw">let </span>mixed_site = span_data_table.insert_full(mixed_site).<span class="number">0</span>; |
| <a href=#99 id=99 data-nosnippet>99</a> <span class="kw">let </span>task = ExpandMacro { |
| <a href=#100 id=100 data-nosnippet>100</a> data: ExpandMacroData { |
| <a href=#101 id=101 data-nosnippet>101</a> macro_body: FlatTree::from_subtree(subtree, version, <span class="kw-2">&mut </span>span_data_table), |
| <a href=#102 id=102 data-nosnippet>102</a> macro_name: proc_macro.name.to_string(), |
| <a href=#103 id=103 data-nosnippet>103</a> attributes: attr |
| <a href=#104 id=104 data-nosnippet>104</a> .map(|subtree| FlatTree::from_subtree(subtree, version, <span class="kw-2">&mut </span>span_data_table)), |
| <a href=#105 id=105 data-nosnippet>105</a> has_global_spans: ExpnGlobals { |
| <a href=#106 id=106 data-nosnippet>106</a> serialize: version >= version::HAS_GLOBAL_SPANS, |
| <a href=#107 id=107 data-nosnippet>107</a> def_site, |
| <a href=#108 id=108 data-nosnippet>108</a> call_site, |
| <a href=#109 id=109 data-nosnippet>109</a> mixed_site, |
| <a href=#110 id=110 data-nosnippet>110</a> }, |
| <a href=#111 id=111 data-nosnippet>111</a> span_data_table: <span class="kw">if </span>proc_macro.process.rust_analyzer_spans() { |
| <a href=#112 id=112 data-nosnippet>112</a> serialize_span_data_index_map(<span class="kw-2">&</span>span_data_table) |
| <a href=#113 id=113 data-nosnippet>113</a> } <span class="kw">else </span>{ |
| <a href=#114 id=114 data-nosnippet>114</a> Vec::new() |
| <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> lib: proc_macro.dylib_path.to_path_buf().into(), |
| <a href=#118 id=118 data-nosnippet>118</a> env, |
| <a href=#119 id=119 data-nosnippet>119</a> current_dir: <span class="prelude-val">Some</span>(current_dir), |
| <a href=#120 id=120 data-nosnippet>120</a> }; |
| <a href=#121 id=121 data-nosnippet>121</a> |
| <a href=#122 id=122 data-nosnippet>122</a> <span class="kw">let </span>response = send_task(<span class="kw-2">&</span>proc_macro.process, Request::ExpandMacro(Box::new(task)))<span class="question-mark">?</span>; |
| <a href=#123 id=123 data-nosnippet>123</a> |
| <a href=#124 id=124 data-nosnippet>124</a> <span class="kw">match </span>response { |
| <a href=#125 id=125 data-nosnippet>125</a> Response::ExpandMacro(it) => <span class="prelude-val">Ok</span>(it |
| <a href=#126 id=126 data-nosnippet>126</a> .map(|tree| { |
| <a href=#127 id=127 data-nosnippet>127</a> <span class="kw">let </span><span class="kw-2">mut </span>expanded = FlatTree::to_subtree_resolved(tree, version, <span class="kw-2">&</span>span_data_table); |
| <a href=#128 id=128 data-nosnippet>128</a> <span class="kw">if </span>proc_macro.needs_fixup_change() { |
| <a href=#129 id=129 data-nosnippet>129</a> proc_macro.change_fixup_to_match_old_server(<span class="kw-2">&mut </span>expanded); |
| <a href=#130 id=130 data-nosnippet>130</a> } |
| <a href=#131 id=131 data-nosnippet>131</a> expanded |
| <a href=#132 id=132 data-nosnippet>132</a> }) |
| <a href=#133 id=133 data-nosnippet>133</a> .map_err(|msg| msg.<span class="number">0</span>)), |
| <a href=#134 id=134 data-nosnippet>134</a> Response::ExpandMacroExtended(it) => <span class="prelude-val">Ok</span>(it |
| <a href=#135 id=135 data-nosnippet>135</a> .map(|resp| { |
| <a href=#136 id=136 data-nosnippet>136</a> <span class="kw">let </span><span class="kw-2">mut </span>expanded = FlatTree::to_subtree_resolved( |
| <a href=#137 id=137 data-nosnippet>137</a> resp.tree, |
| <a href=#138 id=138 data-nosnippet>138</a> version, |
| <a href=#139 id=139 data-nosnippet>139</a> <span class="kw-2">&</span>deserialize_span_data_index_map(<span class="kw-2">&</span>resp.span_data_table), |
| <a href=#140 id=140 data-nosnippet>140</a> ); |
| <a href=#141 id=141 data-nosnippet>141</a> <span class="kw">if </span>proc_macro.needs_fixup_change() { |
| <a href=#142 id=142 data-nosnippet>142</a> proc_macro.change_fixup_to_match_old_server(<span class="kw-2">&mut </span>expanded); |
| <a href=#143 id=143 data-nosnippet>143</a> } |
| <a href=#144 id=144 data-nosnippet>144</a> expanded |
| <a href=#145 id=145 data-nosnippet>145</a> }) |
| <a href=#146 id=146 data-nosnippet>146</a> .map_err(|msg| msg.<span class="number">0</span>)), |
| <a href=#147 id=147 data-nosnippet>147</a> <span class="kw">_ </span>=> <span class="prelude-val">Err</span>(ServerError { message: <span class="string">"unexpected response"</span>.to_owned(), io: <span class="prelude-val">None </span>}), |
| <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><span class="doccomment">/// Sends a request to the proc-macro server and waits for a response. |
| <a href=#152 id=152 data-nosnippet>152</a></span><span class="kw">fn </span>send_task(srv: <span class="kw-2">&</span>ProcMacroServerProcess, req: Request) -> <span class="prelude-ty">Result</span><Response, ServerError> { |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(server_error) = srv.exited() { |
| <a href=#154 id=154 data-nosnippet>154</a> <span class="kw">return </span><span class="prelude-val">Err</span>(server_error.clone()); |
| <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">if </span>srv.use_postcard() { |
| <a href=#158 id=158 data-nosnippet>158</a> srv.send_task(send_request::<PostcardProtocol>, req) |
| <a href=#159 id=159 data-nosnippet>159</a> } <span class="kw">else </span>{ |
| <a href=#160 id=160 data-nosnippet>160</a> srv.send_task(send_request::<JsonProtocol>, req) |
| <a href=#161 id=161 data-nosnippet>161</a> } |
| <a href=#162 id=162 data-nosnippet>162</a>} |
| <a href=#163 id=163 data-nosnippet>163</a> |
| <a href=#164 id=164 data-nosnippet>164</a><span class="doccomment">/// Sends a request to the server and reads the response. |
| <a href=#165 id=165 data-nosnippet>165</a></span><span class="kw">fn </span>send_request<P: Codec>( |
| <a href=#166 id=166 data-nosnippet>166</a> <span class="kw-2">mut </span>writer: <span class="kw-2">&mut </span><span class="kw">dyn </span>Write, |
| <a href=#167 id=167 data-nosnippet>167</a> <span class="kw-2">mut </span>reader: <span class="kw-2">&mut </span><span class="kw">dyn </span>BufRead, |
| <a href=#168 id=168 data-nosnippet>168</a> req: Request, |
| <a href=#169 id=169 data-nosnippet>169</a> buf: <span class="kw-2">&mut </span>P::Buf, |
| <a href=#170 id=170 data-nosnippet>170</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><Response>, ServerError> { |
| <a href=#171 id=171 data-nosnippet>171</a> req.write::<<span class="kw">_</span>, P>(<span class="kw-2">&mut </span>writer).map_err(|err| ServerError { |
| <a href=#172 id=172 data-nosnippet>172</a> message: <span class="string">"failed to write request"</span>.into(), |
| <a href=#173 id=173 data-nosnippet>173</a> io: <span class="prelude-val">Some</span>(Arc::new(err)), |
| <a href=#174 id=174 data-nosnippet>174</a> })<span class="question-mark">?</span>; |
| <a href=#175 id=175 data-nosnippet>175</a> <span class="kw">let </span>res = Response::read::<<span class="kw">_</span>, P>(<span class="kw-2">&mut </span>reader, buf).map_err(|err| ServerError { |
| <a href=#176 id=176 data-nosnippet>176</a> message: <span class="string">"failed to read response"</span>.into(), |
| <a href=#177 id=177 data-nosnippet>177</a> io: <span class="prelude-val">Some</span>(Arc::new(err)), |
| <a href=#178 id=178 data-nosnippet>178</a> })<span class="question-mark">?</span>; |
| <a href=#179 id=179 data-nosnippet>179</a> <span class="prelude-val">Ok</span>(res) |
| <a href=#180 id=180 data-nosnippet>180</a>}</code></pre></div></section></main></body></html> |
