cargo-build(1)
名称
cargo-build — 编译当前包
概要
cargo build [选项]
说明
编译本地包及其所有依赖项。
选项
包选择
默认情况下,如果未给出包选择选项,则选择哪些包取决于所选的清单文件(如果没有指定 --manifest-path,则基于当前工作目录)。如果清单文件是工作区的根目录,则选择工作区的默认成员;否则,仅选择由该清单文件定义的包。
工作区的默认成员可以在根清单文件中使用 workspace.default-members 键显式设置。如果未设置此项,虚拟工作区将包含所有工作区成员(等同于传递 --workspace);非虚拟工作区将仅包含根 crate 本身。
-p规格…--package规格…- 仅构建指定的包。有关 SPEC 格式,请参阅 cargo-pkgid(1)。此标志可以指定多次,并支持常见的 Unix glob 模式,如
*、?和[]。然而,为避免 shell 在 Cargo 处理前意外展开 glob 模式,必须在每个模式周围使用单引号或双引号。 --workspace- 构建工作区中的所有成员。
--all--workspace的已弃用别名。--exclude规格…- 排除指定的包。必须与
--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名称…- 构建指定的二进制文件。此标志可以指定多次,并支持常见的 Unix glob 模式。
--bins- 构建所有二进制目标。
--example名称…- 构建指定的示例。此标志可以指定多次,并支持常见的 Unix glob 模式。
--examples- 构建所有示例目标。
--test名称…- 构建指定的集成测试。此标志可以指定多次,并支持常见的 Unix glob 模式。
--tests- 构建所有设置了
test = true清单标志的目标。默认情况下,这包括构建为单元测试的库和二进制文件,以及集成测试。请注意,这也将构建所有必需的依赖项,因此 lib 目标可能会构建两次(一次作为单元测试,一次作为二进制文件、集成测试等的依赖项)。可以通过在目标的清单设置中设置test标志来启用或禁用目标。 --bench名称…- 构建指定的基准测试。此标志可以指定多次,并支持常见的 Unix glob 模式。
--benches- 构建所有设置了
bench = true清单标志的目标。默认情况下,这包括构建为基准测试的库和二进制文件,以及基准目标。请注意,这也将构建所有必需的依赖项,因此 lib 目标可能会构建两次(一次作为基准测试,一次作为二进制文件、基准测试等的依赖项)。可以通过在目标的清单设置中设置bench标志来启用或禁用目标。 --all-targets- 构建所有目标。这等同于指定
--lib --bins --tests --benches --examples。
特性选择
特性标志允许您控制启用哪些特性。如果未给出任何特性选项,则会为每个选定的包激活 default 特性。
有关更多详细信息,请参阅特性文档。
-F特性--features特性- 要激活的特性列表,用空格或逗号分隔。工作区成员的特性可以使用
包名称/特性名称语法启用。此标志可以指定多次,这将启用所有指定的特性。 --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=格式- 输出每次编译花费的时间信息,并随时间跟踪并发信息。接受一个可选的逗号分隔的输出格式列表;不带参数的
--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目录- 将最终工件复制到此目录。
此选项不稳定,仅在每夜构建通道上可用,并且需要
-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格式- 诊断消息的输出格式。可以指定多次,由逗号分隔的值组成。有效值
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一起使用。
--build-plan- 向 stdout 输出一系列 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。 --lockfile-path路径- 将锁定文件的路径从默认路径(
<工作区根目录>/Cargo.lock)更改为 路径。路径 必须以Cargo.lock结尾(例如--lockfile-path /tmp/temporary-lockfile/Cargo.lock)。请注意,提供--lockfile-path将忽略默认路径下现有的锁定文件,而是使用 路径 中的锁定文件,或者如果不存在,则将新的锁定文件写入提供的 路径 中。此标志可用于在只读目录中运行大多数命令,将锁定文件写入提供的 路径。
通用选项
+工具链- 如果 Cargo 是通过 rustup 安装的,并且
cargo的第一个参数以+开头,它将被解释为 rustup 工具链名称(例如+stable或+nightly)。有关工具链覆盖如何工作的更多信息,请参阅 rustup 文档。 --config键=值 或 路径- 覆盖 Cargo 配置值。参数应采用 TOML 语法
键=值,或作为额外配置文件的路径提供。此标志可以指定多次。有关更多信息,请参阅命令行覆盖章节。 -C路径- 在执行任何指定操作之前更改当前工作目录。这会影响 Cargo 默认在哪里查找项目清单文件(
Cargo.toml),以及搜索.cargo/config.toml的目录等。此选项必须出现在命令名称之前,例如cargo -C path/to/my-project build。 -h--help- 打印帮助信息。
-Z标志- Cargo 不稳定(仅限每夜构建)标志。运行
cargo -Z help查看详细信息。
杂项选项
-jN--jobsN- 并行运行的任务数量。也可以通过
build.jobs配置值指定。默认为逻辑 CPU 数量。如果为负数,则将最大并行任务数量设置为逻辑 CPU 数量加上提供的值。如果提供字符串default,则将值恢复为默认值。不应为 0。 --keep-going- 尽可能构建依赖图中的 crate,而不是在第一个构建失败时中止构建。
例如,如果当前包依赖于依赖项
fails和works,其中一个构建失败,cargo build -j1可能构建或不构建成功的那个(取决于 Cargo 首先选择运行哪一个),而cargo build -j1 --keep-going则肯定会运行这两个构建,即使第一个运行的失败了。 --future-incompat-report- 显示在此命令执行期间产生的任何未来不兼容警告的报告
环境变量
有关 Cargo 读取的环境变量的详细信息,请参阅参考。
退出状态
0:Cargo 成功。101:Cargo 未能完成。
示例
-
构建本地包及其所有依赖项
cargo build -
使用优化构建
cargo build --release