6 :source-highlighter: rouge
10 IMPORTANT: the master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository
13 At its core, rust-analyzer is a *library* for semantic analysis of Rust code as it changes over time.
14 This manual focuses on a specific usage of the library -- running it as part of a server that implements the
15 https://microsoft.github.io/language-server-protocol/[Language Server Protocol] (LSP).
16 The LSP allows various code editors, like VS Code, Emacs or Vim, to implement semantic features like completion or goto definition by talking to an external language server process.
21 To improve this document, send a pull request: +
22 https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc]
24 The manual is written in https://asciidoc.org[AsciiDoc] and includes some extra files which are generated from the source code. Run `cargo test` and `cargo test -p xtask` to create these and then `asciidoctor manual.adoc` to create an HTML copy.
27 If you have questions about using rust-analyzer, please ask them in the https://users.rust-lang.org/c/ide/14["`IDEs and Editors`"] topic of Rust users forum.
31 In theory, one should be able to just install the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>> and have it automatically work with any editor.
32 We are not there yet, so some editor specific setup is required.
34 Additionally, rust-analyzer needs the sources of the standard library.
35 If the source code is not present, rust-analyzer will attempt to install it automatically.
37 To add the sources manually, run the following command:
40 $ rustup component add rust-src
45 This is the best supported editor at the moment.
46 The rust-analyzer plugin for VS Code is maintained
47 https://github.com/rust-analyzer/rust-analyzer/tree/master/editors/code[in tree].
49 You can install the latest release of the plugin from
50 https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer[the marketplace].
52 Note that the plugin may cause conflicts with the
53 https://marketplace.visualstudio.com/items?itemName=rust-lang.rust[official Rust plugin].
54 It is recommended to disable the Rust plugin when using the rust-analyzer extension.
56 By default, the plugin will prompt you to download the matching version of the server as well:
58 image::https://user-images.githubusercontent.com/9021944/75067008-17502500-54ba-11ea-835a-f92aac50e866.png[]
62 To disable this notification put the following to `settings.json`
66 { "rust-analyzer.updates.askBeforeDownload": false }
70 The server binary is stored in:
72 * Linux: `~/.config/Code/User/globalStorage/matklad.rust-analyzer`
73 * Linux (Remote, such as WSL): `~/.vscode-server/data/User/globalStorage/matklad.rust-analyzer`
74 * macOS: `~/Library/Application\ Support/Code/User/globalStorage/matklad.rust-analyzer`
75 * Windows: `%APPDATA%\Code\User\globalStorage\matklad.rust-analyzer`
77 However, if you are using a version of the extension with a bundled server binary and you are not running NixOS, the server binary might be instead running from: `~/.vscode/extensions/matklad.rust-analyzer-VERSION`.
79 Note that we only support two most recent versions of VS Code.
83 The extension will be updated automatically as new versions become available.
84 It will ask your permission to download the matching language server version binary if needed.
88 We ship nightly releases for VS Code.
89 To help us out with testing the newest code and follow the bleeding edge of our `master`, please use the following config:
93 { "rust-analyzer.updates.channel": "nightly" }
96 You will be prompted to install the `nightly` extension version.
97 Just click `Download now` and from that moment you will get automatic updates every 24 hours.
99 If you don't want to be asked for `Download now` every day when the new nightly version is released add the following to your `settings.json`:
102 { "rust-analyzer.updates.askBeforeDownload": false }
105 NOTE: Nightly extension should **only** be installed via the `Download now` action from VS Code.
107 ==== Manual installation
109 Alternatively, procure both `rust-analyzer.vsix` and your platform's matching `rust-analyzer-{platform}`, for example from the
110 https://github.com/rust-analyzer/rust-analyzer/releases[releases] page.
112 Install the extension with the `Extensions: Install from VSIX` command within VS Code, or from the command line via:
115 $ code --install-extension /path/to/rust-analyzer.vsix
118 Copy the `rust-analyzer-{platform}` binary anywhere, then add the path to your settings.json, for example:
121 { "rust-analyzer.server.path": "~/.local/bin/rust-analyzer-linux" }
124 ==== Building From Source
126 Alternatively, both the server and the Code plugin can be installed from source:
130 $ git clone https://github.com/rust-analyzer/rust-analyzer.git && cd rust-analyzer
131 $ cargo xtask install
134 You'll need Cargo, nodejs and npm for this.
136 Note that installing via `xtask install` does not work for VS Code Remote, instead you'll need to install the `.vsix` manually.
138 If you're not using Code, you can compile and install only the LSP server:
142 $ cargo xtask install --server
145 === rust-analyzer Language Server Binary
147 Other editors generally require the `rust-analyzer` binary to be in `$PATH`.
148 You can download pre-built binaries from the https://github.com/rust-analyzer/rust-analyzer/releases[releases] page.
149 You will need to uncompress and rename the binary for your platform, e.g. from `rust-analyzer-aarch64-apple-darwin.gz` on Mac OS to `rust-analyzer`, make it executable, then move it into a directory in your `$PATH`.
151 On Linux to install the `rust-analyzer` binary into `~/.local/bin`, these commands should work:
155 $ mkdir -p ~/.local/bin
156 $ curl -L https://github.com/rust-analyzer/rust-analyzer/releases/latest/download/rust-analyzer-x86_64-unknown-linux-gnu.gz | gunzip -c - > ~/.local/bin/rust-analyzer
157 $ chmod +x ~/.local/bin/rust-analyzer
160 Make sure that `~/.local/bin` is listed in the `$PATH` variable and use the appropriate URL if you're not on a `x86-64` system.
162 You don't have to use `~/.local/bin`, any other path like `~/.cargo/bin` or `/usr/local/bin` will work just as well.
164 Alternatively, you can install it from source using the command below.
165 You'll need the latest stable version of the Rust toolchain.
169 $ git clone https://github.com/rust-analyzer/rust-analyzer.git && cd rust-analyzer
170 $ cargo xtask install --server
173 If your editor can't find the binary even though the binary is on your `$PATH`, the likely explanation is that it doesn't see the same `$PATH` as the shell, see https://github.com/rust-analyzer/rust-analyzer/issues/1811[this issue].
174 On Unix, running the editor from a shell or changing the `.desktop` file to set the environment should help.
178 `rust-analyzer` is available in `rustup`, but only in the nightly toolchain:
182 $ rustup +nightly component add rust-analyzer-preview
185 However, in contrast to `component add clippy` or `component add rustfmt`, this does not actually place a `rust-analyzer` binary in `~/.cargo/bin`, see https://github.com/rust-lang/rustup/issues/2411[this issue].
189 The `rust-analyzer` binary can be installed from the repos or AUR (Arch User Repository):
191 - https://www.archlinux.org/packages/community/x86_64/rust-analyzer/[`rust-analyzer`] (built from latest tagged source)
192 - https://aur.archlinux.org/packages/rust-analyzer-git[`rust-analyzer-git`] (latest Git version)
194 Install it with pacman, for example:
198 $ pacman -S rust-analyzer
203 `rust-analyzer` is available in the GURU repository:
205 - https://gitweb.gentoo.org/repo/proj/guru.git/tree/dev-util/rust-analyzer?id=9895cea62602cfe599bd48e0fb02127411ca6e81[`dev-util/rust-analyzer`] builds from source
206 - https://gitweb.gentoo.org/repo/proj/guru.git/tree/dev-util/rust-analyzer-bin?id=9895cea62602cfe599bd48e0fb02127411ca6e81[`dev-util/rust-analyzer-bin`] installs an official binary release
208 If not already, GURU must be enabled (e.g. using `app-eselect/eselect-repository`) and sync'd before running `emerge`:
212 $ eselect repository enable guru && emaint sync -r guru
213 $ emerge rust-analyzer-bin
218 The `rust-analyzer` binary can be installed via https://brew.sh/[Homebrew].
222 $ brew install rust-analyzer
227 Note this excellent https://robert.kra.hn/posts/2021-02-07_rust-with-emacs/[guide] from https://github.com/rksm[@rksm].
229 Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
231 Emacs support is maintained as part of the https://github.com/emacs-lsp/lsp-mode[Emacs-LSP] package in https://github.com/emacs-lsp/lsp-mode/blob/master/lsp-rust.el[lsp-rust.el].
233 1. Install the most recent version of `emacs-lsp` package by following the https://github.com/emacs-lsp/lsp-mode[Emacs-LSP instructions].
234 2. Set `lsp-rust-server` to `'rust-analyzer`.
235 3. Run `lsp` in a Rust buffer.
236 4. (Optionally) bind commands like `lsp-rust-analyzer-join-lines`, `lsp-extend-selection` and `lsp-rust-analyzer-expand-macro` to keys.
240 Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
241 Not needed if the extension can install/update it on its own, coc-rust-analyzer is one example.
243 The are several LSP client implementations for vim or neovim:
245 ==== coc-rust-analyzer
247 1. Install coc.nvim by following the instructions at
248 https://github.com/neoclide/coc.nvim[coc.nvim]
250 2. Run `:CocInstall coc-rust-analyzer` to install
251 https://github.com/fannheyward/coc-rust-analyzer[coc-rust-analyzer],
252 this extension implements _most_ of the features supported in the VSCode extension:
253 * automatically install and upgrade stable/nightly releases
254 * same configurations as VSCode extension, `rust-analyzer.server.path`, `rust-analyzer.cargo.features` etc.
255 * same commands too, `rust-analyzer.analyzerStatus`, `rust-analyzer.ssr` etc.
256 * inlay hints for variables and method chaining, _Neovim Only_
257 * semantic highlighting is not implemented yet
259 Note: for code actions, use `coc-codeaction-cursor` and `coc-codeaction-selected`; `coc-codeaction` and `coc-codeaction-line` are unlikely to be useful.
261 ==== LanguageClient-neovim
263 1. Install LanguageClient-neovim by following the instructions
264 https://github.com/autozimu/LanguageClient-neovim[here]
265 * The GitHub project wiki has extra tips on configuration
267 2. Configure by adding this to your vim/neovim config file (replacing the existing Rust-specific line if it exists):
271 let g:LanguageClient_serverCommands = {
272 \ 'rust': ['rust-analyzer'],
278 Install YouCompleteMe by following the instructions
279 https://github.com/ycm-core/YouCompleteMe#installation[here].
281 rust-analyzer is the default in ycm, it should work out of the box.
285 To use the LSP server in https://github.com/dense-analysis/ale[ale]:
289 let g:ale_linters = {'rust': ['analyzer']}
294 NeoVim 0.5 has built-in language server support.
295 For a quick start configuration of rust-analyzer, use https://github.com/neovim/nvim-lspconfig#rust_analyzer[neovim/nvim-lspconfig].
296 Once `neovim/nvim-lspconfig` is installed, use `+lua require'lspconfig'.rust_analyzer.setup({})+` in your `init.vim`.
298 You can also pass LSP settings to the server:
303 local nvim_lsp = require'lspconfig'
305 local on_attach = function(client)
306 require'completion'.on_attach(client)
309 nvim_lsp.rust_analyzer.setup({
312 ["rust-analyzer"] = {
314 importGranularity = "module",
315 importPrefix = "by_self",
318 loadOutDirsFromCheck = true
329 See https://sharksforarms.dev/posts/neovim-rust/ for more tips on getting started.
331 Check out https://github.com/simrat39/rust-tools.nvim for a batteries included rust-analyzer setup for neovim.
335 vim-lsp is installed by following https://github.com/prabirshrestha/vim-lsp[the plugin instructions].
336 It can be as simple as adding this line to your `.vimrc`:
340 Plug 'prabirshrestha/vim-lsp'
343 Next you need to register the `rust-analyzer` binary.
344 If it is available in `$PATH`, you may want to add this to your `.vimrc`:
348 if executable('rust-analyzer')
349 au User lsp_setup call lsp#register_server({
350 \ 'name': 'Rust Language Server',
351 \ 'cmd': {server_info->['rust-analyzer']},
352 \ 'whitelist': ['rust'],
357 There is no dedicated UI for the server configuration, so you would need to send any options as a value of the `initialization_options` field, as described in the <<_configuration,Configuration>> section.
358 Here is an example of how to enable the proc-macro support:
362 if executable('rust-analyzer')
363 au User lsp_setup call lsp#register_server({
364 \ 'name': 'Rust Language Server',
365 \ 'cmd': {server_info->['rust-analyzer']},
366 \ 'whitelist': ['rust'],
367 \ 'initialization_options': {
369 \ 'loadOutDirsFromCheck': v:true,
381 Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
383 You also need the `LSP` package.
386 1. If you've never installed a Sublime Text package, install Package Control:
387 * Open the command palette (Win/Linux: `ctrl+shift+p`, Mac: `cmd+shift+p`)
388 * Type `Install Package Control`, press enter
389 2. In the command palette, run `Package control: Install package`, and in the list that pops up, type `LSP` and press enter.
391 Finally, with your Rust project open, in the command palette, run `LSP: Enable Language Server In Project` or `LSP: Enable Language Server Globally`, then select `rust-analyzer` in the list that pops up to enable the rust-analyzer LSP.
392 The latter means that rust-analyzer is enabled by default in Rust projects.
394 If it worked, you should see "rust-analyzer, Line X, Column Y" on the left side of the bottom bar, and after waiting a bit, functionality like tooltips on hovering over variables should become available.
396 If you get an error saying `No such file or directory: 'rust-analyzer'`, see the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>> section on installing the language server binary.
400 GNOME Builder 3.37.1 and newer has native `rust-analyzer` support.
401 If the LSP binary is not available, GNOME Builder can install it when opening a Rust file.
406 Support for Rust development in the Eclipse IDE is provided by link:https://github.com/eclipse/corrosion[Eclipse Corrosion].
407 If available in PATH or in some standard location, `rust-analyzer` is detected and powers editing of Rust files without further configuration.
408 If `rust-analyzer` is not detected, Corrosion will prompt you for configuration of your Rust toolchain and language server with a link to the __Window > Preferences > Rust__ preference page; from here a button allows to download and configure `rust-analyzer`, but you can also reference another installation.
409 You'll need to close and reopen all .rs and Cargo files, or to restart the IDE, for this change to take effect.
413 Support for the language server protocol is built into Kate through the LSP plugin, which is included by default.
414 It is preconfigured to use Rls for rust sources, but allows you to use rust-analyzer through a simple settings change.
415 In the LSP Client settings of Kate, copy the content of the third tab "default parameters" to the second tab "server configuration".
416 Then in the configuration replace:
421 "rootIndicationFileNames": ["Cargo.lock", "Cargo.toml"],
422 "url": "https://github.com/rust-lang/rls",
423 "highlightingModeRegex": "^Rust$"
430 "command": ["rust-analyzer"],
431 "rootIndicationFileNames": ["Cargo.lock", "Cargo.toml"],
432 "url": "https://github.com/rust-analyzer/rust-analyzer",
433 "highlightingModeRegex": "^Rust$"
436 Then click on apply, and restart the LSP server for your rust project.
440 https://gitlab.com/cppit/jucipp[juCi++] has built-in support for the language server protocol, and since version 1.7.0 offers installation of both Rust and rust-analyzer when opening a Rust file.
444 Start with looking at the rust-analyzer version.
445 Try **Rust Analyzer: Show RA Version** in VS Code and `rust-analyzer --version` in the command line.
446 If the date is more than a week ago, it's better to update rust-analyzer version.
448 The next thing to check would be panic messages in rust-analyzer's log.
449 Log messages are printed to stderr, in VS Code you can see then in the `Output > Rust Analyzer Language Server` tab of the panel.
450 To see more logs, set the `RA_LOG=info` environment variable.
452 To fully capture LSP messages between the editor and the server, set `"rust-analyzer.trace.server": "verbose"` config and check
453 `Output > Rust Analyzer Language Server Trace`.
455 The root cause for many "`nothing works`" problems is that rust-analyzer fails to understand the project structure.
456 To debug that, first note the `rust-analyzer` section in the status bar.
457 If it has an error icon and red, that's the problem (hover will have somewhat helpful error message).
458 **Rust Analyzer: Status** prints dependency information for the current file.
459 Finally, `RA_LOG=project_model=debug` enables verbose logs during project loading.
461 If rust-analyzer outright crashes, try running `rust-analyzer analysis-stats /path/to/project/directory/` on the command line.
462 This command type checks the whole project in batch mode bypassing LSP machinery.
464 When filing issues, it is useful (but not necessary) to try to minimize examples.
465 An ideal bug reproduction looks like this:
468 $ git clone https://github.com/username/repo.git && cd repo && git switch --detach commit-hash
469 $ rust-analyzer --version
470 rust-analyzer dd12184e4 2021-05-08 dev
471 $ rust-analyzer analysis-stats .
475 It is especially useful when the `repo` doesn't use external crates or the standard library.
477 If you want to go as far as to modify the source code to debug the problem, be sure to take a look at the
478 https://github.com/rust-analyzer/rust-analyzer/tree/master/docs/dev[dev docs]!
482 **Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/rust-analyzer/src/config.rs[config.rs]
484 The <<_installation,Installation>> section contains details on configuration for some of the editors.
485 In general `rust-analyzer` is configured via LSP messages, which means that it's up to the editor to decide on the exact format and location of configuration files.
487 Some clients, such as <<vs-code,VS Code>> or <<coc-rust-analyzer,COC plugin in Vim>> provide `rust-analyzer` specific configuration UIs. Others may require you to know a bit more about the interaction with `rust-analyzer`.
489 For the later category, it might help to know that the initial configuration is specified as a value of the `initializationOptions` field of the https://microsoft.github.io/language-server-protocol/specifications/specification-current/#initialize[`InitializeParams` message, in the LSP protocol].
490 The spec says that the field type is `any?`, but `rust-analyzer` is looking for a JSON object that is constructed using settings from the list below.
491 Name of the setting, ignoring the `rust-analyzer.` prefix, is used as a path, and value of the setting becomes the JSON property value.
493 For example, a very common configuration is to enable proc-macro support, can be achieved by sending this JSON:
499 "loadOutDirsFromCheck": true,
507 Please consult your editor's documentation to learn more about how to configure https://microsoft.github.io/language-server-protocol/[LSP servers].
509 To verify which configuration is actually used by `rust-analyzer`, set `RA_LOG` environment variable to `rust_analyzer=info` and look for config-related messages.
510 Logs should show both the JSON that `rust-analyzer` sees as well as the updated config.
512 This is the list of config options `rust-analyzer` supports:
514 include::./generated_config.adoc[]
516 == Non-Cargo Based Projects
518 rust-analyzer does not require Cargo.
519 However, if you use some other build system, you'll have to describe the structure of your project for rust-analyzer in the `rust-project.json` format:
523 interface JsonProject {
524 /// Path to the directory with *source code* of
527 /// It should point to the directory where std,
528 /// core, and friends can be found:
530 /// https://github.com/rust-lang/rust/tree/master/library.
532 /// If provided, rust-analyzer automatically adds
533 /// dependencies on sysroot crates. Conversely,
534 /// if you omit this path, you can specify sysroot
535 /// dependencies yourself and, for example, have
536 /// several different "sysroots" in one graph of
538 sysroot_src?: string;
539 /// The set of crates comprising the current
540 /// project. Must include all transitive
541 /// dependencies as well as sysroot crate (libstd,
542 /// libcore and such).
547 /// Optional crate name used for display purposes,
548 /// without affecting semantics. See the `deps`
549 /// key for semantically-significant crate names.
550 display_name?: string;
551 /// Path to the root module of the crate.
553 /// Edition of the crate.
554 edition: "2015" | "2018" | "2021";
557 /// Should this crate be treated as a member of
558 /// current "workspace".
560 /// By default, inferred from the `root_module`
561 /// (members are the crates which reside inside
562 /// the directory opened in the editor).
564 /// Set this to `false` for things like standard
565 /// library and 3rd party crates to enable
566 /// performance optimizations (rust-analyzer
567 /// assumes that non-member crates don't change).
568 is_workspace_member?: boolean;
569 /// Optionally specify the (super)set of `.rs`
570 /// files comprising this crate.
572 /// By default, rust-analyzer assumes that only
573 /// files under `root_module.parent` can belong
574 /// to a crate. `include_dirs` are included
575 /// recursively, unless a subdirectory is in
578 /// Different crates can share the same `source`.
580 /// If two crates share an `.rs` file in common,
581 /// they *must* have the same `source`.
582 /// rust-analyzer assumes that files from one
583 /// source can't refer to files in another source.
585 include_dirs: string[],
586 exclude_dirs: string[],
588 /// The set of cfgs activated for a given crate, like
589 /// `["unix", "feature=\"foo\"", "feature=\"bar\""]`.
591 /// Target triple for this Crate.
593 /// Used when running `rustc --print cfg`
594 /// to get target-specific cfgs.
596 /// Environment variables, used for
598 env: { [key: string]: string; },
600 /// Whether the crate is a proc-macro crate.
601 is_proc_macro: boolean;
602 /// For proc-macro crates, path to compiled
603 /// proc-macro (.so file).
604 proc_macro_dylib_path?: string;
608 /// Index of a crate in the `crates` array.
610 /// Name as should appear in the (implicit)
611 /// `extern crate name` declaration.
616 This format is provisional and subject to change.
617 Specifically, the `roots` setup will be different eventually.
619 There are three ways to feed `rust-project.json` to rust-analyzer:
621 * Place `rust-project.json` file at the root of the project, and rust-analyzer will discover it.
622 * Specify `"rust-analyzer.linkedProjects": [ "path/to/rust-project.json" ]` in the settings (and make sure that your LSP client sends settings as a part of initialize request).
623 * Specify `"rust-analyzer.linkedProjects": [ { "roots": [...], "crates": [...] }]` inline.
625 Relative paths are interpreted relative to `rust-project.json` file location or (for inline JSON) relative to `rootUri`.
627 See https://github.com/rust-analyzer/rust-project.json-example for a small example.
629 You can set the `RA_LOG` environment variable to `rust_analyzer=info` to inspect how rust-analyzer handles config and project loading.
631 Note that calls to `cargo check` are disabled when using `rust-project.json` by default, so compilation errors and warnings will no longer be sent to your LSP client. To enable these compilation errors you will need to specify explicitly what command rust-analyzer should run to perform the checks using the `checkOnSave.overrideCommand` configuration. As an example, the following configuration explicitly sets `cargo check` as the `checkOnSave` command.
635 { "rust-analyzer.checkOnSave.overrideCommand": ["cargo", "check", "--message-format=json"] }
638 The `checkOnSave.overrideCommand` requires the command specified to output json error messages for rust-analyzer to consume. The `--message-format=json` flag does this for `cargo check` so whichever command you use must also output errors in this format. See the <<Configuration>> section for more information.
642 At the moment, rust-analyzer assumes that all code is trusted.
643 Here is a **non-exhaustive** list of ways to make rust-analyzer execute arbitrary code:
645 * proc macros and build scripts are executed by default
646 * `.cargo/config` can override `rustc` with an arbitrary executable
647 * `rust-toolchain.toml` can override `rustc` with an arbitrary executable
648 * VS Code plugin reads configuration from project directory, and that can be used to override paths to various executables, like `rustfmt` or `rust-analyzer` itself.
649 * rust-analyzer's syntax trees library uses a lot of `unsafe` and hasn't been properly audited for memory safety.
653 The LSP server performs no network access in itself, but runs `cargo metadata` which will update or download the crate registry and the source code of the project dependencies.
654 If enabled (the default), build scripts and procedural macros can do anything.
656 The Code extension automatically connects to GitHub to download updated LSP binaries and, if the nightly channel is selected, to perform update checks using the GitHub API. For `rust-analyzer` developers, using `cargo xtask release` uses the same API to put together the release notes.
658 Any other editor plugins are not under the control of the `rust-analyzer` developers. For any privacy concerns, you should check with their respective developers.
662 include::./generated_features.adoc[]
664 == Assists (Code Actions)
666 Assists, or code actions, are small local refactorings, available in a particular context.
667 They are usually triggered by a shortcut or by clicking a light bulb icon in the editor.
668 Cursor position or selection is signified by `┃` character.
670 include::./generated_assists.adoc[]
674 While most errors and warnings provided by rust-analyzer come from the `cargo check` integration, there's a growing number of diagnostics implemented using rust-analyzer's own analysis.
675 Some of these diagnostics don't respect `\#[allow]` or `\#[deny]` attributes yet, but can be turned off using the `rust-analyzer.diagnostics.enable`, `rust-analyzer.diagnostics.enableExperimental` or `rust-analyzer.diagnostics.disabled` settings.
677 include::./generated_diagnostic.adoc[]
682 ==== Color configurations
684 It is possible to change the foreground/background color of inlay hints.
685 Just add this to your `settings.json`:
690 "workbench.colorCustomizations": {
691 // Name of the theme you are currently using
693 "rust_analyzer.inlayHints.foreground": "#868686f0",
694 "rust_analyzer.inlayHints.background": "#3d3d3d48",
696 // Overrides for specific kinds of inlay hints
697 "rust_analyzer.inlayHints.foreground.typeHints": "#fdb6fdf0",
698 "rust_analyzer.inlayHints.foreground.paramHints": "#fdb6fdf0",
699 "rust_analyzer.inlayHints.background.chainingHints": "#6b0c0c81"
705 ==== Semantic style customizations
707 You can customize the look of different semantic elements in the source code.
708 For example, mutable bindings are underlined by default and you can override this behavior by adding the following section to your `settings.json`:
713 "editor.semanticTokenColorCustomizations": {
716 "fontStyle": "", // underline is the default
723 Most themes doesn't support styling unsafe operations differently yet. You can fix this by adding overrides for the rules `operator.unsafe`, `function.unsafe`, and `method.unsafe`:
728 "editor.semanticTokenColorCustomizations": {
730 "operator.unsafe": "#ff6600",
731 "function.unsafe": "#ff6600"
732 "method.unsafe": "#ff6600"
738 In addition to the top-level rules you can specify overrides for specific themes. For example, if you wanted to use a darker text color on a specific light theme, you might write:
743 "editor.semanticTokenColorCustomizations": {
745 "operator.unsafe": "#ff6600"
749 "operator.unsafe": "#572300"
756 Make sure you include the brackets around the theme name. For example, use `"[Ayu Light]"` to customize the theme Ayu Light.
758 ==== Special `when` clause context for keybindings.
759 You may use `inRustProject` context to configure keybindings for rust projects only.
766 "command": "rust-analyzer.toggleInlayHints",
767 "when": "inRustProject"
770 More about `when` clause contexts https://code.visualstudio.com/docs/getstarted/keybindings#_when-clause-contexts[here].
772 ==== Setting runnable environment variables
773 You can use "rust-analyzer.runnableEnv" setting to define runnable environment-specific substitution variables.
774 The simplest way for all runnables in a bunch:
776 "rust-analyzer.runnableEnv": {
777 "RUN_SLOW_TESTS": "1"
781 Or it is possible to specify vars more granularly:
783 "rust-analyzer.runnableEnv": [
785 // "mask": null, // null mask means that this rule will be applied for all runnables
794 "APP_ID": "2", // overwrites only APP_ID
800 You can use any valid regular expression as a mask.
801 Also note that a full runnable name is something like *run bin_or_example_name*, *test some::mod::test_name* or *test-mod some::mod*, so it is possible to distinguish binaries, single tests, and test modules with this masks: `"^run"`, `"^test "` (the trailing space matters!), and `"^test-mod"` respectively.
803 ==== Compiler feedback from external commands
805 Instead of relying on the built-in `cargo check`, you can configure Code to run a command in the background and use the `$rustc-watch` problem matcher to generate inline error markers from its output.
807 To do this you need to create a new https://code.visualstudio.com/docs/editor/tasks[VS Code Task] and set `rust-analyzer.checkOnSave.enable: false` in preferences.
809 For example, if you want to run https://crates.io/crates/cargo-watch[`cargo watch`] instead, you might add the following to `.vscode/tasks.json`:
816 "command": "cargo watch",
817 "problemMatcher": "$rustc-watch",