Quick start guide

Last modified: 08 April 2024

New to RustRover? This guide will help you explore the IDE's workspace and features and try out all the main aspects of the Rust development process.

note
For instructions on how to install RustRover, refer to the installation guide.

1. Open or create a Rust project

You have three options to start working on a project inside RustRover:

Create a new Cargo project

Launch RustRover.
Do one of the following:
- Click New Project on the Welcome screen.
- Select File | New | Project from the main menu.
- Click the Project widget in the main window header and select New Project.
In the left-hand pane, select Rust.
Specify the project location and name.
Specify the location of the Rust toolchain and standard library. If installed, RustRover will detect them automatically.
Select the desired project template and click Create.

Open a local Cargo project

In the main menu, go to File | Open and select the directory containing the root Cargo.toml file (or select Cargo.toml itself):
In the dialog that opens, select Open as project.
When opening the project for the first time, RustRover will prompt you to confirm that you consider it safe.
Click Trust Project if you are certain the project poses no threats and you would like to enable all RustRover features. If you have any doubts, select Preview in Safe Mode. For more information, refer to Project security.

Clone a repository from VCS

In the main menu, go to File | New | Project from Version Control or click Get from VCS on the Welcome screen.
Specify the repository URL and the destination directory. Click Clone:

2. Explore the workspace and features

RustRover's feature set is designed to simplify the Rust development process. Let's take a closer look at what it has to offer.

Syntax highlighting and code reference

To help you quickly read and understand Rust code, RustRover provides highlighting, inlined hints, macro expansion, quick access to documentation, and more.

https://resources.jetbrains.com/help/img/idea/2023.3/ri_inlay_hints.png

Here are some shortcuts you may find useful:

Action	Shortcut
Expand macro	`AltEnter`
Go to declaration	`CtrlClick`
Get type info	`CtrlShift0P`
Quick documentation	`Ctrl0Q`
Quick definition	`CtrlShift0I`

For more information, refer to Code reference information.

Code analysis and error reporting

To help you fight errors and inconsistencies in code, RustRover offers built-in inspections and integrates with external linters.

For a summary of all detected problems, use the Inspections widget in the upper-right corner of the editor. To see the details, click the Inspections widget and refer to the Problems tool window (or select View | Tool Windows | Problems):

Inspections

Inspections run on the fly for all files currently open in the editor. You can also run them manually for a larger scope. To view inspection results, use the Problems tool window (View | Tool Windows | Problems).

RustRover will suggest quick-fixes and intentions where possible. Quick fixes are marked with a red bulb () and address errors. Intentions are marked with a yellow bulb () and suggest possible enhancements and optimizations.

Apply a quick-fix/intention

If an inspection has detected a problem in your code, you can quickly apply a fix in the editor. Place the caret at the highlighted piece of code and press AltEnter.

For more information, refer to Code inspections.

External linters

Additionally, you can verify your code by running an external linter – Cargo Check or Clippy.

Check external linter settings

To check which linter is enabled and whether it runs on the fly, hover over the linter widget in the status bar:

External linter widget: Cargo Check on-the-fly analysis is turned off

To make changes, click the widget. It will open external linter settings.

Run external linter

Before proceeding, check whether on-the-fly analysis is turned on or off.

If on-the-fly analysis is turned on, you don't need to trigger the linter – it is already running in the background.
If on-the-fly analysis is turned off, to call the linter, open the Cargo tool window (View | Tool Windows | Cargo) and click .

Information about detected issues will appear in the Problems tool window, together with inspection results.

For more information, refer to External linters.

Formatting

You can easily format your code using either RustRover's built-in formatter (enabled by default) or Rustfmt.

Enable (or disable) Rustfmt instead of the built-in formatter

Open settings by pressing CtrlAlt0S and navigate to Rust | Rustfmt
To enable Rustfmt, set the Use Rustfmt instead of built-in formatter checkbox. To disable Rustfmt, clear the checkbox.
note
Note that, when Rustfmt is enabled, RustRover will only use it for formatting whole files and Cargo projects. For code fragments, groups of files, and directories, RustRover will automatically switch to the built-in formatter.
Click OK to apply the changes.

