cargo-rustc(1)

名称

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

概要

cargo rustc [选项] [-- 参数]

描述

当前包的指定目标（如果提供了 -p，则为指定包）将与其所有依赖项一起编译。指定的 *参数* 将全部传递给最终的编译器调用，而不是任何依赖项。请注意，编译器仍将无条件地接收诸如 -L、--extern 和 --crate-type 之类的参数，并且指定的 *参数* 将简单地添加到编译器调用中。

有关 rustc 标志的文档，请参阅 https://doc.rust-lang.net.cn/rustc/index.html。

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

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

选项

包选择

默认情况下，选择当前工作目录中的包。可以使用 -p 标志选择工作区中的其他包。

-p 规范
--package 规范
要构建的包。有关 SPEC 格式，请参阅 cargo-pkgid(1)。

目标选择

当未提供目标选择选项时，cargo rustc 将构建所选包的所有二进制和库目标。

如果选择了要构建的集成测试或基准测试，则会自动构建二进制目标。这允许集成测试执行二进制文件以锻炼和测试其行为。构建集成测试时，将设置 CARGO_BIN_EXE_<name> 环境变量，以便它可以使用 env 宏 来查找可执行文件。

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

请注意，--bin、--example、--test 和 --bench 标志还支持常见的 Unix glob 模式，例如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理它们之前意外地扩展 glob 模式，您必须在每个 glob 模式周围使用单引号或双引号。

--lib
构建包的库。
--bin 名称…
构建指定的二进制文件。可以多次指定此标志，并支持常见的 Unix glob 模式。
--bins
构建所有二进制目标。
--example 名称…
构建指定的示例。可以多次指定此标志，并支持常见的 Unix glob 模式。
--examples
构建所有示例目标。
--test 名称…
构建指定的集成测试。可以多次指定此标志，并支持常见的 Unix glob 模式。
--tests
构建所有设置了 test = true 清单标志的目标。默认情况下，这包括作为单元测试构建的库和二进制文件，以及集成测试。请注意，这还将构建任何必需的依赖项，因此库目标可能会构建两次（一次作为单元测试，一次作为二进制文件、集成测试等的依赖项）。可以通过在目标清单设置中设置 test 标志来启用或禁用目标。
--bench 名称…
构建指定的基准测试。可以多次指定此标志，并支持常见的 Unix glob 模式。
--benches
构建所有设置了 bench = true 清单标志的目标。默认情况下，这包括作为基准测试构建的库和二进制文件，以及基准测试目标。请注意，这还将构建任何必需的依赖项，因此库目标可能会构建两次（一次作为基准测试，一次作为二进制文件、基准测试等的依赖项）。可以通过在目标清单设置中设置 bench 标志来启用或禁用目标。
--all-targets
构建所有目标。这等效于指定 --lib --bins --tests --benches --examples。

功能选择

功能标志允许您控制启用哪些功能。当未提供功能选项时，将为每个选定的包激活 default 功能。

有关更多详细信息，请参阅 功能文档。

-F 功能
--features 功能
要激活的功能的空格或逗号分隔列表。可以使用 package-name/feature-name 语法启用工作区成员的功能。可以多次指定此标志，从而启用所有指定的功能。
--all-features
激活所有选定包的所有可用功能。
--no-default-features
不激活所选包的 default 功能。

编译选项

--target 三元组
为给定的架构构建。默认值为宿主架构。三元组的通用格式为 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 可获取支持的目标列表。可以多次指定此标志。

也可以使用 build.target 配置值 指定此值。

请注意，指定此标志会使 Cargo 在不同的模式下运行，其中目标工件放置在单独的目录中。有关更多详细信息，请参阅 构建缓存 文档。

-r
--release
使用 release 配置文件构建优化后的工件。另请参阅 --profile 选项以按名称选择特定的配置文件。
--profile 名称
使用给定的配置文件构建。

