Search results
Language Servers are processes that run in the background and provide support for a wide range of syntax analysis, code refactoring, and much more. There are two language server implementations for Rust: RLS (Rust Language Server) rust-analyzer.
- Overview
- Rust Language Server (RLS)
- Setup
- Running
- Configuration
- Troubleshooting
- Contributing
RLS has been deprecated and is no longer supported. It has been replaced with rust-analyzer. Users are encouraged to uninstall RLS and follow the instructions in the rust-analyzer manual to install it for your editor.
The RLS provides a server that runs in the background, providing IDEs, editors, and other tools with information about Rust programs. It supports functionality such as 'goto definition', symbol search, reformatting, and code completion, and enables renaming and refactorings.
A high-level overview of the architecture can be found here.
The RLS gets its source data from the compiler and from Racer. Where possible it uses data from the compiler which is precise and complete. Where it is not possible, (for example for code completion and where building is too slow), it uses Racer.
Since the Rust compiler does not yet support end-to-end incremental compilation, we can't offer a perfect experience. However, by optimising our use of the compiler and falling back to Racer, we can offer a pretty good experience for small to medium sized crates. As the RLS and compiler evolve, we'll offer a better experience for larger and larger crates.
Step 1: Install rustup
You can install rustup on many platforms. This will help us quickly install the RLS and its dependencies. If you already have rustup installed, update to ensure you have the latest rustup and compiler: If you're going to use the VSCode extension, you can skip step 2.
Step 2: Install the RLS
Once you have rustup installed, run the following commands:
error: component 'rls' is unavailable for download (nightly)
The development of rustc's internals is quite fast paced. Downstream projects that rely on nightly internals, particularly clippy, can break fairly often because of this. When such breakages occur the nightly release will be missing rls. This is a trade-off compared with the other option of just not publishing the night's release, but does avoid blocking the rust nightly releases for people that don't need clippy/rls. To mitigate the issues we have: •rustup will warn if the update is missing any components you currently have. This means you can no longer accidentally update to a no-rls release. Once rls is available again it'll update. •rls, clippy are available on the stable channel. Meaning most developers installing for the first time should use stable. •However, if you need latest nightly rls you can use https://rust-lang.github.io/rustup-components-history/ to find and install a dated nightly release ie rustup install nightly-2018-12-06. Also see #641.
The RLS is built to work with many IDEs and editors, we mostly use VSCode to test the RLS. The easiest way is to use the published extension.
You'll know it's working when you see this in the status bar at the bottom, with a spinning indicator:
RLS: working ◐
Once you see:
RLS
Then you have the full set of capabilities available to you. You can goto def, find all refs, rename, goto type, etc. Completions are also available using the heuristics that Racer provides. As you type, your code will be checked and error squiggles will be reported when errors occur. You can hover these squiggles to see the text of the error.
The RLS can be configured on a per-project basis; using the Visual Studio Code extension this will be done via the workspace settings file settings.json.
Other editors will have their own way of sending the workspace/DidChangeConfiguration method. Options are nested in the rust object, so your LSP client might send {"settings":{"rust":{"unstable_features":true}}} as parameters.
Entries in this file will affect how the RLS operates and how it builds your project.
Currently we accept the following options:
•unstable_features (bool, defaults to false) enables unstable features. Currently no option requires this flag.
•sysroot (String, defaults to "") if the given string is not empty, use the given path as the sysroot for all rustc invocations instead of trying to detect the sysroot automatically
For tips on debugging and troubleshooting, see debugging.md.
You can look in the contributing.md in this repo to learn more about contributing to this project.
If you want to implement RLS support in an editor, see clients.md.
People also ask
What is Rust Language Server?
Does the rust enhanced package support a Language Server?
How do I get rust to work with my favorite IDE or editor?
Who uses rust?
The Rust Language Server (RLS) provides a standard interface for IDEs, editors and tools to interact with Rust. For users it's a hassle free way to get Rust to work with your favourite IDE or editor.
Rust has great documentation, a friendly compiler with useful error messages, and top-notch tooling — an integrated package manager and build tool, smart multi-editor support with auto-completion and type inspections, an auto-formatter, and more. Build it in Rust.
A simple tool kit helping you create language server with Rust. Some time ago I used lsp-server to implement a language server, it is very good, but I am not very comfortable with it, especially I need to write a lot of turbo fish symbols, and manual match Method fields.
A library to implement asynchronous language servers in Rust. It features. Full server and client support of the Language Server Protocol 3.15. Independent of the underlying transport layer and the used async executor.
Aug 22, 2017 · To understand how to troubleshoot the Rust Language Server (RLS), it helps to know what RLS is and how the components interact. RLS is a Rust implementation of the Language Server Protocol (LSP).
