cargo-build(1)

名称

cargo-build — 编译当前包

概要

cargo build [选项]

描述

编译本地包及其所有依赖项。

选项

包选择

默认情况下，当未指定包选择选项时，所选包取决于所选清单文件（如果未指定 --manifest-path，则基于当前工作目录）。如果清单是工作区的根目录，则选择工作区的默认成员，否则仅选择清单定义的包。

可以使用根清单中的 workspace.default-members 键显式设置工作区的默认成员。如果未设置，则虚拟工作区将包含所有工作区成员（相当于传递 --workspace），而非虚拟工作区将仅包含根 crate 本身。

-p 规范…

--package 规范…

仅构建指定的包。有关规范格式，请参阅 cargo-pkgid(1)。此标志可以指定多次，并支持常见的 Unix 通配符模式，如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理之前意外扩展通配符模式，您必须在每个模式周围使用单引号或双引号。

--workspace

构建工作区中的所有成员。

--all

已弃用的 --workspace 别名。

--exclude 规范…

排除指定的包。必须与 --workspace 标志一起使用。此标志可以指定多次，并支持常见的 Unix 通配符模式，如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理之前意外扩展通配符模式，您必须在每个模式周围使用单引号或双引号。

目标选择

当未指定目标选择选项时，cargo build 将构建所选包的所有二进制和库目标。如果二进制文件具有缺少的 required-features，则将跳过它们。

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

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

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

--lib

构建包的库。

--bin 名称…

构建指定的二进制文件。此标志可以指定多次，并支持常见的 Unix 通配符模式。

--bins

构建所有二进制目标。

--example 名称…

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

--examples

构建所有示例目标。

--test 名称…

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

--tests

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

--bench 名称…

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

--benches

构建所有在清单文件中设置了 bench = true 标志的目标，以基准测试模式进行构建。默认情况下，这包括作为基准测试构建的库和二进制文件，以及 bench 目标。请注意，这也会构建任何所需的依赖项，因此 lib 目标可能会被构建两次（一次作为基准测试，一次作为二进制文件、基准测试等的依赖项）。可以通过在目标的清单设置中设置 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 名称

使用给定的配置文件构建。有关配置文件的更多详细信息，请参阅参考。

--timings=fmts

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

• html（不稳定，需要 -Zunstable-options）：将一个人类可读的文件 cargo-timing.html 写入 target/cargo-timings 目录，其中包含编译报告。如果要查看旧的运行，还可以将报告写入同一目录，并在文件名中包含时间戳。HTML 输出仅适合人类阅读，不提供机器可读的计时数据。
• json（不稳定，需要 -Zunstable-options）：发出关于计时信息的机器可读 JSON 信息。

输出选项

--target-dir 目录

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

--out-dir 目录

将最终工件复制到此目录。

此选项不稳定，仅在夜间版通道上可用，并且需要 -Z unstable-options 标志才能启用。有关更多信息，请参阅https://github.com/rust-lang/cargo/issues/6790。

显示选项

-v

--verbose

使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括额外的输出，例如依赖项警告和构建脚本输出。也可以使用 term.verbose 配置值 指定。

-q

--quiet

不打印 Cargo 日志消息。也可以使用 term.quiet 配置值 指定。

--color 何时

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

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

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

--message-format fmt

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

• human（默认）：以人类可读的文本格式显示。与 short 和 json 冲突。
• short：发出更短、人类可读的文本消息。与 human 和 json 冲突。
• json：将 JSON 消息发送到标准输出。有关更多详细信息，请参阅参考。与 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 一起使用。

--build-plan

向标准输出输出一系列 JSON 消息，指示运行构建的命令。

此选项不稳定，仅在夜间版通道上可用，并且需要 -Z unstable-options 标志才能启用。有关更多信息，请参阅https://github.com/rust-lang/cargo/issues/5579。

清单选项

--manifest-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。

常用选项

+工具链

如果使用 rustup 安装了 Cargo，并且 cargo 的第一个参数以 + 开头，则它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅rustup 文档。

--config KEY=VALUE 或 PATH

覆盖 Cargo 配置值。参数应采用 KEY=VALUE 的 TOML 语法，或作为额外配置文件的路径提供。此标志可以指定多次。有关更多信息，请参阅命令行覆盖部分。

-C PATH

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

此选项仅在夜间版通道上可用，并且需要 -Z unstable-options 标志才能启用（请参阅#10098）。

-h

--help

打印帮助信息。

-Z 标志

Cargo 的不稳定（仅限夜间版）标志。运行 cargo -Z help 以获取详细信息。

其他选项

-j N

--jobs N

要运行的并行作业数。也可以使用 build.jobs 配置值 指定。默认为逻辑 CPU 的数量。如果为负数，则将最大并行作业数设置为逻辑 CPU 数加上提供的数值。如果提供了字符串 default，则将值设置回默认值。不应为 0。

--keep-going

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

例如，如果当前包依赖于依赖项 fails 和 works，其中一个构建失败，则 cargo build -j1 可能会也可能不会构建成功的那个（取决于 Cargo 选择首先运行的两个构建中的哪一个），而 cargo build -j1 --keep-going 肯定会运行这两个构建，即使第一个构建失败。

--future-incompat-report

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

请参阅cargo-report(1)

环境

有关 Cargo 读取的环境变量的详细信息，请参阅参考。

退出状态

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

示例

1. 构建本地包及其所有依赖项

   cargo build
   

2. 使用优化进行构建

   cargo build --release
   

另请参阅

cargo(1)，cargo-rustc(1)