rust-analyzer/docs/book/src
2025-12-21 14:02:48 +00:00
..
contributing Merge pull request #20472 from BenjaminBrienen/remove-style-point 2025-12-21 14:02:48 +00:00
assists.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
configuration.md Fix URLs and highlighting in manual 2025-11-28 11:39:40 +00:00
configuration_generated.md GC support for solver types 2025-12-18 10:12:03 +02:00
diagnostics.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
editor_features.md Update editor_features.md 2025-02-20 17:05:18 +01:00
faq.md Add a FAQ entry about RA and Cargo interaction 2025-09-09 09:12:09 +02:00
features.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
installation.md manual: Separate out installation and configuration pages 2025-02-12 10:21:09 -08:00
non_cargo_based_projects.md feat: introduce crate_attrs field in rust-project.json 2025-12-18 01:27:43 +00:00
other_editors.md Remove mdbook-toc usage 2025-12-01 14:27:20 +00:00
privacy.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
README.md Clarify intro in README and manual 2025-09-08 19:10:14 +01:00
rust_analyzer_binary.md manual: Separate out installation and configuration pages 2025-02-12 10:21:09 -08:00
security.md manual: Convert to mdbook 2025-01-24 13:23:22 -08:00
SUMMARY.md Add a testing guide 2025-09-15 10:48:26 +03:00
troubleshooting.md Fix link in the book 2025-06-25 06:30:16 +03:00
vs_code.md manual: Separate out installation and configuration pages 2025-02-12 10:21:09 -08:00

rust-analyzer

rust-analyzer is a language server that provides IDE functionality for writing Rust programs. You can use it with any editor that supports the Language Server Protocol (VS Code, Vim, Emacs, Zed, etc).

rust-analyzer features include go-to-definition, find-all-references, refactorings and code completion. rust-analyzer also supports integrated formatting (with rustfmt) and integrated diagnostics (with rustc and clippy).

Internally, rust-analyzer is structured as a set of libraries for analyzing Rust code. See Architecture for more details.

To improve this document, send a pull request: https://github.com/rust-lang/rust-analyzer

The manual is written in markdown and includes some extra files which are generated from the source code. Run cargo test and cargo xtask codegen to create these.

If you have questions about using rust-analyzer, please ask them in the "IDEs and Editors" topic of Rust users forum.