Cargo 备忘清单

$ cargo new hello_world --bin

• --bin 正在制作一个二进制程序
• --lib 正在创建一个库(lib)

得到如下目录:

$ cd hello_world
$ tree .
.
├── Cargo.toml
└── src
    └── main.rs

Cargo.toml 被称为一个 manifest 元清单，它包含了 Cargo 编译项目所需的所有元数据

[package]
name = "hello_world"
version = "0.1.0"
authors = ["Your Name <you@example.com>"]
edition = "2018"

[dependencies]

入口文件 src/main.rs

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

运行编译生成 hello_world 二进制文件

$ cargo build
# 文件放入 `target/release` 目录
$ cargo build --release

然后运行它:

$ ./target/debug/hello_world
Hello, world!

也可以直接使用 cargo run，它会自行编译并运行它:

$ cargo run
   Running `target/hello_world`
Hello, world!

[package]
# ...
[lib]
# 生成目标与库的名称. 本该默认是包名, 替换所有破折号为 下划线. (Rust `extern crate` 声明会参考该名；因此，该值必须是可用的有效Rust标识符)
name = "foo"
# 该字段，指向 crate 的入口(位置), 路径相对于 `Cargo.toml`.
path = "src/lib.rs"
# 一个给目标启用单元测试 的 标志. 会被 `cargo test`使用.
test = true
# 一个给目标启用文档测试 的 标志. 只与库相关, 不会影响其他部分。会被 `cargo test`使用.
doctest = true
# 一个给目标启用基准 的 标志. 会被 `cargo bench`使用.
bench = true
# 一个给目标启用文档 的 标志. 会被 `cargo doc`使用.
doc = true
# 若该目标为 编译器扩展, 那要把该字段设为 true，以让 Cargo 正确编译和，可用于所有依赖项.
plugin = false
# 若该目标为 "macros 1.1" 程序宏, 那要把该字段设为 true
proc-macro = false
# 若设为 false, `cargo test` 会为 rustc 省略 `--test` 标志, 这阻止它生成测试工具 这在二进制存在，构建管理测试运行器本身的情况下，有用.
harness = true
# 若设置了，那 目标会使用一个与`[package]`配置不同的版本, 也许是，编译一个库 2018年版本或，编译单元测试的2015年版本. 默认情况下所有目标都使用`[package]`中指定的版本进行编译。
edition = '2015'

创建一个新的 cargo 包

$ cargo init [options] [path]
$ cargo new [options] [path]

• --bin 创建具有二进制目标 (src/main.rs) 的包(默认行为)
• --lib 使用库目标 (src/lib.rs) 创建一个包
• --edition edition 指定要使用的 Rust 版本。默认值为 2021。可能的值：2015、2018、2021
• --name name 设置包名。默认为目录名称
• --vcs vcs 为给定的版本控制系统（git、hg、pijul 或fossil）初始化一个新的 VCS 存储库，或者根本不初始化任何版本控制（无）
• --registry registry 限制仅发布到该注册表

$ cargo new foo

# 从 crates.io 安装或升级软件包：
$ cargo install ripgrep
# 在当前目录安装或重新安装包：
$ cargo install --path .
# 查看已安装包的列表：
$ cargo install --list

• --vers version
• --version version 指定要安装的版本
• --git url 用于安装指定 crate 的 Git URL
• --branch branch 从 git 安装时要使用的分支
• --tag tag 从 git 安装时使用的标记
• --rev sha 从 git 安装时使用的特定提交
• --path path 要安装的本地 crate 的文件系统路径
• --list 列出所有已安装的软件包及其版本
• -f, --force 强制覆盖现有的 crate 或二进制文件

选择包

• -p spec..., --package spec... Package 指定包
• --workspace Package 工作区中的全体成员
• --exclude SPEC... 排除指定包

编译选项

• --target triple 为指定架构执行 Package
• --target-dir directory 用于存放生成的工件以及中间文件的目录

特性选择

• --features features 传递以空格或者逗号分隔的列表，其中给出要启用的特性
• --all-features 为给定的包启用全部可用特性
• --no-default-features 不启用给定包的default特性

清单选项

• --manifest-path path 用于指定 Cargo.toml 文件的路径
• --frozen, --locked 这两个选项用于保证Cargo.lock文件是最新的
• --offline 禁止Cargo访问网络

混杂选项

• -j N, --jobs N 要并行运行的作业数量

$ cargo publish [options]

发布选项

• --dry-run 在不上传的情况下执行所有检查
• --token token 身份验证时使用的 API 令牌
• --no-verify 不要通过构建内容来验证内容
• --allow-dirty 允许打包具有未提交的 VCS 更改的工作目录
• --index index 要使用的注册表索引的 URL
• --registry registry 要发布到的注册表的名称

打包选择

• -p spec, --package spec 要发布的包