rustc 子命令将使用特殊行为处理以下命名的配置文件

  • check — 以与 cargo-check(1) 命令使用 dev 配置文件相同的方式构建。
  • test — 以与 cargo-test(1) 命令相同的方式构建，启用以测试模式进行构建，这将启用测试并启用 test cfg 选项。有关更多详细信息，请参阅 rustc 测试。
  • bench — 以与 cargo-bench(1) 命令相同的方式构建，类似于 test 配置文件。

有关配置文件的更多详细信息，请参阅 参考。

--timings=fmts
输出有关每次编译花费多长时间的信息，并跟踪随时间的并发信息。接受可选的逗号分隔的输出格式列表；不带参数的 --timings 将默认为 --timings=html。指定输出格式（而不是默认格式）是不稳定的，并且需要 -Zunstable-options。有效的输出格式

  • html（不稳定，需要 -Zunstable-options）：将人类可读的文件 cargo-timing.html 写入 target/cargo-timings 目录，其中包含编译报告。如果您想查看较旧的运行，还可以将报告写入同一目录，并在文件名中包含时间戳。HTML 输出仅适用于人类消费，不提供机器可读的计时数据。
  • json（不稳定，需要 -Zunstable-options）：发出有关计时信息的机器可读 JSON 信息。
--crate-type crate-type
为给定的 crate 类型构建。此标志接受 1 个或多个 crate 类型的逗号分隔列表，其允许的值与清单中用于配置 Cargo 目标的 crate-type 字段相同。有关可能的值，请参阅 crate-type 字段。

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

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

输出选项

--target-dir 目录
所有生成的工件和中间文件的目录。也可以使用 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值 指定此值。默认为工作区根目录中的 target。

显示选项

-v
--verbose
使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括额外的输出，例如依赖项警告和构建脚本输出。也可以使用 term.verbose 配置值 指定此值。
-q
--quiet
不打印 cargo 日志消息。也可以使用 term.quiet 配置值 指定此值。
--color 何时
控制何时使用彩色输出。有效值

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

也可以使用 term.color 配置值 指定此值。

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

  • human（默认）：以人类可读的文本格式显示。与 short 和 json 冲突。
  • short：发出较短的人类可读文本消息。与 human 和 json 冲突。
  • json：将 JSON 消息输出到 stdout。有关更多详细信息，请参阅 参考。与 human 和 short 冲突。
  • json-diagnostic-short：确保 JSON 消息的 rendered 字段包含 rustc 的“短”渲染。不能与 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-path 路径
Cargo.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-path 路径
将 lock 文件的路径从默认值（<workspace_root>/Cargo.lock）更改为 *PATH*。*PATH* 必须以 Cargo.lock 结尾 (例如，--lockfile-path /tmp/temporary-lockfile/Cargo.lock)。请注意，提供 --lockfile-path 将忽略默认路径下现有的 lock 文件，而是使用来自 *PATH* 的 lock 文件，或者如果不存在，则在提供的 *PATH* 中写入新的 lock 文件。此标志可用于在只读目录中运行大多数命令，并将 lock 文件写入提供的 *PATH* 中。

此选项仅在 nightly channel 上可用，并且需要 -Z unstable-options 标志才能启用 (请参阅 #14421)。

常用选项

+工具链
如果 Cargo 是使用 rustup 安装的，并且 cargo 的第一个参数以 + 开头，它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。
--config KEY=VALUE 或 路径
覆盖 Cargo 配置值。参数应该使用 KEY=VALUE 的 TOML 语法，或者作为额外配置文件的路径提供。此标志可以多次指定。有关更多信息，请参阅 命令行覆盖部分。
-C 路径
在执行任何指定的操作之前，更改当前工作目录。这会影响 Cargo 默认查找项目清单 (Cargo.toml) 的位置，以及搜索 .cargo/config.toml 的目录。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在 nightly channel 上可用，并且需要 -Z unstable-options 标志才能启用 (请参阅 #10098)。

-h
--help
打印帮助信息。
-Z 标志
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)