TakeV/spacemacs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
spacemacs/layers/+lang/rust
History
syl20bnr 9606dd344e [dap] Refactor configuration dap config in layers 
* use local-vars-hook coupled to setup function for dap
* define new private layer variable `spacemacs--dap-supported-modes` to
  configure key bindings. This allows to move the key bindings definition from
  `funcs.el` to `packages.el`
* remove duplication of DAP key bindings in READMEs by pointing to the dap layer
  documentation
* alphabetically sort package configuration
2019-09-30 00:34:26 -04:00
..
img
config.el Remove lsp-javascript-typescript package for lsp built in. 2019-01-15 00:41:30 +02:00
funcs.el [dap] Refactor configuration dap config in layers 2019-09-30 00:34:26 -04:00
packages.el [dap] Refactor configuration dap config in layers 2019-09-30 00:34:26 -04:00
README.org [dap] Refactor configuration dap config in layers 2019-09-30 00:34:26 -04:00

README.org

Rust layer

/TakeV/spacemacs/media/commit/9606dd344e1bd86409e910e4b29842c3a1013fcc/layers/+lang/rust/img/rust.png

Description

This layer supports Rust development in Spacemacs.

Features:

  • Auto-completion and navigation support through lsp or Racer
  • Interactive debugger using dap-mode
  • support for the Rust package manager Cargo

Install

Layer

To use this configuration layer, add it to your ~/.spacemacs. You will need to add rust to the existing dotspacemacs-configuration-layers list in this file.

Backends

The backend is dependent upon the rust-backend layer configuration variable. The possible vaules for rust-backend are lsp or racer with racer being the default.

Racer

You must install Racer to use this backend. Make sure the racer binary is available in your PATH and to set the environment variable RUST_SRC_PATH, as described in the installation instructions.

To enable auto-completion, ensure that the auto-completion layer is enabled.

LSP

You must add lsp to the existing dotspacemacs-configuration-layers in your ~/.spacemacs.

Consult the installation command for the desired language server found at lsp-mode for instructions.

To enable auto-completion, ensure that the auto-completion layer is enabled.

Debugger (dap integration)

To install the debug adapter you may run M-x dap-gdb-lldb-setup when you are on Linux or download it manually from Native Debug and adjust dap-gdb-lldb-path.

Cargo

Cargo is a project management command line tool for Rust. Installation instructions can be found on the main page of Cargo.

Rustfmt

Format Rust code according to style guidelines using rustfmt.

  cargo install rustfmt

To enable automatic buffer formatting on save, set the variable rust-format-on-save to t.

Key bindings

Key binding Description
SPC m = = reformat the buffer
SPC m c . repeat the last Cargo command
SPC m c C remove build artifacts with Cargo
SPC m c X execute a project example with Cargo
SPC m c c compile project with Cargo
SPC m c d generate documentation with Cargo
SPC m c e run benchmarks with Cargo
SPC m c f format all project files with rustfmt
SPC m c i create a new project with Cargo (init)
SPC m c l run linter (cargo-clippy) with Cargo
SPC m c n create a new project with Cargo (new)
SPC m c o run all tests in current file with Cargo
SPC m c s search for packages on crates.io with Cargo
SPC m c t run the current test with Cargo
SPC m c u update dependencies with Cargo
SPC m c x execute a project with Cargo
SPC m c v check (verify) a project with Cargo
SPC m g g jump to definition
SPC m h h describe symbol at point
SPC m t run tests with Cargo

debugger

Using the dap layer you'll get access to all the DAP key bindings, see the complete list of key bindings on the dap layer description.