cargo-check(1)

描述

检查本地包及其所有依赖项中的错误。这实质上是在不执行最终代码生成步骤的情况下编译包，这比运行 cargo build 要快。编译器会将元数据文件保存到磁盘，以便在源文件未修改的情况下，将来运行可以重用它们。某些诊断信息和错误只在代码生成期间发出，因此 cargo check 本身不会报告它们。

选项

包选择

默认情况下，未指定包选择选项时，选择的包取决于所选的清单文件（如果未指定 --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 check 将检查所选包的所有二进制和库目标。如果二进制文件缺少 required-features 中指定的特性，则会跳过。

传递目标选择标志将仅检查指定的目标。

请注意，--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 的目标。默认情况下，这包括构建为单元测试的库和二进制文件，以及集成测试。请注意，这也会构建任何所需的依赖项，因此库目标可能会被构建两次（一次作为单元测试，一次作为二进制文件、集成测试等的依赖项）。可以通过在目标的清单设置中设置 test 标志来启用或禁用目标。
--bench name…: 检查指定的基准测试。此标志可以指定多次，并支持常见的 Unix glob 模式。
--benches: 检查所有设置了清单标志 bench = true 的目标。默认情况下，这包括构建为基准测试的库和二进制文件，以及基准测试目标。请注意，这也会构建任何所需的依赖项，因此库目标可能会被构建两次（一次作为基准测试，一次作为二进制文件、基准测试等的依赖项）。可以通过在目标的清单设置中设置 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

检查给定架构。默认值为宿主架构。triple 的一般格式是 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 查看支持的目标列表。此标志可以指定多次。

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

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

-r

--release

使用 release 配置检查优化后的工件。另请参阅 --profile 选项，用于按名称选择特定配置。

--profile name

使用给定的配置进行检查。

作为特例，指定 test 配置也将启用测试模式下的检查，这将启用测试检查并启用 test cfg 选项。有关更多详细信息，请参阅 rustc tests。

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

--timings=fmts

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

html（不稳定，需要 -Zunstable-options）：将一个人类可读的 cargo-timing.html 文件写入 target/cargo-timings 目录，其中包含编译报告。如果您想查看较早的运行，也会将一个带有时间戳的文件写入同一目录。HTML 输出仅适用于人类阅读，不提供机器可读的时序数据。
json（不稳定，需要 -Zunstable-options）：发出关于时序信息的机器可读 JSON 数据。

输出选项

--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：将 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 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 PATH

将锁文件的路径从默认值 (<workspace_root>/Cargo.lock) 更改为 PATH。PATH 必须以 Cargo.lock 结尾（例如 --lockfile-path /tmp/temporary-lockfile/Cargo.lock）。请注意，提供 --lockfile-path 将忽略默认路径下现有的锁文件，转而使用来自 PATH 的锁文件，如果 PATH 不存在，则会将新的锁文件写入提供的 PATH 中。此标志可用于在只读目录中运行大多数命令，将锁文件写入提供的 PATH。

此选项仅在每夜版 (nightly) 通道上可用，需要启用 -Z unstable-options 标志（参见 #14421）。

通用选项

+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 check -j1 可能会或可能不会构建成功的那一个（取决于 Cargo 首先选择运行哪一个构建），而 cargo check -j1 --keep-going 则肯定会运行两个构建，即使首先运行的那一个失败了。

--future-incompat-report

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

请参阅 cargo-report(1)

环境变量

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

退出状态

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

示例

检查本地包中的错误
```
cargo check
```

检查所有目标，包括单元测试

cargo check --all-targets --profile=test

另请参阅

cargo(1), cargo-build(1)

Cargo 图书