<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>editors/code/README.md - fork/rust-analyzer @ 2022-06-27</title>
<meta name="description" content="editors/code/README.md in fork/rust-analyzer at 2022-06-27.">
<meta property="og:title" content="editors/code/README.md - fork/rust-analyzer @ 2022-06-27">
<meta property="og:description" content="editors/code/README.md in fork/rust-analyzer at 2022-06-27.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="2022-06-27" data-tip="b74e96f509baf0be70281c55f14cb18fefbc6b22">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust-analyzer</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust-analyzer</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="ac4ce4259b906e7998695722b5af4cf2f261b250">Auto merge of #12242 - flodiebold:extension-description, r=flodiebold</span><span class="snapshot-sha sha" data-commit="ac4ce4259b906e7998695722b5af4cf2f261b250">ac4ce4259b</span><time datetime="2022-05-15T18:11:32+00:00" title="2022-05-15 18:11:32 +0000">2022-05-15</time></p>
<header class="topbar"><details class="switcher"><summary>2022-06-27</summary><div class="menu"><strong>branches</strong><a href="/fork/rust-analyzer/ref/master/">master</a><strong>tags</strong><a href="/fork/rust-analyzer/ref/2022-06-13/">2022-06-13</a><a href="/fork/rust-analyzer/ref/2022-06-20/">2022-06-20</a><a class="current" href="/fork/rust-analyzer/ref/2022-06-27/">2022-06-27</a><a href="/fork/rust-analyzer/ref/2022-07-04/">2022-07-04</a><a href="/fork/rust-analyzer/ref/2022-07-11/">2022-07-11</a><a href="/fork/rust-analyzer/ref/2022-07-18/">2022-07-18</a><a href="/fork/rust-analyzer/ref/2022-07-25/">2022-07-25</a><a href="/fork/rust-analyzer/ref/nightly/">nightly</a><a class="all" href="/fork/rust-analyzer/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust-analyzer/">rust-analyzer</a> / <a href="/fork/rust-analyzer/ref/2022-06-27/tree/editors/">editors</a> / <a href="/fork/rust-analyzer/ref/2022-06-27/tree/editors/code/">code</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>2.4 KiB</span><span>52 lines</span></span><span class="actions"><a class="raw" href="/fork/rust-analyzer/raw/36ab98188220ed247f8eae8814391db17c527a2f/editors/code/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>rust-analyzer</h1>
<p>This extension provides support for the <a href="https://www.rust-lang.org/">Rust programming language</a>.
It is recommended over and replaces <code>rust-lang.rust</code>.</p>
<h2>Features</h2>
<ul>
<li><a href="https://rust-analyzer.github.io/manual.html#magic-completions">code completion</a> with <a href="https://rust-analyzer.github.io/manual.html#completion-with-autoimport">imports insertion</a></li>
<li>go to <a href="https://rust-analyzer.github.io/manual.html#go-to-definition">definition</a>, <a href="https://rust-analyzer.github.io/manual.html#go-to-implementation">implementation</a>, <a href="https://rust-analyzer.github.io/manual.html#go-to-type-definition">type definition</a></li>
<li><a href="https://rust-analyzer.github.io/manual.html#find-all-references">find all references</a>, <a href="https://rust-analyzer.github.io/manual.html#workspace-symbol">workspace symbol search</a>, <a href="https://rust-analyzer.github.io/manual.html#rename">symbol renaming</a></li>
<li><a href="https://rust-analyzer.github.io/manual.html#hover">types and documentation on hover</a></li>
<li><a href="https://rust-analyzer.github.io/manual.html#inlay-hints">inlay hints</a> for types and parameter names</li>
<li><a href="https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting">semantic syntax highlighting</a></li>
<li>a lot of <a href="https://rust-analyzer.github.io/manual.html#assists-code-actions">assists (code actions)</a></li>
<li>apply suggestions from errors</li>
<li>... and many more, check out the <a href="https://rust-analyzer.github.io/manual.html">manual</a> to see them all</li>
</ul>
<h2>Quick start</h2>
<ol>
<li>Install <a href="https://rustup.rs">rustup</a>.</li>
<li>Install the <a href="https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer">rust-analyzer extension</a>.</li>
</ol>
<h2>Configuration</h2>
<p>This extension provides configurations through VSCode's configuration settings. All configurations are under <code>rust-analyzer.*</code>.</p>
<p>See <a href="https://rust-analyzer.github.io/manual.html#vs-code-2">the manual</a> for more information on VSCode specific configurations.</p>
<h2>Communication</h2>
<p>For usage and troubleshooting requests, please use the <a href="https://users.rust-lang.org/c/ide/14">"IDEs and Editors" category of the Rust forum</a>.</p>
<h2>Documentation</h2>
<p>See <a href="https://rust-analyzer.github.io/">rust-analyzer.github.io</a> for more information.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>rust-analyzer</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">This extension provides support for the [Rust programming language](https://www.rust-lang.org/).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">It is recommended over and replaces `rust-lang.rust`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>##</a-p> <a-tt>Features</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>- </a-p>[code completion] with [imports insertion]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>- </a-p>go to [definition], [implementation], [type definition]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>- </a-p>[find all references], [workspace symbol search], [symbol renaming]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>- </a-p>[types and documentation on hover]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>- </a-p>[inlay hints] for types and parameter names</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>- </a-p>[semantic syntax highlighting]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>- </a-p>a lot of [assists (code actions)]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>- </a-p>apply suggestions from errors</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>- </a-p>... and many more, check out the [manual] to see them all</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-tu>[code completion]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#magic-completions</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-tu>[imports insertion]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#completion-with-autoimport</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-tu>[definition]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#go-to-definition</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-tu>[implementation]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#go-to-implementation</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-tu>[type definition]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#go-to-type-definition</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-tu>[find all references]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#find-all-references</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-tu>[workspace symbol search]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#workspace-symbol</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-tu>[symbol renaming]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#rename</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-tu>[types and documentation on hover]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#hover</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-tu>[inlay hints]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#inlay-hints</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-tu>[semantic syntax highlighting]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-tu>[assists (code actions)]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html#assists-code-actions</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-tu>[manual]</a-tu><a-p>: </a-p><a-tu>https://rust-analyzer.github.io/manual.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>## </a-p><a-tt>Quick start</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>1. Install [rustup].</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>2. Install the [rust-analyzer extension].</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-tu>[rustup]</a-tu><a-p>: </a-p><a-tu>https://rustup.rs</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-tu>[rust-analyzer extension]</a-tu><a-p>: </a-p><a-tu>https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>## </a-p><a-tt>Configuration</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>This extension provides configurations through VSCode&#39;s configuration settings. All configurations are under `rust-analyzer.*`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>See [the manual](https://rust-analyzer.github.io/manual.html#vs-code-2) for more information on VSCode specific configurations.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>## </a-p><a-tt>Communication</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>For usage and troubleshooting requests, please use the [&quot;IDEs and Editors&quot; category of the Rust forum](https://users.rust-lang.org/c/ide/14).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>## </a-p><a-tt>Documentation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text">See [rust-analyzer.github.io](https://rust-analyzer.github.io/) for more information.</span></span></pre></div></div>
</main>
</body>
</html>
