RustRover 2024.2 Help

User interface

When you open a project in RustRover, the default user interface looks as follows:

The Main window
  1. Navigation bar

  2. Project tool window

  3. Editor

  4. Popup menu

  5. Context menu

  6. Status bar

  7. Tool window bar

  8. Toolbar

  9. Gutter

  10. Cargo tool window

Depending on the set of plugins and configuration settings, your IDE may look and behave differently.

Focus: Alt+Home

Show/hide: View | Appearance | Navigation Bar

The navigation bar is a quick alternative to the Project view, where you can go through the structure of your project, open specific files, and jump to specific code elements in the current file.

It is located in the status bar at the bottom of the main window. You can change its location: in the main menu, go to View | Appearance | Navigation Bar and select Top to display the navigation bar in the top part of the IDE window or Don't show to disable it.

Editor

Focus: Escape

Use the editor to read, write, and explore your source code .

Status bar

Show/hide: View | Appearance | Status Bar

The left part of the status bar at the bottom of the main window shows the most recent event messages. Click a message in the status bar to open it in the Notifications tool window. Right-click the message in the status bar and select Copy to paste the message text when you are searching for a solution to a problem or need to add it to a support ticket or to the RustRover issue tracker.

The status bar also shows the progress of background tasks. You can click Background tasks to show the Background Tasks manager.

The right part of the status bar contains widgets that indicate the overall project and IDE status and provide access to various settings. Depending on the set of plugins and configuration settings, the set of widgets can change. Right-click the status bar to select the widgets that you want to show or hide.

The blinking Error notification status icon icon in the status bar indicates that an internal IDE error has occurred. Click to view the error descriptions and submit reports.

Customize the icons on the Status bar

Widget

Description

Cargo Check / Clippy

Shows the selected external linter and its status (whether is runs on the fly or not). You can click the widget to change external linter settings.

52:11

Shows the line and column number of the current caret position in the editor. Click the numbers to move the caret to a specific line and column. If you select a code fragment in the editor, RustRover also shows the number of characters and line breaks in the selected fragment.

LF

Shows the line endings used to break lines in the current file. Click this widget to change the line separators.

UTF-8

Shows the encoding used to view the current file. Click the widget to use another encoding.

Column

Indicates that the column selection mode is enabled for the current editor tab. You can press Alt+Shift+Insert to toggle it.

Target architecture

Shows the selected target architecture. You can click the widget to change the selection.

Read-only Read and write

Click to lock the file from editing (set it to read-only) or unlock it if you want to edit the file.

main

If version control integration is enabled, this widget shows the current VCS branch. Click it to manage VCS branches.

2 spaces

Shows the indent style used in the current file. Click to configure the tab and indent settings for the current file type or disable indent detection in the current project.

Memory indicator

Shows the amount of memory that RustRover consumes out of the total amount of heap memory. If you need to increase the memory heap, select Help | Change Memory Settings in the main menu.

Tool windows

Show/hide: View | Tool Windows

Tool windows provide functionality that supplements editing code. For example, the Cargo tool window helps you manage Rust workspace members and targets, and the Run tool window displays the output of your application when you run it.

By default, tool windows are docked to the sides and bottom of the main window. You can arrange them as necessary, undock, resize, hide, and so on. Right-click the title of the tool window or click the Options button in the title for its arrangement options.

You can assign shortcuts to quickly access the tool windows that you frequently use. Some of them have shortcuts by default. For example, to open the Project tool window , press Alt+1, and to open the Terminal tool window, press Alt+F12. To jump from the editor to the last active tool window, press F12.

Context menus

You can right-click various elements of the interface to see the actions available in the current context of this element. For example, right-click a file in the Project tool window for actions related to that file, or right-click in the editor to see actions that apply to the current code fragment.

Most of these actions can also be performed from the main menu at the top of the screen or the main window. Actions with shortcuts show the shortcut next to the action name.

Popup menus provide quick access for actions related to the current IDE and project context. Here are some useful popup menus and their shortcuts:

  • Alt+Insert opens the Generate popup for generating boilerplate code based on the context.

  • Ctrl+Alt+Shift+T opens the Refactor This popup with a list of contextually available refactorings.

  • Alt+Insert in the Project tool window opens the New popup for adding new files and directories to your project.

  • Alt+` opens the VCS Operations popup with contextually available actions for your version control system.

Tool window bars

The bars on the sides of the main window contain icons of tool windows. Click an icon to show or hide the tool window. A right-click on an icon will open the context menu, where you can hide or move the tool window. You can also drag tool window icons to rearrange tool windows.

Tool window icons in the upper parts of the left and right bars open vertical tool windows on the left and right sides of the IDE window.

The icons in the bottom parts of the bars open horizontal tool windows at the bottom of the IDE window.

Opening and hiding tool windows

Toolbar

Several widgets are located in the toolbar in the window header. From left to right:

Window header

  1. Main menu (Windows and Linux only)

    The main menu is now hidden under the menu icon. To access menu categories, click the icon or press Alt+\. The elements will appear horizontally over other header widgets.

    You can display the main menu as a separate toolbar: go to Settings | Appearance & Behavior | Appearance and enable the Show main menu in a separate toolbar option. Alternatively, go to View | Appearance and enable Show Main Menu in Separate Toolbar.

  2. Project widget

    The widget shows the name of the current project, allows switching between recent projects, creating new projects, and opening existing ones.

  3. VCS widget

    The widget shows the current branch, allows switching branches, and provides the most popular VCS actions like update project, commit and push changes.

    It has replaced the branch widget previously located in the status bar at the bottom of the main window, and VCS actions icons previously located in the navigation bar in the upper right corner.

  4. Run widget

    The widget allows you to start run/debug configurations, select other configurations to run, and change the mode for the current configuration (run or debug). You can edit, pin, or delete configurations using this widget.

    When a process is running, you can restart or stop it using the widget.

Gutter

The gutter is the panel located in the editor on the left. It contains action icons that allow you to fix code issues, run or debug your code, and use other framework-specific features. Line numbers, breakpoints, and bookmarks are also shown in the gutter.

The gutter also allows you to fold code, marks modified lines for projects under version control, and shows code coverage results.

Last modified: 11 October 2024