cargo-build(1)

名称

cargo-build — 编译当前包

概要

cargo build [选项]

描述

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

选项

包选择

默认情况下,当没有给出包选择选项时,选择的包取决于选择的清单文件(如果未给出 --manifest-path,则基于当前工作目录)。 如果清单是工作区的根,则会选择工作区的默认成员,否则只会选择清单定义的包。

工作区的默认成员可以使用根清单中的 workspace.default-members 键显式设置。 如果未设置此项,则虚拟工作区将包括所有工作区成员(等效于传递 --workspace),而非虚拟工作区将仅包括根 crate 本身。

-p spec
--package spec
仅构建指定的包。 有关 SPEC 格式,请参阅 cargo-pkgid(1)。 此标志可以多次指定,并支持常见的 Unix glob 模式,例如 *?[]。 但是,为避免您的 shell 在 Cargo 处理它们之前意外扩展 glob 模式,您必须在每个模式周围使用单引号或双引号。
--workspace
构建工作区中的所有成员。
--all
--workspace 的已弃用别名。
--exclude SPEC
排除指定的包。 必须与 --workspace 标志一起使用。 此标志可以多次指定,并支持常见的 Unix glob 模式,例如 *?[]。 但是,为避免您的 shell 在 Cargo 处理它们之前意外扩展 glob 模式,您必须在每个模式周围使用单引号或双引号。

目标选择

当没有给出目标选择选项时,cargo build 将构建所选包的所有二进制文件和库目标。 如果二进制文件缺少 required-features,则会跳过它们。

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

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

请注意,--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 清单标志的目标。 默认情况下,这包括作为基准测试构建的库和二进制文件,以及基准测试目标。 请注意,这还将构建任何必需的依赖项,因此 lib 目标可能会构建两次(一次作为基准测试,一次作为二进制文件、基准测试等的依赖项)。 可以通过在目标的清单设置中设置 bench 标志来启用或禁用目标。
--all-targets
构建所有目标。 这等效于指定 --lib --bins --tests --benches --examples

功能选择

功能标志允许您控制启用哪些功能。 当没有给出功能选项时,将为每个选定的包激活 default 功能。

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

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

编译选项

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

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

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

-r
--release
使用 release 配置文件构建优化的工件。 另请参阅 --profile 选项,以按名称选择特定配置文件。
--profile name
使用给定的配置文件构建。 有关配置文件的更多详细信息,请参阅参考
--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
--artifact-dir 目录
将最终工件复制到此目录。

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

显示选项

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

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

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

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

  • human (默认):以人类可读的文本格式显示。 与 shortjson 冲突。
  • short:发出较短的、人类可读的文本消息。 与 humanjson 冲突。
  • json: 将 JSON 消息输出到 stdout。有关更多详细信息,请参阅参考文档。与 humanshort 冲突。
  • json-diagnostic-short: 确保 JSON 消息的 rendered 字段包含来自 rustc 的“short”渲染。不能与 humanshort 一起使用。
  • json-diagnostic-rendered-ansi: 确保 JSON 消息的 rendered 字段包含嵌入的 ANSI 颜色代码,以符合 rustc 的默认颜色方案。不能与 humanshort 一起使用。
  • json-render-diagnostics: 指示 Cargo 不要将 rustc 诊断信息包含在打印的 JSON 消息中,而是让 Cargo 自己渲染来自 rustc 的 JSON 诊断信息。Cargo 自己的 JSON 诊断信息和来自 rustc 的其他诊断信息仍然会发出。不能与 humanshort 一起使用。
--build-plan
将一系列 JSON 消息输出到 stdout,指示要运行的构建命令。

此选项不稳定,仅在 nightly channel 上可用,并且需要启用 -Z unstable-options 标志。有关更多信息,请参阅 https://github.com/rust-lang/cargo/issues/5579

清单选项

--manifest-path path
指向 Cargo.toml 文件的路径。默认情况下,Cargo 会在当前目录或任何父目录中搜索 Cargo.toml 文件。
--ignore-rust-version
忽略包中的 rust-version 规范。
--locked
断言所使用的确切依赖项和版本与最初生成现有 Cargo.lock 文件时相同。当出现以下任何一种情况时,Cargo 将退出并显示错误

  • 缺少锁定文件。
  • 由于不同的依赖项解析,Cargo 尝试更改锁定文件。

它可用于需要确定性构建的环境中,例如 CI 管道中。

--offline
阻止 Cargo 以任何理由访问网络。如果没有此标志,如果 Cargo 需要访问网络而网络不可用,则 Cargo 将停止并出现错误。使用此标志,如果可能,Cargo 将尝试在没有网络的情况下继续运行。

请注意,这可能会导致与在线模式不同的依赖项解析。Cargo 将把自己限制在本地下载的 crate 上,即使本地索引副本中指示了可能存在更新的版本。请参阅 cargo-fetch(1) 命令,以便在脱机之前下载依赖项。

也可以使用 net.offline 配置值 指定。

--frozen
等效于同时指定 --locked--offline
--lockfile-path PATH
将锁定文件的路径从默认值 (<workspace_root>/Cargo.lock) 更改为 PATHPATH 必须以 Cargo.lock 结尾(例如 --lockfile-path /tmp/temporary-lockfile/Cargo.lock)。请注意,提供 --lockfile-path 将忽略默认路径下的现有锁定文件,而是使用来自 PATH 的锁定文件,或者如果该文件不存在,则将新的锁定文件写入提供的 PATH 中。此标志可用于在只读目录中运行大多数命令,并将锁定文件写入提供的 PATH 中。

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

通用选项

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

此选项仅在 nightly channel 上可用,并且需要启用 -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,而不是在第一个构建失败的 crate 上中止构建。

例如,如果当前包依赖于依赖项 failsworks,其中一个依赖项构建失败,则 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)