1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-25 07:30:04 +08:00
SpaceVim/docs/cn/layers/lang/rust.md

91 lines
3.3 KiB
Markdown
Raw Normal View History

---
title: "SpaceVim lang#rust 模块"
2019-02-03 20:51:01 +08:00
description: "这一模块为 Rust 开发提供支持,包括代码补全、语法检查、代码格式化等特性。"
2019-10-04 14:13:51 +08:00
lang: zh
---
# [可用模块](../../) >> lang#rust
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
2020-03-04 20:13:16 +08:00
- [语言工具](#语言工具)
2019-03-18 00:12:11 +08:00
- [模块选项](#模块选项)
- [快捷键](#快捷键)
2020-07-31 22:25:33 +08:00
- [交互式编程](#交互式编程)
- [运行当前脚本](#运行当前脚本)
<!-- vim-markdown-toc -->
## 模块简介
2019-02-03 20:51:01 +08:00
这一模块为 SpaceVim 提供了 Rust 开发支持,包括代码补全、语法检查以及代码格式化等特性。
## 功能特性
- 代码补全
- 文档查询
- 跳转定义处
2019-02-03 20:51:01 +08:00
同时SpaceVim 还为 Rust 开发提供了交互式编程、一键运行和语言服务器等功能。若要启用语言服务器,需要载入 `lsp` 模块。
## 启用模块
可通过在配置文件内加入如下配置来启用该模块:
```toml
[[layers]]
name = "lang#rust"
```
2020-03-04 20:13:16 +08:00
### 语言工具
- [evcxr](https://github.com/google/evcxr): Rust 交互式编程命令行工具。
2019-03-18 00:12:11 +08:00
## 模块选项
2020-07-31 22:25:33 +08:00
- `recommended_style`: `true`/`false` (启用/禁用) rust 推荐的代码规范,该选项默认已禁用。
- `format_on_save`: `true`/`false` (启动/禁用) 保存文件修改后自动格式化,该选项默认已禁用。
- `racer_cmd`: 可执行文件 `racer` 的路径,该选项默认为 `racer`
- `rustfmt_cmd`: 可执行文件 `rustfmt` 的路径,该选项默认为 `rustfmt`
2019-03-18 00:12:11 +08:00
## 快捷键
2020-02-06 13:31:07 +08:00
| 快捷键 | 功能描述 |
| --------------- | ---------------------------------------------- |
| `g d` | 跳至函数或变量定义处 |
| `SPC l d` / `K` | 展示光标函数或变量相关文档 |
2020-07-31 22:25:33 +08:00
| `SPC l g` | 跳至函数或变量定义处 (split) |
| `SPC l v` | 跳至函数或变量定义处 (vertical) |
2020-02-06 13:31:07 +08:00
| `SPC l e` | 重命名光标函数或变量(需要 `lsp` 模块) |
| `SPC l u` | 显示光标函数或变量的所有引用 (需要 `lsp` 模块) |
| `SPC l c b` | 运行 `cargo build` |
| `SPC l c c` | 运行 `cargo clean` |
| `SPC l c f` | 运行 `cargo fmt` |
| `SPC l c t` | 运行 `cargo test` |
| `SPC l c u` | 运行 `cargo update` |
| `SPC l c B` | 运行 `cargo bench` |
| `SPC l c D` | 运行 `cargo doc` |
| `SPC l c r` | 运行 `cargo run` |
2020-07-31 22:25:33 +08:00
**注意:** 当为rust启用lsp模块后`SPC l g`和`SPC l v`这两个快捷键将不可用。
### 交互式编程
启动 `evcxr` 交互进程,快捷键为: `SPC l s i`
将代码传输给 REPL 进程执行:
| 快捷键 | 功能描述 |
| ----------- | ----------------------- |
| `SPC l s b` | 发送整个文件内容至 REPL |
| `SPC l s l` | 发送当前行内容至 REPL |
| `SPC l s s` | 发送已选中的内容至 REPL |
### 运行当前脚本
在编辑 rust 文件时,可通过快捷键 `SPC l r` 快速异步运行当前文件,运行结果会展示在一个独立的执行窗口内。