12-cargo rustc

cargo-rustc(1) 向 rustc 传额外参数

  7 分钟阅读  

译文 · 基于 The Cargo Book

cargo-rustc(1)

原文链接: https://doc.rust-lang.org/cargo/commands/cargo-rustc.html

名称

cargo-rustc — 编译当前包，并向编译器传递额外选项

大纲

cargo rustc [options] [-- args]

描述

将编译当前包（或由 -p 指定的包）的指定目标及其所有依赖。指定的 args 都会传给最终的编译器调用，而不会传给任何依赖。注意：编译器仍会无条件地收到诸如 -L、--extern 和 --crate-type 等参数，指定的 args 只是追加到编译器调用中。

rustc 标志文档见 https://doc.rust-lang.org/rustc/index.html。

当提供额外参数时，此命令要求仅编译一个目标。若当前包有多个可用目标，必须使用 --lib、--bin 等过滤器选择要编译的目标。

若要将标志传给 Cargo 启动的所有编译器进程，请使用 RUSTFLAGS 环境变量 或 build.rustflags 配置值。

选项

包选择

默认选择当前工作目录中的包。可用 -p 标志选择工作空间中的其他包。

-p spec
--package spec

要构建的包。 SPEC 格式见 cargo-pkgid(1)。

目标选择

若未给出目标选择选项，cargo rustc 将构建所选包的所有二进制与库目标。

若选择构建集成测试或基准测试，则会自动构建二进制目标。这样集成测试可以执行该二进制以演练并测试其行为。 在构建并运行集成测试时会设置 CARGO_BIN_EXE_<name> 环境变量， 以便测试可使用 env 宏 或 var 函数 定位可执行文件。

传入目标选择标志将仅构建指定的目标。

注意：--bin、--example、--test 和 --bench 标志也支持常见的 Unix glob 模式，如 *、? 和 []。不过，为避免 shell 在 Cargo 处理之前意外展开 glob 模式，必须用单引号或双引号括住每个 glob 模式。

--lib

构建包的库。

--bin name…

构建指定的二进制目标。 此标志可指定多次，并支持常见的 Unix glob 模式。

--bins

构建所有二进制目标。

--example name…

构建指定的示例。 此标志可指定多次，并支持常见的 Unix glob 模式。

--examples

构建所有示例目标。

--test name…

构建指定的集成测试。 此标志可指定多次，并支持常见的 Unix glob 模式。

--tests

构建所有在清单中设置了 test = true 标志的目标。默认包括作为单元测试构建的库与二进制目标，以及集成测试。请注意这也会构建任何所需依赖，因此 lib 目标可能会被构建两次（一次作为单元测试，一次作为二进制、集成测试等的依赖）。可通过在目标的清单设置中设置 test 标志来启用或禁用目标。

--bench name…

构建指定的基准测试。 此标志可指定多次，并支持常见的 Unix glob 模式。

--benches

构建所有在清单中设置了 bench = true 标志的目标。默认包括作为基准测试构建的库与二进制目标，以及 bench 目标。请注意这也会构建任何所需依赖，因此 lib 目标可能会被构建两次（一次作为基准测试，一次作为二进制、基准测试等的依赖）。可通过在目标的清单设置中设置 bench 标志来启用或禁用目标。

--all-targets

构建所有目标。等价于指定 --lib --bins --tests --benches --examples。

特性选择

特性标志用于控制启用哪些特性（feature）。若未给出特性选项，则为每个所选包激活 default 特性。

参见特性文档 了解更多详情。

-F features
--features features

要激活的特性列表，以空格或逗号分隔。工作空间成员的特性可用 package-name/feature-name 语法启用。此标志可指定多次，将启用所有指定的特性。

--all-features

激活所有所选包的全部可用特性。

--no-default-features

不激活所选包的 default 特性。

编译选项

--target triple

为指定的目标架构构建。此标志可指定多次。默认为主机架构。 triple 的一般格式为 <arch><sub>-<vendor>-<sys>-<abi>。

可能的值：

  • rustc --print target-list 中任何受支持的目标。
  • "host-tuple"，内部会替换为主机目标。若你在交叉编译某些 crate，又不想把主机机器指定为目标（例如可能由多台主机协作的共享项目中的 xtask），这会特别有用。
  • 自定义目标规范的路径。更多信息见 自定义目标查找路径。

也可通过 build.target 配置值 指定。

注意：指定此标志会使 Cargo 以不同模式运行，目标产物会放在单独目录中。详情见 构建缓存文档。

-r
--release

使用 release 配置文件构建优化后的产物。 也可使用 --profile 选项按名称选择特定配置文件。

--profile name

使用给定的配置文件构建。

rustc 子命令会对以下命名配置文件采用特殊行为：

  • check — 与带 dev 配置文件的 cargo-check(1) 命令相同的方式构建。
  • test — 与 cargo-test(1) 命令相同的方式构建， 启用测试模式（将启用测试并启用 test cfg 选项）。更多详情见 rustc 测试。
  • bench — 与 cargo-bench(1) 命令相同的方式构建， 类似于 test 配置文件。

关于配置文件的更多详情见参考文档。

