Note

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

rust-tools.nvim

A plugin to improve your rust experience in neovim.

Quick Links

• Wiki
  • CodeLLDB Debugging
  • Standalone File
• 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'-- Debugginguse'nvim-lua/plenary.nvim'use'mfussenegger/nvim-dap'

Look at the configuration information below to get started.

Setup

This plugin automatically sets up nvim-lspconfig for rust_analyzer for you, so don't do that manually, as it causes conflicts.

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:

localrt=require("rust-tools")
rt.setup({
server= {
on_attach=function(_, bufnr)
-- Hover actionsvim.keymap.set("n", "<C-space>", rt.hover_actions.hover_actions, { buffer=bufnr })
-- Code action groupsvim.keymap.set("n", "<Leader>a", rt.code_action_group.code_action_group, { buffer=bufnr })
end,
},
})

Usage

Debugging

Inlay Hints

-- Commands:-- RustEnableInlayHints-- RustDisableInlayHints-- RustSetInlayHints-- RustUnsetInlayHints-- Set inlay hints for the current bufferrequire('rust-tools').inlay_hints.set()
-- Unset inlay hints for the current bufferrequire('rust-tools').inlay_hints.unset()
-- Enable inlay hints auto update and set them for all the buffersrequire('rust-tools').inlay_hints.enable()
-- Disable inlay hints auto update and unset them for all buffersrequire('rust-tools').inlay_hints.disable()

Runnables

-- Command:-- RustRunnablesrequire('rust-tools').runnables.runnables()

Expand Macros Recursively

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

Move Item Up/Down

-- Command:-- RustMoveItemUp -- RustMoveItemDown localup=true-- true = move up, false = move downrequire'rust-tools'.move_item.move_item(up)

Hover Actions

Note: To activate hover actions, run the command twice (or your hover keymap if you have hover_with_actions set to true AND are using vim.lsp.buf.hover()). This will move you into the window, then press enter on the selection you want. Alternatively, you can set auto_focus to true in your config and you will automatically enter the hover actions window.

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

Hover Range

Note: Requires rust-analyzer version after 2021-08-02. Shows the type in visual mode when hovering.

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

Open Cargo.toml

-- Command:-- RustOpenCargorequire'rust-tools'.open_cargo_toml.open_cargo_toml()

Parent Module

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

Join Lines

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

Structural Search Replace

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

View Crate Graph

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

Configuration

The options shown below are the defaults. You only need to pass the keys to the setup function that you want to be changed, because the defaults are applied for keys that are not provided.

localopts= {
tools= { -- rust-tools options-- how to execute terminal commands-- options right now: termopen / quickfix / toggleterm / vimuxexecutor=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.reload_workspace_from_cargo_toml=true,
-- These apply to the default RustSetInlayHints commandinlay_hints= {
-- automatically set inlay hints (type hints)-- default: trueauto=true,
-- Only show inlay hints for the current lineonly_current_line=false,
-- whether to show parameter hints with the inlay hints or not-- default: trueshow_parameter_hints=true,
-- prefix for parameter hints-- default: "<-"parameter_hints_prefix="<- ",
-- prefix for all the other hints (type, chaining)-- default: "=>"other_hints_prefix="=> ",
-- whether to align to the length of the longest line in the filemax_len_align=false,
-- padding from the left if max_len_align is truemax_len_align_padding=1,
-- whether to align to the extreme right or notright_align=false,
-- padding from the right if right_align is trueright_align_padding=7,
-- The color of the hintshighlight="Comment",
},
-- options same as lsp hover / vim.lsp.util.open_floating_preview()hover_actions= {
-- the border that is used for the hover window-- see vim.api.nvim_open_win()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: falseauto_focus=false,
},
-- settings for showing the crate graph based on graphviz and the dot-- commandcrate_graph= {
-- Backend used for displaying the graph-- see: https://graphviz.org/docs/outputs/-- default: x11backend="x11",
-- where to store the output, nil for no output stored (relative-- path from pwd)-- default: niloutput=nil,
-- true for all crates.io and external crates, false only the local-- crates-- default: truefull=true,
-- List of backends found on: https://graphviz.org/docs/outputs/-- Is used for input validation and autocompletion-- Last updated: 2021-08-26enabled_graphviz_backends= {
"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/server_configurations.md#rust_analyzerserver= {
-- standalone file support-- setting it to false may improve startup timestandalone=true,
}, -- rust-analyzer options-- debugging stuffdap= {
adapter= {
type="executable",
command="lldb-vscode",
name="rt_lldb",
},
},
}
require('rust-tools').setup(opts)

Related Projects

• Saecki/crates.nvim

Inspiration

This plugin draws inspiration from akinsho/flutter-tools.nvim