Visualize ownership and lifetimes in Rust for debugging and optimization

RustOwl visualizes ownership movement and lifetimes of variables. When you save Rust source code, it is analyzed, and the ownership and lifetimes of variables are visualized when you hover over a variable or function call.

RustOwl visualizes those by using underlines:

• 🟩 green: variable's actual lifetime
• 🟦 blue: immutable borrowing
• 🟪 purple: mutable borrowing
• 🟧 orange: value moved / function call
• 🟥 red: lifetime error
  • diff of lifetime between actual and expected, or
  • invalid overlapped lifetime of mutable and shared (immutable) references

Detailed usage is described here.

Currently, we offer VSCode extension, Neovim plugin and Emacs package. For these editors, move the text cursor over the variable or function call you want to inspect and wait for 2 seconds to visualize the information. We implemented LSP server with an extended protocol. So, RustOwl can be used easily from other editor.

Support

If you're looking for support, please consider checking all issues, existing discussions, and starting a discussion first!

Quick Start

Here we describe how to start using RustOwl with VS Code.

Prerequisite

• cargo installed
  • You can install cargo using rustup from this link.
• Visual Studio Code (VS Code) installed

We tested this guide on macOS Sequoia 15.3.2 on arm64 architecture with VS Code 1.99.3 and cargo 1.86.0.

VS Code

You can install VS Code extension from this link. RustOwl will install automatically when the extension is activated.

After installation, the extension will automatically run RustOwl when you save any Rust program in cargo workspace. The initial analysis may take some time, but from the second run onward, compile caching is used to reduce the analysis time.

Other editor support

We support Neovim and Emacs. You can also create your own LSP client. If you would like to implement a client, please refer to the The RustOwl LSP specification.

Neovim

Minimal setup with lazy.nvim:

{
  'cordx56/rustowl',
  version = '*', -- Latest stable version
  build = 'cd rustowl && cargo install --path . --locked',
  lazy = false, -- This plugin is already lazy
  opts = {},
}

Recommended configuration: Click to expand

{
  'cordx56/rustowl',
  version = '*', -- Latest stable version
  build = 'cd rustowl && cargo install --path . --locked',
  lazy = false, -- This plugin is already lazy
  opts = {
    client = {
      on_attach = function(_, buffer)
        vim.keymap.set('n', '<leader>o', function()
          require('rustowl').toggle(buffer)
        end, { buffer = buffer, desc = 'Toggle RustOwl' })
      end
    },
  },
}

Default options:

{
  auto_attach = true, -- Auto attach the RustOwl LSP client when opening a Rust file
  auto_enable = false, -- Enable RustOwl immediately when attaching the LSP client
  idle_time = 500, -- Time in milliseconds to hover with the cursor before triggering RustOwl
  client = {}, -- LSP client configuration that gets passed to `vim.lsp.start`
}

When opening a Rust file, the Neovim plugin creates the Rustowl user command:

:Rustowl {subcommand}

where {subcommand} can be one of:

• start_client: Start the rustowl LSP client.
• stop_client: Stop the rustowl LSP client.
• restart_client: Restart the rustowl LSP client.
• enable: Enable rustowl highlights.
• disable: Disable rustowl highlights.
• toggle: Toggle rustowl highlights.

Emacs

Elpaca example:

(elpaca
  (rustowlsp
    :host github
    :repo "cordx56/rustowl"
    :files (:defaults "emacs/*")))

You have to install RustOwl LSP server manually.

RustRover / IntelliJ IDEs

There is a third-party repository that supports IntelliJ IDEs. You have to install RustOwl LSP server manually.

Build manually

Here, we describe manual install instructions from source code.

RustOwl

Prerequisite

• rustup installed
  • You can install rustup from this link.
  • You need to set up the PATH environment variable. To do this, follow the instructions provided by the rustup installer.

RustOwl has been tested on macOS Sequoia 15.3.2 on arm64 architecture with rustup 1.28.1. We have not tested the installation of dependencies from other package repositories, such as Homebrew. You may need to uninstall any Rust-related packages installed through those repositories first. Other dependencies are locked in the configuration files and will be installed automatically.

We have also tested this on Ubuntu 24.04.2 on amd64 architecture and on Windows 11 Education 23H2 on amd64 architecture. Additional dependencies may be required. We have confirmed that running apt install build-essential is necessary on a freshly installed Ubuntu for linking.

Build & Run

cd rustowl
cargo install --path . --locked

VSCode extension

Prerequisite

• VS Code installed
  • You can install VS Code from this link.
• Node.js installed
• yarn installed
  • After installing Node.js, You can install yarn by running npm install -g yarn.

VS Code extension has been tested on macOS Sequoia 15.3.2 on arm64 architecture with Visual Studio Code 1.99.3, Node.js v20.16.0, and yarn 1.22.22. Other dependencies are locked in the configuration files and will be installed automatically.

Build & Run

First, install the dependencies.

cd vscode
yarn install --frozen-lockfile

Then open vscode directory in VS Code.

A notification to install the recommended VS Code extension will appear in the bottom right corner of VS Code. Click the install button, wait for the installation to finish, and then restart VS Code.

Open vscode directory again, and press the F5 key in the VS Code window. A new VS Code window with the extension enabled will appear.

Open cargo workspace directory in the new VS Code window.

When you save Rust files, decoration indicating the movement of ownership and lifetimes will appear in the editor.

Note

In this tool, due to the limitations of VS Code's decoration specifications, characters with descenders, such as g or parentheses, may occasionally not display underlines properly. Additionally, we observed that the println! macro sometimes produces extra output, though this does not affect usability in any significant way.