--timings

输出每次编译耗时信息，并跟踪一段时间内的并发信息。

构建结束时会将 cargo-timing.html 文件写入 target/cargo-timings 目录。还会写入一份文件名带时间戳的额外报告，便于查看先前运行。 这些报告仅供人阅读，不提供机器可读的耗时数据。

--crate-type crate-type

为给定的 crate 类型构建。此标志接受逗号分隔的 1 个或多个 crate 类型列表，允许的值与清单中配置 Cargo 目标的 crate-type 字段相同。可能的值见 crate-type 字段。

若清单包含列表，且提供了 --crate-type， 则命令行参数值将覆盖清单中的值。

此标志仅在构建 lib 或 example 库目标时有效。

输出选项

--target-dir directory

所有生成产物与中间文件的目录。也可通过 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值 指定。 默认为工作空间根目录下的 target。

显示选项

-v
--verbose

使用详细输出。可指定两次以获得「非常详细」的输出，其中包括依赖警告与构建脚本输出等额外信息。 也可通过 term.verbose 配置值 指定。

-q
--quiet

不打印 cargo 日志消息。 也可通过 term.quiet 配置值 指定。

--color when

控制何时使用彩色输出。有效值：

  • auto （默认）： 自动检测终端是否支持颜色。
  • always: 始终显示颜色。
  • never: 从不显示颜色。

也可通过 term.color 配置值 指定。

--message-format fmt

诊断消息的输出格式。可指定多次，由逗号分隔的值组成。有效值：

  • 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-path path

Cargo.toml 文件的路径。默认情况下，Cargo 会在当前目录或其任意父目录中搜索 Cargo.toml。

--ignore-rust-version

忽略包中的 rust-version 规范。

--locked

断言使用与生成现有 Cargo.lock 文件时完全相同的依赖与版本。出现以下任一情况时，Cargo 将以错误退出：

  • 缺少锁文件。
  • 由于依赖解析不同，Cargo 试图更改锁文件。

可用于需要确定性构建的环境，例如 CI 流水线。

--offline

禁止 Cargo 因任何原因访问网络。若未指定此标志，当 Cargo 需要访问网络而网络不可用时会以错误停止。指定此标志后，Cargo 会在可能的情况下尝试在无网络时继续。

注意：这可能导致与在线模式不同的依赖解析结果。Cargo 将仅使用本地已下载的 crate，即使本地索引副本表明可能有更新版本。 可先使用 cargo-fetch(1) 命令下载依赖再离线使用。

也可通过 net.offline 配置值 指定。

--frozen

等价于同时指定 --locked 与 --offline。

通用选项

+toolchain

若 Cargo 通过 rustup 安装，且传给 cargo 的第一个参数以 + 开头，则会被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。 关于工具链覆盖的工作方式，请参阅 rustup 文档。

--config KEY=VALUE or PATH

覆盖 Cargo 配置值。参数应为 TOML 语法的 KEY=VALUE，或指向额外配置文件的路径。此标志可指定多次。 更多信息见 命令行覆盖一节。

-C PATH

在执行任何指定操作之前更改当前工作目录。这会影响诸如 Cargo 默认查找项目清单（Cargo.toml）的位置，以及用于发现 .cargo/config.toml 的目录搜索等。此选项必须出现在命令名之前，例如 cargo -C path/to/my-project build。

此选项仅在 nightly 通道 可用， 并需要 -Z unstable-options 标志才能启用（见 #10098）。

-h
--help

打印帮助信息。

-Z flag

Cargo 的不稳定（仅 nightly）标志。运行 cargo -Z help 查看详情。

杂项选项

-j N
--jobs N

并行作业数。也可通过 build.jobs 配置值 指定。默认为 逻辑 CPU 数量。若为负数，则将并行作业上限设为逻辑 CPU 数加上所给值。若 提供字符串 default，则恢复为默认值。 不应为 0。

--keep-going

尽可能构建依赖图中的更多 crate，而不是在第一个构建失败时中止。

例如，若当前包依赖 fails 与 works， 其中之一构建失败，则 cargo rustc -j1 可能构建也可能不构建成功的那个 （取决于 Cargo 先运行哪一个），而 cargo rustc -j1 --keep-going 肯定会运行两者， 即便先运行的那个失败。

--future-incompat-report

对本命令执行期间产生的任何未来不兼容警告显示未来不兼容报告

参见 cargo-report(1)

环境变量

参见参考文档 了解 Cargo 读取的环境变量详情。

退出状态

  • 0: Cargo 成功完成。
  • 101: Cargo 未能完成。

示例

  1. 检查你的包（不包括依赖）是否使用了 unsafe 代码：

    cargo rustc --lib -- -D unsafe-code

  2. 在 nightly 编译器上尝试实验性标志，例如打印每种类型的大小：

    cargo rustc --lib -- -Z print-type-sizes

  3. 用命令行选项覆盖 Cargo.toml 中的 crate-type 字段：

    cargo rustc --lib --crate-type lib,cdylib

参见

cargo(1)、cargo-build(1)、rustc(1)

最后修改 August 11, 2026: 更新 (70a5af133)