RACER = Rust Auto-Complete-er. A utility intended to provide Rust code completion for editors and IDEs. Maybe one day the 'er' bit will be exploring + refactoring or something.
NOTE From 2.1, racer needs nightly rust
If you're using rustup, run
rustup toolchain add nightly
From 2.1, racer depends on cargo, so you have to install its dependencies
On Linux, you will need cmake, pkg-config and zlib:
sudo apt-get install cmake pkg-config zlib1g-dev libssl-devsudo dnf install cmake pkgconfig zlib-devel openssl-develOn Windows, you will need to have cmake installed.
It's a bit confusing and we're plannig to remove this dependency in the futute.
cargo installSimply run:
cargo +nightly install racer
As mentioned in the command output, don't forget to add the installation directory to your PATH.
Clone the repository: git clone https://github.com/racer-rust/racer.git
cd racer; cargo +nightly build --release. The binary will now be in ./target/release/racer
Add the binary to your PATH. This can be done by moving it to a directory already in your PATH (i.e. /usr/local/bin) or by adding the ./target/release/ directory to your PATH
Fetch the Rust sourcecode
automatically via rustup and run rustup component add rust-src in order to install the source to $(rustc --print sysroot)/lib/rustlib/src/rust/src. Rustup will keep the sources in sync with the toolchain if you run rustup update.
manually from git: https://github.com/rust-lang/rust
Note
If you want to use racer with multiple release channels (Rust has 3 release channels: stable, beta and nightly), you have to also download Rust source code for each release channel you install.
e.g. (rustup case) Add a nightly toolchain build and install nightly sources too
rustup toolchain add nightly
rustup component add rust-src
(Optional) Set RUST_SRC_PATH environment variable to point to the 'src' dir in the Rust source installation
e.g. % export RUST_SRC_PATH=/usr/local/src/rust/src or % export RUST_SRC_PATH="$(rustc --print sysroot)/lib/rustlib/src/rust/src"
It's recommended to set RUST_SRC_PATH for speed up, but racer detects it automatically if you don't set it.
Test on the command line:
racer complete std::io::B (should show some completions)
Note
To complete names in extrenal crates, Racer needs Cargo.lock.
So, when you add a dependency in your Cargo.toml, you have to run a build command
such as cargo build or cargo test, to get completions.
Racer is used as a static library in RLS
Racer can be used with Eclipse through the use of RustDT. (User guide is linked in repo description)
Emacs integration has been moved to a separate project: emacs-racer.
Gedit integration can be found here.
Gnome Builder integration can be found here
The Kate community maintains a plugin. It is bundled with recent releases of Kate (tested with 16.08 - read more here).
Enable 'Rust code completion' in the plugin list in the Kate config dialog;
On the new 'Rust code completion' dialog page, make sure 'Racer command' and 'Rust source tree location' are set correctly.
The Sublime Text community maintains some packages that integrates Racer * RustAutoComplete that offers auto completion and goto definition. * AnacondaRUST from the anaconda plugins family that offers auto completion, goto definition and show documentation
Vim integration has been moved to a separate project: vim-racer.
Racer recommends the vscode-rust extension. This is an actively-maintained fork of the now-deprecated RustyCode extension.
You can find the racer package for Atom here
Kakoune comes with a builtin integration for racer auto completion.