rust 环境准备

1 rustup¹

1.1 设计思路

---

1.2 安装(rustup这章可只看这个)

1. 配置国内源²

zsh

echo 'export RUSTUP_UPDATE_ROOT=https://mirrors.tuna.tsinghua.edu.cn/rustup/rustup' >> ~/.zshrc
echo 'export RUSTUP_DIST_SERVER=https://mirrors.tuna.tsinghua.edu.cn/rustup' >> ~/.zshrc
. ~/.zshrc

bash

echo 'export RUSTUP_UPDATE_ROOT=https://mirrors.tuna.tsinghua.edu.cn/rustup/rustup' >> ~/.bash_profile
echo 'export RUSTUP_DIST_SERVER=https://mirrors.tuna.tsinghua.edu.cn/rustup' >> ~/.bash_profile
. ~/.bash_profile

2. 然后查看官方安装教程³

安装

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

会提示出下列信息

2   default host triple: x86_64-apple-darwin
1     default toolchain: stable (default)
3               profile: default
  modify PATH variable: yes

1

指定toolchain 从 stable channel 中下载最新的工具链

2

很显然工具链是有系统区分的,所以系统会默认给你添加上这个信息(rustup target list命令查看),
和指定的stable channel名一起真正构成 toolchain的名字

3

配置下载哪些 components

安装过程我们可以看到 info: installing component 'rust-docs' 这类信息,说明安装了不少组件

所有组件的代理程序都安装到 ~/.cargo/bin 这个目录 (看设计思路中图2说明)

tree ~/.cargo/bin
~/.cargo/bin
├── cargo # Rust 的编译工具,包管理器,可以帮助你编译代码,运行,测试...
├── cargo-clippy
├── cargo-fmt
├── cargo-miri
├── clippy-driver
1├── rls
├── rust-analyzer
├── rust-gdb
├── rust-gdbgui
├── rust-lldb
├── rustc # rust 编译器
├── rustdoc
├── rustfmt
└── rustup

1

由于我们用的profile是default配置, 根据前面的设计思路, 这里的2个是代理程序,实际对应的可执行程序还没有安装, 需要我们额外去安装

Important

• rls (需要rust-analysis 配合使用) 已经被 rust-analyzer 取代了 ,所以我们安装 rust-analyzer 即可
• rust-analyzer⁴, vscode中去安装

安装额外需要的组件

# RLS的全称是:'Rust Language Server',是一个守护进程
# 用于和开发时使用的IDE进行IPC通信,完成代码提示、跳转到定义、显示变量类型等功能
# rustup component add rls           --toolchain stable    # RLS
# rustup component add rust-analysis --toolchain stable    # 分析工具
rustup component add rust-analyzer --toolchain stable

#std是Rust的标准库. 默认情况下,Rust安装的是标准库的二进制码,而添加源码后容易方便我们查询部分标准库的实现
rustup component add rust-src      --toolchain stable    # std源码

3. 环境变量配置

zsh

echo 'source "$HOME/.cargo/env"' >> ~/.zshrc

4. 命令自动补全

用这个命令看如何配置

rustup help completions

zsh

Warning

不知道啥情况, 设置后 有一点自动补全,但是 效果很烂

mkdir ~/.zfunc
rustup completions zsh > ~/.zfunc/_rustup
rustup completions zsh cargo > ~/.zfunc/_cargo
echo 'fpath+=~/.zfunc' >> ~/.zshrc
echo 'autoload -U compinit && compinit' >> ~/.zshrc
. ~/.zshrc

1.3 常用命令

1.3.1 全局信息

rustup show
    # Default host: x86_64-apple-darwin
    # rustup home:  ~/.rustup

    # stable-x86_64-apple-darwin (default)
    # rustc 1.80.1 (3f5fd8dd4 2024-08-06)

查看支持的平台(上面的host)

rustup target list

1.3.2 toolchain

安装

Important

rustup install 命令等同于 rustup toolchain install, 所以可以省略toolchain

nightly版本发布情况 stable版本发布情况

• 直接通过channel 方式安装

1rustup toolchain install beta --profile minimal

1

--profile minimal 前面说过, 配置下载哪些components, 这里表示下载最少的组件

• 使用[channel]-[data]的方式安装

rustup toolchain install nightly-2024-07-25 --profile minimal

国内源资源情况

• 使用 版本号 <major.minor>或<major.minor.patch>的方式安装

# 临时取消国内源(有些国内源可能没有保留的), 使用官方源下载
RUSTUP_DIST_SERVER=  rustup toolchain install 1.77 --profile minimal

查看

查看安装的toolchain

rustup toolchain list

结果

