Prusti Assistant

This Visual Studio Code extension provides interactive IDE features for verifying Rust programs with the Prusti verifier.

For advanced use cases, consider switching to the command-line version of Prusti.

Screenshot

An example of how verification errors are reported by the extension:

Requirements

In order to use this extension, please install the following components:

• Java JDK version 11 or later, 64 bit. For example, OpenJDK.
• Rustup version 1.23.0 or later. On Windows, this in turn requires the Microsoft C++ Build Tools.

If anything fails, check the "Troubleshooting" section below. Note that macOS running on M1 is currently not supported by this extension.

First Usage

1. Install the requirements (listed above) and restart the IDE.
   • This will ensure that programs like rustup are in the program path used by the IDE.
2. Install the "Prusti Assistant" extension.
3. Open a Rust file to activate the extension.
   • At its first activation, this extension will automatically download Prusti and install the required Rust toolchain.
4. Click on the "Prusti" button in the status bar.
   • Alternativelly, you can run the Prusti: verify the current crate or file command.
   • If the program is in a folder with a Cargo.toml file, Prusti will verify the crate in which the file is contained.
   • If no Cargo.toml file can be found in a parent folder of the workspace, Prusti will verify the file as a standalone Rust program. No Cargo dependencies are allowed in this mode.
5. Follow the progress from the status bar.
   • You should see a "Verifying crate [folder name]" or "Verifying file [name]" message while Prusti is running.
6. The result of the verification is reported in the status bar and in the "Problems" tab.
   • You can open the "Problems" tab by clicking on Prusti's status bar.
   • Be aware that the "Problems" tab is shared by all extensions. If you are not sure which extension generated which error, try disabling other extensions. (Related VS Code issue: #51103.)

To update Prusti, run the command Prusti: update verifier in the command palette.

If anything fails, check the "Troubleshooting" section below.

Features

Commands

This extension provides the following commands:

• Prusti: verify the current crate or file to verify a Rust program. Clicking the "Prusti" button in the status bar runs this command.
• Prusti: update verifier to update Prusti.
• Prusti: show version to show the version of Prusti.
• Prusti: restart Prusti server to restart the Prusti server used by the extension.
• Prusti: clear diagnostics to clear all diagnostics generated by the extension.

Configuration

The main configuration options used by this extension are the following:

• prusti-assistant.verifyOnSave: Specifies if programs should be verified on save.
• prusti-assistant.verifyOnOpen: Specifies if programs should be verified when opened.
• prusti-assistant.checkForUpdates: Specifies if Prusti should check for updates at startup.
• prusti-assistant.javaHome: Specifies the path of the Java home folder. Leave empty to auto-detect it.
• prusti-assistant.prustiVersion: Allows to choose between the latest published Prusti version (the default), a fixed release specified as a GitHub tag (see the list of releases), or a local build of Prusti.

Inline Code Diagnostics

This extension automatically provides inline diagnostics for Prusti errors.

Snippets

Basic code-completion snippets are provided for Prusti annotations.

Verification cache

By default, Prusti transparently caches verification requests. To clear the cache, it's enough to restart the Prusti server with the commands described above.

Prusti verification flags

The verification flags of Prusti can be configured in a Prusti.toml file. Its location should be the following:

• When verifying a standalone Rust file, Prusti.toml should be placed in the same folder of the verified file.
• When verifying a Rust crate, Prusti.toml should be placed in the innermost folder that (1) contains a Cargo.toml file and (2) transitively contains the current active file in the IDE.

In addition, due to a technical limitation the Prusti server reads its configuration flags from the Prusti.toml placed in the root of the IDE workspace (i.e. the navigation panel on the left). When modifying this file, it is necessary to manually restart the server. The server uses only a few of Prusti's flags, mainly to configure the verification cache and to decide whether to dump Viper files for debugging.

To check whether Prusti picked up the Prusti.toml that you wrote, try writing make_prusti_crash=true in it (or any other nonexistent configuration flag). When doing so, the IDE should report that Prusti crashed.

The list of the supported Prusti flags is available here, in Prusti's developer guide. Note that by setting these flags in the wrong way it is possible to get incorrect verification results. Many flags only exist of debugging reasons and to provide workarounds in selected cases.

Troubleshooting

If Prusti fails to run, you can inspect Prusti's log from VS Code (View -> Output -> Prusti Assistant) and see if one of the following solutions applies to you.

Thanks to @Pointerbender, @michaelpaper, @fcoury, @Gadiguibou, @djc for their help in reporting, debugging and solving many of these issues!

In case you still experience difficulties or encounter bugs while using Prusti Assistant, please open an issue or contact us in the Zulip chat.