0%

《Rust》Cargo常用命令

前言

Cargo 是 Rust 官方的包管理器。类似于 nodejs 的 npm。

下面记录 Cargo 的常用命令,以供查阅。

生成新项目

App项目

1
cargo new foo

Lib项目

1
cargo new --lib foo

运行代码

1
cargo run // 自动查找 src 目录下的 main.rs 文件

编译代码

1
cargo build // 自动查找 src 目录下的 main.rs 文件或 lib.rs 文件

App项目中可以改变可执行入口文件

src 目录下新建 test.rs 文件,文件中写一个 main 函数

1
2
3
cargo run --bin test

cargo build --bin test

运行测试

1
cargo test

上面命令可以执行所有rs文件中的单元测试代码,而且会执行所有 tests 目录中的集成测试代码

初始化项目

1
2
3
cargo init --bin  // 在当前目录初始化一个app

cargo init --lib // 在当前目录初始化一个crate

下载依赖(类似于 npm install)

1
cargo update

生成文档

rust文档可以通过函数的注释自动生成(当然注释要按照一定的规则才行)

1
cargo doc --open // 生成文档并且当即打开浏览器浏览文档

发布crates.io

保存token

1
cargo login XXX  // XXX是你的crates.io账号的token。这个命令会将token保存到~/.cargo/credentials文件中以备后面使用

发布

1
2
3
4
5
cargo publish --dry-run --allow-dirty  // 执行发布的准备工作,但不上传crates.io。允许代码未提交

cargo package --list // 可以查看将要上传到crates.io的所有内容

cargo publish --allow-dirty // 执行发布的准备工作,且上传crates.io。允许代码未提交

可以通过Git Pages显示帮助文档

安装全局软件

1
cargo install cargo-exec  // 安装之后就可以通过 cargo exec 执行这个软件。软件命名符合 “cargo-exec” 这种规则即可

cargo exec 运行自定义命令

首先安装一个工具

1
cargo install cargo-exec

Cargo.toml中添加

1
2
[package.metadata.scripts]
build = "rm -rf docs && cargo doc && mv target/doc/ docs/ && cargo build"
1
cargo exec build  // 相当于运行 rm -rf docs && cargo doc && mv target/doc/ docs/ && cargo build



微信关注我,及时接收最新技术文章