1stable-x86_64-apple-darwin (default)
beta-x86_64-apple-darwin
nightly-2024-07-25-x86_64-apple-darwin
nightly-2024-07-26-x86_64-apple-darwin
nightly-x86_64-apple-darwin
1.64-x86_64-apple-darwin
1.77-x86_64-apple-darwin

1

default 表示当前我们默认使用的toolchain
我们可以看到现实的toolchain名字都带有 -x86_64-apple-darwin,系统会自动检测,你也可以自己install时加上

执行指定工具链里的命令

# 指定 toolchain工具链 来执行它里面的 工具
rustup run stable rustc --version
# 同上
rustup run stable-x86_64-apple-darwin rustc --version
# 因为默认 使用 stable , 所以这里是调用 stable 里的, 同上
rustc --version

点击查看执行结果

rustc 1.80.1 (3f5fd8dd4 2024-08-06)

切换

全局切换

# 看看有哪些 toolchain
rustup toolchain list
#   stable/nightly/beta
rustup default stable

工作目录切换版本

cd rust项目代码目录
rustup override set 1.77.2
# 取消当前工作目录的版本, 重新设置为默认的全局版本
rustup override unset

查看命令的真实路径

rustup which rustc

查看结果

~/.rustup/toolchains/stable-x86_64-apple-darwin/bin/rustc

指定toolchain

#  看看指定命令 实际的可执行的位置
rustup which rustc  --toolchain=nightly-2024-07-25-x86_64-apple-darwin

更新

更新rustup 自身

rustup self update

更新所有toolchain

rustup update

更新指定toolchain

rustup update nightly

卸载

# 会删除所有的工具链
# 注意, 卸载后, rustup 本身也没了,需要重新安装
rustup self uninstall

卸载指定toolchain

rustup toolchain uninstall nightly

1.3.3 components

查看

# 查看默认toolchain下已经安装的组件
rustup component list --installed
# 查看指定toolchain下已经安装的组件
rustup component list --installed --toolchain nightly

添加

rustup component add rust-analyzer
# 指定toolchain
rustup component add rust-analyzer --toolchain stable

2 其他准备

2.1 cargo generate⁵

安装

# 用于根据模板生成代码
# 安装后,会在~/.cargo/bin下看到 cargo-generate可执行文件(这个不是代理程序)
# 现在可以这样 cargo generate xxx/yyy (github 模板仓库 url)  创建项目
cargo install cargo-generate

或者 直接下载可执行文件 https://github.com/cargo-generate/cargo-generate/releases 放到 ~/.cargo/bin/

使用

# templates on github
cargo generate --git https://github.com/username-on-github/mytemplate.git
# 同上
cargo generate username-on-github/mytemplate
# 同上
cargo generate gh:username-on-github/mytemplate

# 其他平台的 templates
# translates to https://gitlab.com/username-on-gitlab/mytemplate.git
cargo generate gl:username-on-gitlab/mytemplate
# translates to https://bitbucket.org/username-on-bitbucket/
cargo generate bb:username-on-bitbucket/mytemplate mytemplate.git
# translates to https://git.sr.ht/~username-on-sourcehut/mytemplate (主意有波浪号)
cargo generate sr:username-on-sourcehut/mytemplate

cargo help generate

2.2 cargo deny⁶

# 安装 Cargo deny 用于检查依赖的安全性
# 替代 cargo-audit 这个同类型工具
cargo install --locked cargo-deny
# 在项目目录下 初始化, 会生成一个deny.toml 文件
cargo deny init

deny.toml

2.3 typos⁷

# 英文单词拼写检查工具
cargo install typos-cli

_typos.toml 配置文件放到项目下

[default]
extend-ignore-identifiers-re = [
    # *sigh* this just isn't worth the cost of fixing
    "AttributeID.*Supress.*",
]

[default.extend-identifiers]
# *sigh* this just isn't worth the cost of fixing
AttributeIDSupressMenu = "AttributeIDSupressMenu"

[default.extend-words]
# Don't correct the surname "Teh"
teh = "teh"

[files]
# 排除该目录下的所有的*.po文件,不用检查
extend-exclude = ["localized/*.po"]

2.4 cargo-nextest⁸

# 安装 rust test 增强工具
cargo install cargo-nextest --locked

2.5 pre-commit 配置

代码仓库中添加 .pre-commit-config.yaml

fail_fast: false
repos:
1  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.3.0
    hooks:
      - id: check-byte-order-marker
      - id: check-case-conflict
      - id: check-merge-conflict
      - id: check-symlinks
      - id: check-yaml
      - id: end-of-file-fixer
      - id: mixed-line-ending
      - id: trailing-whitespace
  - repo: https://github.com/psf/black
    rev: 22.10.0
    hooks:
      - id: black
  - repo: https://github.com/crate-ci/typos  
    rev: v1.8.1
    hooks:
      - id: typos
