cargo-rustc(1)
名称
cargo-rustc — 编译当前包,并向编译器传递额外选项
概要
cargo rustc [选项] [-- 参数]
描述
当前包的指定目标(如果提供了 -p 则为指定包)将与所有其依赖项一起被编译。指定的 args 将全部传递给最终的编译器调用,而不是传递给任何依赖项。请注意,编译器仍然会无条件地接收诸如 -L, --extern, 和 --crate-type 等参数,而指定的 args 只会被简单地添加到编译器调用中。
关于 rustc 标志的文档,请参阅 https://doc.rust-lang.net.cn/rustc/index.html。
当提供了额外参数时,此命令要求只编译一个目标。如果当前包有多个目标可用,则必须使用 --lib, --bin 等过滤选项来选择要编译的目标。
要向 Cargo 派生的所有编译器进程传递标志,请使用 RUSTFLAGS 环境变量 或 build.rustflags 配置值。
选项
包选择
默认情况下,选择当前工作目录中的包。可以使用 -p 标志来选择工作空间中的不同包。
-pspec--packagespec- 要构建的包。关于 SPEC 格式,请参阅 cargo-pkgid(1)。
目标选择
未指定目标选择选项时,cargo rustc 将构建所选包的所有二进制和库目标。
如果选择了集成测试或基准测试进行构建,二进制目标将自动构建。这允许集成测试执行二进制文件来练习和测试其行为。构建集成测试时会设置 CARGO_BIN_EXE_<name> 环境变量,以便它可以利用 env 宏来定位可执行文件。
传递目标选择标志将仅构建指定的目标。
请注意,--bin、--example、--test 和 --bench 标志也支持常见的 Unix glob 模式,如 *、? 和 []。然而,为避免您的 shell 在 Cargo 处理 glob 模式之前意外展开它们,您必须在每个 glob 模式周围使用单引号或双引号。
--lib- 构建包的库。
--binname…- 构建指定的二进制文件。此标志可以多次指定,并支持常见的 Unix glob 模式。
--bins- 构建所有二进制目标。
--examplename…- 构建指定的示例。此标志可以多次指定,并支持常见的 Unix glob 模式。
--examples- 构建所有示例目标。
--testname…- 构建指定的集成测试。此标志可以多次指定,并支持常见的 Unix glob 模式。
--tests- 构建所有清单中设置了
test = true标志的目标。默认情况下,这包括构建为单元测试的库和二进制文件,以及集成测试。请注意,这也会构建任何所需的依赖项,因此 lib 目标可能会被构建两次(一次作为单元测试,一次作为二进制文件、集成测试等的依赖项)。可以通过在目标的清单设置中设置test标志来启用或禁用目标。 --benchname…- 构建指定的基准测试。此标志可以多次指定,并支持常见的 Unix glob 模式。
--benches- 构建所有清单中设置了
bench = true标志的目标。默认情况下,这包括构建为基准测试的库和二进制文件,以及基准测试目标。请注意,这也会构建任何所需的依赖项,因此 lib 目标可能会被构建两次(一次作为基准测试,一次作为二进制文件、基准测试等的依赖项)。可以通过在目标的清单设置中设置bench标志来启用或禁用目标。 --all-targets- 构建所有目标。这相当于指定
--lib --bins --tests --benches --examples。
特性选择
特性标志允许您控制启用哪些特性。未指定特性选项时,将为每个选定的包激活 default 特性。
更多详细信息请参阅特性文档。
-Ffeatures--featuresfeatures- 空格或逗号分隔的要激活的特性列表。可以使用
package-name/feature-name语法启用工作空间成员的特性。此标志可以多次指定,这将启用所有指定的特性。 --all-features- 激活所有选定包的所有可用特性。
--no-default-features- 不激活选定包的
default特性。
编译选项
--targettriple- 为给定架构构建。默认为主机架构。triple 的通用格式为
<arch><sub>-<vendor>-<sys>-<abi>。运行rustc --print target-list获取支持的目标列表。此标志可以多次指定。也可以通过
build.target配置值指定。请注意,指定此标志会使 Cargo 在不同的模式下运行,目标构建产物会放置在单独的目录中。更多详细信息请参阅构建缓存文档。
-r--release- 使用
releaseprofile 构建优化过的构建产物。另请参阅--profile选项,用于按名称选择特定 profile。 --profilename- 使用给定的 profile 进行构建。
rustc子命令将以下命名 profile 视为具有特殊行为:check— 与 cargo-check(1) 命令使用devprofile 的方式相同进行构建。test— 与 cargo-test(1) 命令的方式相同进行构建,启用测试模式构建,这将启用测试并启用testcfg 选项。更多详细信息请参阅 rustc 测试。bench— 与 cargo-bench(1) 命令的方式相同进行构建,类似于testprofile。
更多关于 profile 的详细信息请参阅参考手册。
--timings=fmts- 输出每个编译耗时信息,并跟踪随时间变化的并发信息。接受一个可选的逗号分隔输出格式列表;不带参数的
--timings将默认为--timings=html。指定输出格式(而非默认格式)是不稳定的,需要-Zunstable-options。有效的输出格式:html(不稳定,需要-Zunstable-options):在target/cargo-timings目录中写入一个人类可读的文件cargo-timing.html,其中包含编译报告。如果您想查看旧的运行结果,也会在同一目录中写入一个文件名带有时间戳的报告。HTML 输出仅适用于人类查看,不提供机器可读的耗时数据。json(不稳定,需要-Zunstable-options):输出机器可读的 JSON 格式的耗时信息。
--crate-typecrate-type- 为给定的 crate 类型构建。此标志接受一个或多个逗号分隔的 crate 类型列表,允许的值与清单中用于配置 Cargo 目标的
crate-type字段相同。可能的值请参阅crate-type字段。如果清单包含一个列表,并且提供了
--crate-type,则命令行参数值将覆盖清单中的设置。此标志仅在构建
lib或example库目标时有效。
输出选项
--target-dirdirectory- 所有生成的构建产物和中间文件的目录。也可以通过
CARGO_TARGET_DIR环境变量或build.target-dir配置值指定。默认为工作空间根目录下的target。
显示选项
-v--verbose- 使用详细输出。可以指定两次以获得“非常详细”的输出,其中包括依赖项警告和构建脚本输出等额外信息。也可以通过
term.verbose配置值指定。 -q--quiet- 不打印 cargo 日志消息。也可以通过
term.quiet配置值指定。 --colorwhen- 控制何时使用彩色输出。有效值:
auto(默认):自动检测终端是否支持颜色。always:总是显示颜色。never:从不显示颜色。
也可以通过
term.color配置值指定。 --message-formatfmt- 诊断消息的输出格式。可以多次指定,由逗号分隔的值组成。有效值:
human(默认):以人类可读的文本格式显示。与short和json冲突。short:输出更短、人类可读的文本消息。与human和json冲突。json:向 stdout 输出 JSON 消息。更多详细信息请参阅参考手册。与human和short冲突。json-diagnostic-short:确保 JSON 消息的rendered字段包含来自 rustc 的“short”渲染结果。不能与human或short一起使用。json-diagnostic-rendered-ansi:确保 JSON 消息的rendered字段包含嵌入的 ANSI 颜色代码,以遵循 rustc 的默认配色方案。不能与human或short一起使用。json-render-diagnostics:指示 Cargo 不要在打印的 JSON 消息中包含 rustc 的诊断信息,而是由 Cargo 自己渲染来自 rustc 的 JSON 诊断信息。Cargo 自己的 JSON 诊断信息以及来自 rustc 的其他信息仍会输出。不能与human或short一起使用。
Manifest 选项
--manifest-pathpathCargo.toml文件的路径。默认情况下,Cargo 在当前目录或任何父目录中搜索Cargo.toml文件。--ignore-rust-version- 忽略包中的
rust-version规范。 --locked- 断言使用的依赖项及其版本与现有
Cargo.lock文件最初生成时完全相同。在以下任何一种情况发生时,Cargo 将退出并报错:- lock 文件缺失。
- 由于依赖项解析不同,Cargo 试图更改 lock 文件。
它可以在需要确定性构建的环境中使用,例如在 CI 流水线中。
--offline- 阻止 Cargo 出于任何原因访问网络。如果没有此标志,如果 Cargo 需要访问网络而网络不可用,它将停止并报错。有了此标志,Cargo 将尝试在可能的情况下不使用网络继续执行。
请注意,这可能导致与在线模式不同的依赖项解析。Cargo 会将自身限制在本地下载的 crate 中,即使本地索引副本中可能指示存在更新的版本。请参阅 cargo-fetch(1) 命令,以便在离线之前下载依赖项。
也可以通过
net.offline配置值指定。 --frozen- 等同于同时指定
--locked和--offline。 --lockfile-pathPATH- 将 lock 文件路径从默认路径(
<workspace_root>/Cargo.lock)更改为 PATH。PATH 必须以Cargo.lock结尾(例如--lockfile-path /tmp/temporary-lockfile/Cargo.lock)。请注意,提供--lockfile-path将忽略默认路径下的现有 lock 文件,而是使用 PATH 中的 lock 文件;如果该路径不存在 lock 文件,则将新的 lock 文件写入提供的 PATH 中。此标志可用于在只读目录中运行大多数命令,并将 lock 文件写入提供的 PATH。此选项仅在 nightly channel 上可用,并且需要
-Z unstable-options标志才能启用(参阅 #14421)。
通用选项
+toolchain- 如果 Cargo 是通过 rustup 安装的,并且
cargo的第一个参数以+开头,它将被解释为 rustup 工具链名称(例如+stable或+nightly)。关于工具链覆盖如何工作的更多信息,请参阅 rustup 文档。 --configKEY=VALUE 或 PATH- 覆盖 Cargo 配置值。参数应为 TOML 语法格式的
KEY=VALUE,或提供额外配置文件的路径。此标志可以多次指定。更多信息请参阅命令行覆盖部分。 -CPATH- 在执行任何指定操作之前更改当前工作目录。这会影响 Cargo 默认查找项目清单 (
Cargo.toml) 的位置,以及搜索发现.cargo/config.toml的目录等。此选项必须出现在命令名称之前,例如cargo -C path/to/my-project build。此选项仅在 nightly channel 上可用,并且需要
-Z unstable-options标志才能启用(参阅 #10098)。 -h--help- 打印帮助信息。
-Zflag- Cargo 的不稳定(仅 nightly)标志。运行
cargo -Z help查看详情。
杂项选项
-jN--jobsN- 并行运行的任务数量。也可以通过
build.jobs配置值指定。默认为逻辑 CPU 数量。如果为负数,则将最大并行任务数量设置为逻辑 CPU 数量加上提供的值。如果提供字符串default,则将值重置为默认值。不能为 0。 --keep-going- 构建依赖图中的尽可能多的 crate,而不是在第一个构建失败时中止。
例如,如果当前包依赖于
fails和works两个依赖项,其中一个构建失败,cargo rustc -j1可能构建成功的那一个(取决于 Cargo 先选择构建哪一个),而cargo rustc -j1 --keep-going肯定会运行两个构建,即使先运行的那个失败了。 --future-incompat-report- 显示在此命令执行期间产生的任何未来不兼容警告的报告。
环境变量
关于 Cargo 读取的环境变量的详细信息,请参阅参考手册。
退出状态
0:Cargo 成功。101:Cargo 未能完成。
示例
-
检查您的包(不包括依赖项)是否使用了 unsafe code
cargo rustc --lib -- -D unsafe-code -
在 nightly 编译器上尝试一个实验性标志,例如这个打印每个类型大小的标志
cargo rustc --lib -- -Z print-type-sizes -
使用命令行选项覆盖 Cargo.toml 中的
crate-type字段cargo rustc --lib --crate-type lib,cdylib