racer 1.2.9

Code completion for Rust
Documentation

Racer - code completion for Rust

Build Status

racer completion screenshot

racer eldoc screenshot

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.

Installation

With cargo install

This method requires Rust 1.5. Simply run:

cargo install racer

As mentioned in the command output, don't forget to add the installation directory to your PATH.

From sources

  1. Clone the repository: git clone https://github.com/phildawes/racer.git

  2. cd racer; cargo build --release. The binary will now be in ./target/release/racer

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

Configuration

  1. Fetch the Rust sourcecode from git, or download from https://www.rust-lang.org/install.html (the 'rustc' source download behind the 'source' link is the right one)

  2. Set the 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 )

  3. Test on the command line:

    racer complete std::io::B (should show some completions)

Note for rustup/multirust-rs users

This does not apply to multirust!

To enable completion for cargo crates, you need to set the CARGO_HOME environment variable to .cargo in your home directory.

Editors/IDEs Supported

Eclipse integration

Racer can be used with Eclipse through the use of RustDT. (User guide is linked in repo description)

Emacs integration

Emacs integration has been moved to a separate project: emacs-racer.

Gedit integration

Gedit integration can be found here.

Kate integration

The Kate community maintains a plugin. It will be bundled with future releases of Kate (read more here).

  1. Enable 'Rust code completion' in the plugin list in the Kate config dialog;

  2. On the new 'Rust code completion' dialog page, make sure 'Racer command' and 'Rust source tree location' are set correctly.

Sublime Text integration

The Sublime Text community maintains a plugin.

Vim integration

Vim integration has been moved to a separate project: vim-racer.

Visual Studio Code extension

You can find more info about Visual Studio Code extension here.

Atom integration

You can find the racer package for Atom here