Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Before anything else, rust-src is mandatory for the project to work correctly, so don’t forget to run rustup component add rust-src if you’re not sure if you have it installed.

Right now, the primary editor for Rust Glancer is VS Code. It should be usable with other editors that natively support LSP, and you can try following the instructions rust-analyzer provides.

Native support for more editors is expected in future.

When you install Rust Glancer, do not forget to turn rust-analyzer off. They should work together just fine (I’ve done that and did not have any conflicts), but it’s kind of meaningless to run both.

VS Code

You have two options:

  1. Install the extension from the official marketplace.
  2. Build and install VSIX from the repository.

The extension is maintained and will be updated, but given that VS Code extensions often become targets of attacks nowadays, I’d probably recommend building from source (or at least disabling auto-updates). Please do not forget to update it from time to time though. There will be good things in updates (probably).

Installing from VSIX

  1. (Optional) Install just
  2. Clone the repository
  3. Run just package-vsix (or go to editors/code and build via npm)
  4. Open VS Code, navigate to extensions tab, click on ... and choose Install from VSIX.
  5. Install the extension.
  6. ???
  7. PROFIT