emacs-racer
An Emacs package providing Rust code completion, definition lookup, and documentation via Racer.
What is emacs-racer?
racer.el is the official Emacs package for Racer, a Rust code completion tool. It integrates with Emacs to provide intelligent Rust development features like code completion, definition lookup, and documentation display directly within the editor, enhancing productivity for Rust programmers.
Rust developers who use Emacs as their primary editor and want IDE-like features such as code completion, navigation, and inline documentation for Rust projects.
Developers choose racer.el for its seamless integration with Emacs and rust-mode, offering a native editing experience with configurable timeouts to maintain responsiveness, and compatibility with company-mode for enhanced completions.
Overview
Racer support for Emacs
Use Cases
Best For
- Adding intelligent code completion for variables, functions, and modules in Rust files within Emacs.
- Jumping to definitions of functions and types in Rust code using Emacs keybindings like M-. and M-,
- Displaying docstrings and type information for Rust code via M-x racer-describe in a help buffer.
- Integrating Racer's capabilities with company-mode for automatic completions in Emacs.
- Debugging Racer command execution and output in Emacs using M-x racer-debug.
- Setting up a responsive Rust development environment in Emacs with configurable timeouts for racer-command-timeout and racer-eldoc-timeout.
Not Ideal For
- Rust developers using IDEs like VS Code where Racer has more integrated and maintained extensions.
- Projects heavily reliant on Rust macros for metaprogramming, as racer.el cannot complete macros due to backend limitations.
- Teams wanting a plug-and-play setup without managing nightly Rust toolchains and manual Emacs configuration.
- Environments where Emacs must handle large codebases with zero latency, as timeouts might cause delays or require fine-tuning.
Pros & Cons
Pros
Automatically activates with rust-mode and seamlessly hooks into company-mode for completions, providing a native editing experience as outlined in the installation configuration with add-hook directives.
Enables jumping to definitions with M-. and returning with M-, plus describing functions/types via M-x racer-describe, with visual examples and keybindings detailed in the README sections.
Offers customizable timeouts like racer-command-timeout and racer-eldoc-timeout to prevent Emacs from hanging, explicitly advised in the setup to maintain performance on varying machine speeds.
Includes racer-debug to troubleshoot command execution and output, useful for diagnosing setup issues when completions fail, as highlighted in the testing section of the README.
Cons
Cannot offer completion for Rust macros due to a known limitation in the underlying Racer tool, as explicitly stated in the Completion section of the README, which hinders metaprogramming workflows.
Requires installing nightly Rust via rustup, the racer binary, rust-src, and manual Emacs configuration with hooks, making it more cumbersome than more modern, integrated alternatives.
Needs careful adjustment of timeouts to avoid making Emacs unresponsive during indexing or on slower systems, indicating potential slowdowns that require user intervention to optimize.
Frequently Asked Questions
Related Projects
LapceLightning-fast and Powerful Code Editor written in Rust
intellij-rustRust plugin for the IntelliJ Platform
rust.vimVim configuration for Rust.
LanguageClient-neovimLanguage Server Protocol (LSP) support for vim and neovim.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.