blob: 928c8adf3ff808395e5bce42d21b310f087fd139 [file] [log] [blame] [edit]
<!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/rust-analyzer/src/lib.rs`."><title>lib.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-77263533.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rust_analyzer" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.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-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-ffcac47a.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">rust_analyzer/</div>lib.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">//! Implementation of the LSP for rust-analyzer.
<a href=#2 id=2 data-nosnippet>2</a>//!
<a href=#3 id=3 data-nosnippet>3</a>//! This crate takes Rust-specific analysis results from ide and translates
<a href=#4 id=4 data-nosnippet>4</a>//! into LSP types.
<a href=#5 id=5 data-nosnippet>5</a>//!
<a href=#6 id=6 data-nosnippet>6</a>//! It also is the root of all state. `world` module defines the bulk of the
<a href=#7 id=7 data-nosnippet>7</a>//! state, and `main_loop` module defines the rules for modifying it.
<a href=#8 id=8 data-nosnippet>8</a>//!
<a href=#9 id=9 data-nosnippet>9</a>//! The `cli` submodule implements some batch-processing analysis, primarily as
<a href=#10 id=10 data-nosnippet>10</a>//! a debugging aid.
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a></span><span class="attr">#![cfg_attr(feature = <span class="string">"in-rust-tree"</span>, feature(rustc_private))]
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a>#[cfg(feature = <span class="string">"in-rust-tree"</span>)]
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">extern crate </span>rustc_driver <span class="kw">as _</span>;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">extern crate </span>ra_ap_rustc_type_ir <span class="kw">as </span>rustc_type_ir;
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="comment">/*
<a href=#20 id=20 data-nosnippet>20</a> If you bump this, grep for `FIXME(MINIMUM_SUPPORTED_TOOLCHAIN_VERSION)` to check for old support code we can drop
<a href=#21 id=21 data-nosnippet>21</a>*/
<a href=#22 id=22 data-nosnippet>22</a></span><span class="doccomment">/// Any toolchain less than this version will likely not work with rust-analyzer built from this revision.
<a href=#23 id=23 data-nosnippet>23</a></span><span class="kw">pub const </span>MINIMUM_SUPPORTED_TOOLCHAIN_VERSION: semver::Version = semver::Version {
<a href=#24 id=24 data-nosnippet>24</a> major: <span class="number">1</span>,
<a href=#25 id=25 data-nosnippet>25</a> minor: <span class="number">78</span>,
<a href=#26 id=26 data-nosnippet>26</a> patch: <span class="number">0</span>,
<a href=#27 id=27 data-nosnippet>27</a> pre: semver::Prerelease::EMPTY,
<a href=#28 id=28 data-nosnippet>28</a> build: semver::BuildMetadata::EMPTY,
<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 mod </span>cli;
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">mod </span>command;
<a href=#34 id=34 data-nosnippet>34</a><span class="kw">mod </span>diagnostics;
<a href=#35 id=35 data-nosnippet>35</a><span class="kw">mod </span>discover;
<a href=#36 id=36 data-nosnippet>36</a><span class="kw">mod </span>flycheck;
<a href=#37 id=37 data-nosnippet>37</a><span class="kw">mod </span>line_index;
<a href=#38 id=38 data-nosnippet>38</a><span class="kw">mod </span>main_loop;
<a href=#39 id=39 data-nosnippet>39</a><span class="kw">mod </span>mem_docs;
<a href=#40 id=40 data-nosnippet>40</a><span class="kw">mod </span>op_queue;
<a href=#41 id=41 data-nosnippet>41</a><span class="kw">mod </span>reload;
<a href=#42 id=42 data-nosnippet>42</a><span class="kw">mod </span>target_spec;
<a href=#43 id=43 data-nosnippet>43</a><span class="kw">mod </span>task_pool;
<a href=#44 id=44 data-nosnippet>44</a><span class="kw">mod </span>test_runner;
<a href=#45 id=45 data-nosnippet>45</a><span class="kw">mod </span>version;
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a><span class="kw">mod </span>handlers {
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>dispatch;
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>notification;
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>request;
<a href=#51 id=51 data-nosnippet>51</a>}
<a href=#52 id=52 data-nosnippet>52</a>
<a href=#53 id=53 data-nosnippet>53</a><span class="kw">pub mod </span>tracing {
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">pub mod </span>config;
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">pub mod </span>json;
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">pub use </span>config::Config;
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">pub mod </span>hprof;
<a href=#58 id=58 data-nosnippet>58</a>}
<a href=#59 id=59 data-nosnippet>59</a>
<a href=#60 id=60 data-nosnippet>60</a><span class="kw">pub mod </span>config;
<a href=#61 id=61 data-nosnippet>61</a><span class="kw">mod </span>global_state;
<a href=#62 id=62 data-nosnippet>62</a><span class="kw">pub mod </span>lsp;
<a href=#63 id=63 data-nosnippet>63</a><span class="kw">use </span><span class="self">self</span>::lsp::ext <span class="kw">as </span>lsp_ext;
<a href=#64 id=64 data-nosnippet>64</a>
<a href=#65 id=65 data-nosnippet>65</a><span class="attr">#[cfg(test)]
<a href=#66 id=66 data-nosnippet>66</a></span><span class="kw">mod </span>integrated_benchmarks;
<a href=#67 id=67 data-nosnippet>67</a>
<a href=#68 id=68 data-nosnippet>68</a><span class="kw">use </span>serde::de::DeserializeOwned;
<a href=#69 id=69 data-nosnippet>69</a>
<a href=#70 id=70 data-nosnippet>70</a><span class="kw">pub use </span>crate::{
<a href=#71 id=71 data-nosnippet>71</a> lsp::capabilities::server_capabilities, main_loop::main_loop, reload::ws_to_crate_graph,
<a href=#72 id=72 data-nosnippet>72</a> version::version,
<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>from_json&lt;T: DeserializeOwned&gt;(
<a href=#76 id=76 data-nosnippet>76</a> what: <span class="kw-2">&amp;</span><span class="lifetime">'static </span>str,
<a href=#77 id=77 data-nosnippet>77</a> json: <span class="kw-2">&amp;</span>serde_json::Value,
<a href=#78 id=78 data-nosnippet>78</a>) -&gt; anyhow::Result&lt;T&gt; {
<a href=#79 id=79 data-nosnippet>79</a> serde_json::from_value(json.clone())
<a href=#80 id=80 data-nosnippet>80</a> .map_err(|e| <span class="macro">anyhow::format_err!</span>(<span class="string">"Failed to deserialize {what}: {e}; {json}"</span>))
<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="attr">#[doc(hidden)]
<a href=#84 id=84 data-nosnippet>84</a></span><span class="macro">macro_rules!</span> try_default_ {
<a href=#85 id=85 data-nosnippet>85</a> (<span class="macro-nonterminal">$it</span>:expr $(,)<span class="question-mark">?</span>) =&gt; {
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">match </span><span class="macro-nonterminal">$it </span>{
<a href=#87 id=87 data-nosnippet>87</a> <span class="prelude-val">Some</span>(it) =&gt; it,
<a href=#88 id=88 data-nosnippet>88</a> <span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">Ok</span>(Default::default()),
<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="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>try_default_ <span class="kw">as </span>try_default;
<a href=#93 id=93 data-nosnippet>93</a>
<a href=#94 id=94 data-nosnippet>94</a><span class="attr">#[cfg(feature = <span class="string">"dhat"</span>)]
<a href=#95 id=95 data-nosnippet>95</a>#[global_allocator]
<a href=#96 id=96 data-nosnippet>96</a></span><span class="kw">static </span>ALLOC: dhat::Alloc = dhat::Alloc;
<a href=#97 id=97 data-nosnippet>97</a>
<a href=#98 id=98 data-nosnippet>98</a><span class="attr">#[cfg(feature = <span class="string">"dhat"</span>)]
<a href=#99 id=99 data-nosnippet>99</a></span><span class="kw">static </span>DHAT_PROFILER: std::sync::Mutex&lt;<span class="prelude-ty">Option</span>&lt;dhat::Profiler&gt;&gt; = std::sync::Mutex::new(<span class="prelude-val">None</span>);
</code></pre></div></section></main></body></html>