How to install the rustowl crate // Lib.rs

This crate requires a nightly (unstable, experimental) compiler version. To switch to it, you must have Rust installed via Rustup, and run:

rustup default nightly

Run rustup default stable to switch back.

RustOwl is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing `rustowl` `rustowlc` executables

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install rustowl

It will make rustowl rustowlc commands available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall rustowl uninstalls.

Adding `rustowl` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add rustowl

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

rustowl = "1.0.0-rc.1"

The rustowl library will be automatically available globally. Read the rustowl library documentation.

Back to the crate overview.

Readme

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
Quick Start
Other editor support
Architecture / OS / package repositories
Build manually
Note

Support

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

Also, you can reach out to us on the Discord server provided above.

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.89.0.

VS Code

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

Vscodium

You can install Vscodium extension from this link. RustOwl will be installed 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 have to install RustOwl before using RustOwl with other editors.

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 = 'cargo binstall rustowl',
  lazy = false, -- This plugin is already lazy
  opts = {},
}

For comprehensive configuration options including custom highlight colors, see the Neovim Configuration Guide.

Recommended configuration: Click to expand

{
  'cordx56/rustowl',
  version = '*', -- Latest stable version
  build = 'cargo binstall rustowl',
  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`
  highlight_style = 'undercurl', -- You can also use 'underline'
  colors = { -- Customize highlight colors (hex colors)
    lifetime = '#00cc00',   -- 🟩 green: variable's actual lifetime
    imm_borrow = '#0000cc', -- 🟦 blue: immutable borrowing
    mut_borrow = '#cc00cc', -- 🟪 purple: mutable borrowing
    move = '#cccc00',       -- 🟧 orange: value moved
    call = '#cccc00',       -- 🟧 orange: function call
    outlive = '#cc0000',    -- 🟥 red: lifetime error
  },
}

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
  (rustowl
    :host github
    :repo "cordx56/rustowl"))

Then use-package:

(use-package rustowl
  :after lsp-mode)

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.

Sublime Text

There is a third-party repository that supports Sublime Text.

Architecture / OS / package repositories

Cargo Binstall

One of the easiest way to install RustOwl is using cargo-binstall.

cargo binstall rustowl

Toolchain is automatically Downloaded and unpacked.

Windows

We have a winget package, install with:

winget install rustowl

Archlinux

We have an AUR package. It downloads prebuilt binaries from release page. Run:

yay -S rustowl-bin

If you would like to build from that version instead:

yay -S rustowl

Replace yay with your AUR helper of choice.

We also have a git version, that builds from source:

yay -S rustowl-git

Nix flake

There is a third-party Nix flake repository in the Nix community.

GitHub Release

Download only rustowl executable from release page and place it into the place you desire. Toolchain is automatically Downloaded and unpacked.

Docker

You can run rustowl using the pre-built Docker image from GitHub Container Registry (GHCR).

Pull the latest stable image

docker pull ghcr.io/cordx56/rustowl:latest

Or pull a specific version:

docker pull ghcr.io/cordx56/rustowl:v0.3.4

Run the image

docker run --rm -v /path/to/project:/app ghcr.io/cordx56/rustowl:latest

You can also pass command-line arguments as needed:

docker run --rm /path/to/project:/app ghcr.io/cordx56/rustowl:latest --help

(Optional) Use as a CLI

To use rustowl as if it were installed on your system, you can create a shell alias:

alias rustowl='docker run --rm -v $(pwd):/app ghcr.io/cordx56/rustowl:latest'

Now you can run rustowl from your terminal like a regular command.

Build manually

There is a build guide to build RustOwl or extensions.

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.

Installing rustowl rustowlc executables

Adding rustowl library as a dependency

Installing `rustowl` `rustowlc` executables

Adding `rustowl` library as a dependency