2  - repo: local
    hooks:
      - id: cargo-fmt
        name: cargo fmt
        description: Format files with rustfmt.
        entry: bash -c 'cargo fmt -- --check'
        language: rust
        files: \.rs$
        args: []
      - id: cargo-deny
        name: cargo deny check
        description: Check cargo dependencies 检查依赖的安全性
        entry: bash -c 'cargo deny check -d'
        language: rust
        files: \.rs$
        args: []
      - id: cargo-check
        name: cargo check
        description: Check the package for errors.
        entry: bash -c 'cargo check --all'
        language: rust
        files: \.rs$
        pass_filenames: false
      - id: cargo-clippy
        name: cargo clippy
        description: Lint rust sources
        entry: bash -c 'cargo clippy --all-targets --all-features --tests --benches -- -D warnings'
        language: rust
        files: \.rs$
        pass_filenames: false
      - id: cargo-test
        name: cargo test
        description: unit test for the project
        entry: bash -c 'cargo nextest run --all-features'
        language: rust
        files: \.rs$
        pass_filenames: false

1

使用网络上别人提供的hook 脚本

2

自己本地自定义, 可以在下面看到自己写的脚本

更新上面配置里设置的repos的版本

# 在项目目录下执行
pre-commit autoupdate

点击查看执行结果

[https://github.com/pre-commit/pre-commit-hooks] updating v4.3.0 -> v4.6.0
[https://github.com/psf/black] updating 22.10.0 -> 24.8.0
[https://github.com/crate-ci/typos] updating v1.8.1 -> v1.24.6

3 查看文档

查看本地离线的rust文档,浏览器会自动打开文档, 可以看到好多教程可以点击查看

rustup doc

这个会打开 The Rust Programming Language 这本教程

rustup docs --book

# 查看帮助,可以看到其他book的 命令
rustup docs --help
# 直接打开 rust-by-example 这本书
rustup docs --rust-by-example

4 cargo简单介绍

cargo new hello 
cd hello
tree -a
# 会创建目录world, 并且 直接有 .git 纳入git管理
.
├── .git
├── .gitignore
1├── Cargo.toml
└── src
    └── main.rs

1

cargo.toml package的一些基本信息 toml参考

Cargo.toml

[package]
name = "hello"
# 注意开发时第一个 version 一般是用0.1.0 不是0.0.1
version = "0.1.0"
edition = "2021"

src/main.rs

fn main() {
    println!("Hello, world!");
}

执行命令

cargo run

运行打印的信息

1       Fresh hello v0.1.0 (~/rust2024/hello)
    Finished dev [unoptimized + debuginfo] target(s) in 0.00s
2     Running `target/debug/hello`
3Hello, world!

1

cargo 调用 rust编译器 rustc来编译代码,生成可执行文件,会放到 target/debug 目录下

2

运行 可执行文件

3

输出结果

配置crates国内源⁹, 下载依赖包就快了

Warning

cargo 1.68 及以上版本 使用 config.toml 文件名,而不是config

这个好像更快...

mkdir -vp ${CARGO_HOME:-$HOME/.cargo}

cat << EOF | tee -a ${CARGO_HOME:-$HOME/.cargo}/config.toml
[source.crates-io]
replace-with = 'ustc'

[source.ustc]
registry = "sparse+https://mirrors.ustc.edu.cn/crates.io-index/"
EOF

或者

mkdir -vp ${CARGO_HOME:-$HOME/.cargo}

cat << EOF | tee -a ${CARGO_HOME:-$HOME/.cargo}/config.toml
[source.crates-io]
replace-with = 'mirror'

[source.mirror]
registry = "sparse+https://mirrors.tuna.tsinghua.edu.cn/crates.io-index/"
EOF

5 其他说明

源码和rust语言需求讨论¹⁰

• nightly版本使用实验性功能的方法, 需要讲rust版本切换到nightly, 然后在代码中添加feature语句
• 等到这个功能稳定了,就是用了新版本的编译器,它就会提示你不需要这个feature语句了

#![feature(unboxed_closures)]
#![feature(fn_traits)]
//.....

Footnotes

1. rustup教程

2. rustup国内源

3. 官方安装教程

4. rust-analyzer

5. cargo-generate
   点击搜索别人开源的一些template
   文档

6. cargo deny

   • github
   • book
   • rust-ecosystem

7. typos

8. cargo nextest
   https://nexte.st/

9. 中科大开源镜像站
   清华大学开源软件镜像站

10. rust源码 RFC(需求讨论)