[!NOTE]

Due to lack of time, this plugin has been archived. Please switch to mrcjkb/rustaceanvim.

rust-tools.nvim

Quick Links

• Wiki

• Installation
• Setup
• Usage

Prerequisites

• neovim 0.7
• nvim-lspconfig
• rust-analyzer
• dot from graphviz (only for crate graph)

Installation

using packer.nvim

use 'neovim/nvim-lspconfig'
use 'simrat39/rust-tools.nvim'
-- Debugging use 'nvim-lua/plenary.nvim' use 'mfussenegger/nvim-dap'

Setup

Put this in your init.lua or any lua file that is sourced.

For most people, the defaults are fine, but for advanced configuration, see Configuration.

Example config:

local rt = require("rust-tools")

rt.setup({   server = {     onattach = function(, bufnr)       -- Hover actions       vim.keymap.set("n", "<C-space>", rt.hoveractions.hoveractions, { buffer = bufnr })       -- Code action groups       vim.keymap.set("n", "<Leader>a", rt.codeactiongroup.codeactiongroup, { buffer = bufnr })     end,   }, })

Usage

Debugging

Inlay Hints

-- Commands:   -- RustEnableInlayHints   -- RustDisableInlayHints   -- RustSetInlayHints   -- RustUnsetInlayHints

-- Set inlay hints for the current buffer   require('rust-tools').inlay_hints.set()   -- Unset inlay hints for the current buffer   require('rust-tools').inlay_hints.unset()
-- Enable inlay hints auto update and set them for all the buffers   require('rust-tools').inlay_hints.enable()   -- Disable inlay hints auto update and unset them for all buffers   require('rust-tools').inlay_hints.disable()

Runnables

-- Command:   -- RustRunnables   require('rust-tools').runnables.runnables()

Expand Macros Recursively

-- Command:   -- RustExpandMacro     require'rust-tools'.expandmacro.expandmacro()

Move Item Up/Down

-- Command:   -- RustMoveItemUp       -- RustMoveItemDown       local up = true -- true = move up, false = move down   require'rust-tools'.moveitem.moveitem(up)

Hover Actions

Note: To activate hover actions, run the command twice (or your hover keymap if you have

set to true AND are using

.lsp.buf.hover()

). This will move you into the window, then press enter on the selection you want. Alternatively, you can set

to true in your config and you will automatically enter the hover actions window.

-- Command:  -- RustHoverActions   require'rust-tools'.hoveractions.hoveractions()

-- Command:   -- RustHoverRange    require'rust-tools'.hoverrange.hoverrange()

Open Cargo.toml

-- Command:   -- RustOpenCargo   require'rust-tools'.opencargotoml.opencargotoml()

Parent Module

-- Command:   -- RustParentModule    require'rust-tools'.parentmodule.parentmodule()

Join Lines

-- Command:   -- RustJoinLines     require'rust-tools'.joinlines.joinlines()

-- Command:   -- RustSSR [query]   require'rust-tools'.ssr.ssr(query)

-- Command:   -- RustViewCrateGraph [backend [output]]   require'rust-tools'.crategraph.viewcrate_graph(backend, output)

Configuration

local opts = {
  tools = { -- rust-tools options
-- how to execute terminal commands     -- options right now: termopen / quickfix / toggleterm / vimux     executor = require("rust-tools.executors").termopen,
-- callback to execute once rust-analyzer is done initializing the workspace     -- The callback receives one parameter indicating the health of the server: "ok" | "warning" | "error"     on_initialized = nil,
-- automatically call RustReloadWorkspace when writing to a Cargo.toml file.     reloadworkspacefromcargotoml = true,
-- These apply to the default RustSetInlayHints command     inlay_hints = {       -- automatically set inlay hints (type hints)       -- default: true       auto = true,
-- Only show inlay hints for the current line       onlycurrentline = false,
-- whether to show parameter hints with the inlay hints or not       -- default: true       showparameterhints = true,
-- prefix for parameter hints       -- default: "<-"       parameterhintsprefix = "<- ",
-- prefix for all the other hints (type, chaining)       -- default: "=>"       otherhintsprefix = "=> ",
-- whether to align to the length of the longest line in the file       maxlenalign = false,
-- padding from the left if maxlenalign is true       maxlenalign_padding = 1,
-- whether to align to the extreme right or not       right_align = false,
-- padding from the right if right_align is true       rightalignpadding = 7,
-- The color of the hints       highlight = "Comment",     },
-- options same as lsp hover / vim.lsp.util.openfloatingpreview()     hover_actions = {
-- the border that is used for the hover window       -- see vim.api.nvimopenwin()       border = {         { "╭", "FloatBorder" },         { "─", "FloatBorder" },         { "╮", "FloatBorder" },         { "│", "FloatBorder" },         { "╯", "FloatBorder" },         { "─", "FloatBorder" },         { "╰", "FloatBorder" },         { "│", "FloatBorder" },       },
-- Maximal width of the hover window. Nil means no max.       max_width = nil,
-- Maximal height of the hover window. Nil means no max.       max_height = nil,
-- whether the hover action window gets automatically focused       -- default: false       auto_focus = false,     },
-- settings for showing the crate graph based on graphviz and the dot     -- command     crate_graph = {       -- Backend used for displaying the graph       -- see: https://graphviz.org/docs/outputs/       -- default: x11       backend = "x11",       -- where to store the output, nil for no output stored (relative       -- path from pwd)       -- default: nil       output = nil,       -- true for all crates.io and external crates, false only the local       -- crates       -- default: true       full = true,
-- List of backends found on: https://graphviz.org/docs/outputs/       -- Is used for input validation and autocompletion       -- Last updated: 2021-08-26       enabledgraphvizbackends = {         "bmp",         "cgimage",         "canon",         "dot",         "gv",         "xdot",         "xdot1.2",         "xdot1.4",         "eps",         "exr",         "fig",         "gd",         "gd2",         "gif",         "gtk",         "ico",         "cmap",         "ismap",         "imap",         "cmapx",         "imap_np",         "cmapx_np",         "jpg",         "jpeg",         "jpe",         "jp2",         "json",         "json0",         "dot_json",         "xdot_json",         "pdf",         "pic",         "pct",         "pict",         "plain",         "plain-ext",         "png",         "pov",         "ps",         "ps2",         "psd",         "sgi",         "svg",         "svgz",         "tga",         "tiff",         "tif",         "tk",         "vml",         "vmlz",         "wbmp",         "webp",         "xlib",         "x11",       },     },   },
-- all the opts to send to nvim-lspconfig   -- these override the defaults set by rust-tools.nvim   -- see https://github.com/neovim/nvim-lspconfig/blob/master/doc/serverconfigurations.md#rustanalyzer   server = {     -- standalone file support     -- setting it to false may improve startup time     standalone = true,   }, -- rust-analyzer options
-- debugging stuff   dap = {     adapter = {       type = "executable",       command = "lldb-vscode",       name = "rt_lldb",     },   }, }
require('rust-tools').setup(opts)

Related Projects

• Saecki/crates.nvim

Inspiration