Repository files navigation

This is a Vim plugin that providesRust file detection, syntax highlighting, formatting,Syntastic integration, and more. It requires Vim 8 or higher for full functionality.Some things may not work on earlier versions.

For activating the full functionality, this plugin requires either the pluginmanager or the.vimrc to have the following:

syntaxenablefiletypepluginindenton

Most plugin managers don't do this automatically, so these statements areusually added by users in theirvimrcright after the plugin manager loadsection.

git clone https://github.com/rust-lang/rust.vim~/.vim/pack/plugins/start/rust.vim

Plugin'rust-lang/rust.vim'

git clone --depth=1 https://github.com/rust-lang/rust.vim.git~/.vim/bundle/rust.vim

Plug'rust-lang/rust.vim'

calldein#add('rust-lang/rust.vim')

NeoBundle'rust-lang/rust.vim'

rust.vim automatically registerscargo as a syntax checker withSyntastic, if nothing else is specified. See:help rust-syntasticfor more details.

The installation of Tagbar along withUniversal Ctags is recommendedfor a good Tagbar experience. For other kinds of setups,rust.vim tries toconfigure Tagbar to some degree.

The:RustFmt command will format your code withrustfmt if installed.rustfmt can be installedviarustup component add rustfmt.

Placinglet g:rustfmt_autosave = 1 in your~/.vimrc willenable automatic running of:RustFmt when you save a buffer.

Do:help :RustFmt for further formatting help and customizationoptions.

Note: This feature requireswebapi-vim to be installed.

The:RustPlay command will send the current selection, or ifnothing is selected the current buffer, to theRust playpen.

If you set g:rust_clip_command RustPlay will copy the url to the clipboard.

• Mac:

  let g:rust_clip_command = 'pbcopy'

• Linux:

  let g:rust_clip_command = 'xclip -selection clipboard'

In a Cargo project, the:RustTest command will run the test that is under the cursor.This is useful when your project is big and running all of the tests takes a long time.

Further help can be found in the documentation with:Helptags then:help rust.

Detailed help can be found in the documentation with:help rust.Helptags (:help helptags) need to be generated for this pluginin order to navigate the help. Most plugin managers will do thisautomatically, but check their documentation if that is not the case.

Like Rust, rust.vim is primarily distributed under the terms of both the MITlicense and the Apache License (Version 2.0). See LICENSE-APACHE andLICENSE-MIT for details.