Reformat a file

Open the file you want to reformat in the editor.
Press CtrlAltShift0L or select Code | Reformat File....
In the Reformat File dialog, select additional options if necessary and click Run.

For more information, refer to Built-in formatter and Rustfmt.

The Cargo tool window

The Cargo tool window is designed to help you with Cargo tasks. By default, it is pinned to the tool windows bar. You can show or hide it by clicking the window indicator on the sidebar.

Use the top panel to:

For more information, refer to Cargo tool window.

Sharing code in Playground

You can share your code in Rust Playground without leaving the editor.

Share in Playground

Select the code fragment you'd like to share (otherwise, the IDE will copy the whole file).
Right-click and choose Rust | Share in Playground.

RustRover will create a GitHub Gist and display a notification popup with a link to the playground.

https://resources.jetbrains.com/help/img/idea/2023.3/ri_sharing_in_playground.png

For a brief overview of RustRover features, check out this video:

3. Build and run

Use the Build action to compile your code and Run to execute it. There are several ways to perform these actions:

Build/run Rust code

To build or run a particular target, open the Cargo tool window (View | Tool Windows | Cargo) and double-click the target.
To run from a particular entry point, locate it in the editor, click in the gutter, and select Run:
To run a particular file or module, open the Project view, right-click the necessary file or module, and select Run:
If you want to build or run code using a predefined configuration (with custom parameters and settings), select it in the switcher on the main toolbar and:
- click to build (CtrlF9)
- click to run (ShiftF10)
You can always build/run using a Cargo command.

For more information, refer to Building and running.

4. Debug

RustRover provides a full-fledged debugger – with breakpoints, variable monitoring, stepping, memory and disassembly views, and other handy features.

Start a debug session

To start debugging from a particular entry point, locate it in the editor, click in the gutter, and select Debug:
To debug code using a predefined configuration (with custom parameters and settings), select it in the configuration switcher on the main toolbar and click :
You can always start a debug session by running a Cargo command.

For more information, refer to Start the debugger session.

Learn how to perform basic debugging actions from these guides:

Setting breakpoints
Using watches
Stepping through
Viewing memory and disassembly code representation

For more information, refer to the Debug section.

5. Test

You will likely support your code with tests, doctests, and/or benchmarks. Here are a few quick ways to run them:

Run test(s), doctest(s), or benchmark(s)

To run a single test or doctest, open it in the editor, click in the gutter, and select Run:
To run a test/benchmark target, open the Cargo tool window (View | Tool Windows | Cargo) and double-click the target:
Gif
You can always run tests using a Cargo command.

The Run tool window will open, automatically displaying the results:

For more information, refer to the Test section.

6. Run with coverage

RustRover allows you to explore code coverage statistics.

Run with Code Coverage

To get code coverage statistics, do one of the following:

Locate the program entry point, click in the gutter, and select Run with Coverage:
If you want to run a predefined configuration (with custom parameters and settings), select it in the switcher on the main toolbar and press :

The Coverage tool window will open, automatically displaying the results:

Tune RustRover settings

You can customize RustRover functionality to match your own needs. Here are some of the available customizations:

Define custom code style
Configure code completion and auto-import
Configure custom code templates
Create run/debug configurations

Quick start guide﻿

note

1. Open or create a Rust project﻿

Create a new Cargo project﻿

Open a local Cargo project﻿

Clone a repository from VCS﻿

2. Explore the workspace and features﻿

Syntax highlighting and code reference﻿

Code analysis and error reporting﻿

Formatting﻿

The Cargo tool window﻿

Sharing code in Playground﻿

3. Build and run﻿

Build/run Rust code﻿

4. Debug﻿

Start a debug session﻿

5. Test﻿

Run test(s), doctest(s), or benchmark(s)﻿

6. Run with coverage﻿

Run with Code Coverage﻿

Tune RustRover settings﻿