Rust support for Visual Studio Code
Adds language support for Rust to Visual Studio Code. Supports:
- code completion
- jump to definition, peek definition, find all references, symbol search
- types and documentation on hover
- code formatting
- refactoring (rename, deglob)
- error squiggles and apply suggestions from errors
- build tasks
Rust support is powered by the Rust Language Server (RLS). If you don't have it installed, the extension will install it for you.
This extension is built and maintained by the RLS team, part of the Rust IDEs and editors team. It is the reference client implementation for the RLS. Our focus is on providing a stable, high quality extension that makes best use of the RLS. We aim to support as many features as possible, but our priority is supporting the essential features as well as possible.
Contributing code, tests, documentation, and bug reports is appreciated! For more details on building and debugging, etc., see contributing.md.
- Install rustup (Rust toolchain manager).
- Install this extension from the VSCode Marketplace
(or by entering
ext install rustat the command palette).
- (Skip this step if you already have Rust projects that you'd like to work on.) Create a new Rust project by following these instructions.
- Open a Rust project (
File > Add Folder to Workspace...). Open the folder for the whole project (i.e., the folder containing 'Cargo.toml'), not the 'src' folder.
- You'll be prompted to install the RLS. Once installed, the RLS should start building your project.
This extension provides some options into VSCode's configuration settings. These
options have names which start with
rust.. You can find the settings under
File > Preferences > Settings, they all have Intellisense help.
rust.show_warnings- set to false to silence warnings in the editor.
rust.all_targets- build and index code for all targets (i.e., integration tests, examples, and benches)
rust.build_lib- if you have both a binary and library in your crate, set to true to build only the library.
rust.build_bin- if you have multiple binaries, you can specify which to build using this option.
rust.cfg_test- build and index test code (i.e., code with
Commands can be found in the command palette (ctrl + shift + p). We provide the following commands:
Find Implementations- Find locations of
implblocks for traits, structs, and enums. Usefull to find all structs implementing a specific trait or all traits implemented for a struct. Select a type when running the command.
Snippets are code templates which expand into common boilerplate. Intellisense includes snippet names as options when you type; select one by pressing 'enter'. You can move to the next 'hole' in the template by pressing 'tab'. We provide the following snippets:
for- a for loop
macro_rules- declare a macro
if let Option- an
if letstatement for executing code only in the
spawn- spawn a thread
extern crate- insert an
This extension is deliberately conservative about snippets and doesn't include too many. If you want more, check out Trusty Rusty Snippets.
The plugin provides tasks for building, running, and testing using the relevant
cargo commands. You can build using
ctrl + shift + b. Access other tasks via
Run tasks in the command palette.
The plugin writes these into
tasks.json. The plugin will not overwrite
existing tasks, so you can customise these tasks. To refresh back to the
tasks.json and restart VSCode.
Format on save
To enable formatting on save, you need to set the
true. Find it under
File > Preferences > Settings.
- A Rust toolchain (the extension will configure this for you, with permission),
- RLS (currently
rust-analysiscomponents (the extension will install these for you, with permission).
This extension almost exclusively uses the RLS for its feature support (syntax highlighting, snippets, and build tasks are provided client-side). The RLS uses the Rust compiler (rustc) to get data about Rust programs. It uses Cargo to manage building. Both Cargo and rustc are run in-process by the RLS. Formatting and code completion are provided by rustfmt and Racer, again both of these are run in-process by the RLS.