配置

本文档解释了 Cargo 的配置系统如何工作,以及可用的键或配置。有关通过清单文件配置包的信息,请参阅清单格式

层级结构

Cargo 允许为特定包进行本地配置,以及全局配置。它会在当前目录和所有父目录中查找配置文件。例如,如果 Cargo 在 /projects/foo/bar/baz 中被调用,那么将按以下顺序探测并统一以下配置文件:

  • /projects/foo/bar/baz/.cargo/config.toml
  • /projects/foo/bar/.cargo/config.toml
  • /projects/foo/.cargo/config.toml
  • /projects/.cargo/config.toml
  • /.cargo/config.toml
  • $CARGO_HOME/config.toml,默认为
    • Windows: %USERPROFILE%\.cargo\config.toml
    • Unix: $HOME/.cargo/config.toml

使用这种结构,您可以为每个包指定配置,甚至可以将其检入版本控制。您还可以使用主目录中的配置文件指定个人默认设置。

如果在多个配置文件中指定了同一个键,这些值将被合并在一起。数字、字符串和布尔值将使用更深层配置目录中的值,其优先级高于祖先目录,其中主目录的优先级最低。数组将被合并在一起,优先级较高的项目将被放置在合并后的数组的后面。

目前,当从工作区调用时,Cargo 不会读取工作区内 crate 的配置文件。例如,如果工作区中有两个 crate,分别名为 /projects/foo/bar/baz/mylib/projects/foo/bar/baz/mybin,并且在 /projects/foo/bar/baz/mylib/.cargo/config.toml/projects/foo/bar/baz/mybin/.cargo/config.toml 中存在 Cargo 配置,则当从工作区根目录(/projects/foo/bar/baz/)调用时,Cargo 不会读取这些配置文件。

注意: Cargo 也会读取没有 .toml 扩展名的配置文件,例如 .cargo/config。对 .toml 扩展名的支持是在 1.39 版本中添加的,并且是首选形式。如果两个文件都存在,Cargo 将使用没有扩展名的文件。

配置格式

配置文件以 TOML 格式编写(类似于清单文件),在节(表格)内使用简单的键值对。以下是所有设置的快速概述,详细说明如下。

paths = ["/path/to/override"] # path dependency overrides

[alias]     # command aliases
b = "build"
c = "check"
t = "test"
r = "run"
rr = "run --release"
recursive_example = "rr --example recursions"
space_example = ["run", "--release", "--", "\"command list\""]

[build]
jobs = 1                      # number of parallel jobs, defaults to # of CPUs
rustc = "rustc"               # the rust compiler tool
rustc-wrapper = "…"           # run this wrapper instead of `rustc`
rustc-workspace-wrapper = "…" # run this wrapper instead of `rustc` for workspace members
rustdoc = "rustdoc"           # the doc generator tool
target = "triple"             # build for the target triple (ignored by `cargo install`)
target-dir = "target"         # path of where to place all generated artifacts
rustflags = ["…", "…"]        # custom flags to pass to all compiler invocations
rustdocflags = ["…", "…"]     # custom flags to pass to rustdoc
incremental = true            # whether or not to enable incremental compilation
dep-info-basedir = "…"        # path for the base directory for targets in depfiles

[credential-alias]
# Provides a way to define aliases for credential providers.
my-alias = ["/usr/bin/cargo-credential-example", "--argument", "value", "--flag"]

[doc]
browser = "chromium"          # browser to use with `cargo doc --open`,
                              # overrides the `BROWSER` environment variable

[env]
# Set ENV_VAR_NAME=value for any process run by Cargo
ENV_VAR_NAME = "value"
# Set even if already present in environment
ENV_VAR_NAME_2 = { value = "value", force = true }
# Value is relative to .cargo directory containing `config.toml`, make absolute
ENV_VAR_NAME_3 = { value = "relative/path", relative = true }

[future-incompat-report]
frequency = 'always' # when to display a notification about a future incompat report

[cargo-new]
vcs = "none"              # VCS to use ('git', 'hg', 'pijul', 'fossil', 'none')

[http]
debug = false               # HTTP debugging
proxy = "host:port"         # HTTP proxy in libcurl format
ssl-version = "tlsv1.3"     # TLS version to use
ssl-version.max = "tlsv1.3" # maximum TLS version
ssl-version.min = "tlsv1.1" # minimum TLS version
timeout = 30                # timeout for each HTTP request, in seconds
low-speed-limit = 10        # network timeout threshold (bytes/sec)
cainfo = "cert.pem"         # path to Certificate Authority (CA) bundle
check-revoke = true         # check for SSL certificate revocation
multiplexing = true         # HTTP/2 multiplexing
user-agent = "…"            # the user-agent header

[install]
root = "/some/path"         # `cargo install` destination directory

[net]
retry = 3                   # network retries
git-fetch-with-cli = true   # use the `git` executable for git operations
offline = true              # do not access the network

[net.ssh]
known-hosts = ["..."]       # known SSH host keys

[patch.<registry>]
# Same keys as for [patch] in Cargo.toml

[profile.<name>]         # Modify profile settings via config.
inherits = "dev"         # Inherits settings from [profile.dev].
opt-level = 0            # Optimization level.
debug = true             # Include debug info.
split-debuginfo = '...'  # Debug info splitting behavior.
strip = "none"           # Removes symbols or debuginfo.
debug-assertions = true  # Enables debug assertions.
overflow-checks = true   # Enables runtime integer overflow checks.
lto = false              # Sets link-time optimization.
panic = 'unwind'         # The panic strategy.
incremental = true       # Incremental compilation.
codegen-units = 16       # Number of code generation units.
rpath = false            # Sets the rpath linking option.
[profile.<name>.build-override]  # Overrides build-script settings.
# Same keys for a normal profile.
[profile.<name>.package.<name>]  # Override profile for a package.
# Same keys for a normal profile (minus `panic`, `lto`, and `rpath`).

[resolver]
incompatible-rust-versions = "allow"  # Specifies how resolver reacts to these

[registries.<name>]  # registries other than crates.io
index = "…"          # URL of the registry index
token = "…"          # authentication token for the registry
credential-provider = "cargo:token" # The credential provider for this registry.

[registries.crates-io]
protocol = "sparse"  # The protocol to use to access crates.io.

[registry]
default = "…"        # name of the default registry
token = "…"          # authentication token for crates.io
credential-provider = "cargo:token"           # The credential provider for crates.io.
global-credential-providers = ["cargo:token"] # The credential providers to use by default.

[source.<name>]      # source definition and replacement
replace-with = "…"   # replace this source with the given named source
directory = "…"      # path to a directory source
registry = "…"       # URL to a registry source
local-registry = "…" # path to a local registry source
git = "…"            # URL of a git repository source
branch = "…"         # branch name for the git repository
tag = "…"            # tag name for the git repository
rev = "…"            # revision for the git repository

[target.<triple>]
linker = "…"              # linker to use
runner = "…"              # wrapper to run executables
rustflags = ["…", "…"]    # custom flags for `rustc`
rustdocflags = ["…", "…"] # custom flags for `rustdoc`

[target.<cfg>]
runner = "…"            # wrapper to run executables
rustflags = ["…", "…"]  # custom flags for `rustc`

[target.<triple>.<links>] # `links` build script override
rustc-link-lib = ["foo"]
rustc-link-search = ["/path/to/foo"]
rustc-flags = "-L /some/path"
rustc-cfg = ['key="value"']
rustc-env = {key = "value"}
rustc-cdylib-link-arg = ["…"]
metadata_key1 = "value"
metadata_key2 = "value"

[term]
quiet = false          # whether cargo output is quiet
verbose = false        # whether cargo provides verbose output
color = 'auto'         # whether cargo colorizes output
hyperlinks = true      # whether cargo inserts links into output
unicode = true         # whether cargo can render output using non-ASCII unicode characters
progress.when = 'auto' # whether cargo shows progress bar
progress.width = 80    # width of progress bar

环境变量

除了 TOML 配置文件之外,Cargo 还可以通过环境变量进行配置。对于 foo.bar 形式的每个配置键,还可以使用环境变量 CARGO_FOO_BAR 来定义值。键转换为大写,点和破折号转换为下划线。例如,target.x86_64-unknown-linux-gnu.runner 键也可以由 CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_RUNNER 环境变量定义。

环境变量的优先级高于 TOML 配置文件。目前,仅支持通过环境变量定义整数、布尔值、字符串和一些数组值。以下说明指出了哪些键支持环境变量,否则由于 技术问题,不支持它们。

除了上述系统之外,Cargo 还识别一些其他的特定环境变量

命令行覆盖

Cargo 还接受通过 --config 命令行选项进行任意配置覆盖。该参数应采用 KEY=VALUE 的 TOML 语法,或作为额外配置文件的路径提供。

# With `KEY=VALUE` in TOML syntax
cargo --config net.git-fetch-with-cli=true fetch

# With a path to a configuration file
cargo --config ./path/to/my/extra-config.toml fetch

--config 选项可以指定多次,在这种情况下,这些值将按从左到右的顺序合并,使用与应用多个配置文件时相同的合并逻辑。以这种方式指定的配置值优先于环境变量,而环境变量的优先级高于配置文件。

--config 选项作为额外的配置文件提供时,以此方式加载的配置文件的优先级规则与直接使用 --config 指定的其他选项相同。

以下是一些使用 Bourne shell 语法的示例:

# Most shells will require escaping.
cargo --config http.proxy=\"http://example.com\" …

# Spaces may be used.
cargo --config "net.git-fetch-with-cli = true" …

# TOML array example. Single quotes make it easier to read and write.
cargo --config 'build.rustdocflags = ["--html-in-header", "header.html"]' …

# Example of a complex TOML key.
cargo --config "target.'cfg(all(target_arch = \"arm\", target_os = \"none\"))'.runner = 'my-runner'" …

# Example of overriding a profile setting.
cargo --config profile.dev.package.image.opt-level=3 …

配置相关路径

配置文件中的路径可以是绝对路径、相对路径,也可以是不带任何路径分隔符的裸名称。对于不带路径分隔符的可执行文件路径,将使用 PATH 环境变量搜索可执行文件。对于非可执行文件的路径,将相对于定义配置值的目录。

具体来说,规则是:

  • 对于环境变量,路径相对于当前工作目录。
  • 对于直接从--config KEY=VALUE选项加载的配置值,路径相对于当前工作目录。
  • 对于配置文件,路径相对于定义配置文件的目录的父目录,无论这些文件来自分层探测还是--config <path>选项。

注意:为了与现有的 .cargo/config.toml 探测行为保持一致,通过 --config <path> 传递的配置文件中的路径也是相对于配置文件本身向上两级的路径,这是设计使然。

为了避免出现意外结果,经验法则是将额外的配置文件放在项目中发现的 .cargo/config.toml 的同一级别。例如,给定一个项目 /my/project,建议将配置文件放在 /my/project/.cargo 下,或放在同一级别的新目录中,例如 /my/project/.config

# Relative path examples.

[target.x86_64-unknown-linux-gnu]
runner = "foo"  # Searches `PATH` for `foo`.

[source.vendored-sources]
# Directory is relative to the parent where `.cargo/config.toml` is located.
# For example, `/my/project/.cargo/config.toml` would result in `/my/project/vendor`.
directory = "vendor"

带有参数的可执行文件路径

一些 Cargo 命令会调用外部程序,这些程序可以配置为路径和一些参数。

该值可以是字符串数组,如 ['/path/to/program', 'somearg'],也可以是空格分隔的字符串,如 '/path/to/program somearg'。如果可执行文件的路径包含空格,则必须使用列表形式。

如果 Cargo 将其他参数(例如要打开或运行的路径)传递给程序,它们将在该格式的选项值中最后一个指定参数之后传递。如果指定的程序没有路径分隔符,Cargo 将在 PATH 中搜索其可执行文件。

凭据

包含敏感信息的配置值存储在 $CARGO_HOME/credentials.toml 文件中。当使用 cargo:token 凭据提供程序时,此文件由 cargo logincargo logout 自动创建和更新。

令牌由一些 Cargo 命令(例如 cargo publish)用于对远程注册表进行身份验证。应注意保护令牌并使其保密。

它遵循与 Cargo 配置文件相同的格式。

[registry]
token = "…"   # Access token for crates.io

[registries.<name>]
token = "…"   # Access token for the named registry

与大多数其他配置值一样,令牌可以使用环境变量指定。crates.io 的令牌可以使用 CARGO_REGISTRY_TOKEN 环境变量指定。其他注册表的令牌可以使用 CARGO_REGISTRIES_<name>_TOKEN 形式的环境变量指定,其中 <name> 是注册表的名称,全部大写。

注意: Cargo 还会读取和写入没有 .toml 扩展名的凭据文件,例如 .cargo/credentials。对 .toml 扩展名的支持是在 1.39 版本中添加的。在 1.68 版本中,Cargo 默认写入带有扩展名的文件。但是,出于向后兼容的原因,当两个文件都存在时,Cargo 将读取和写入没有扩展名的文件。

配置键

本节记录了所有配置键。具有可变部分的键的描述使用尖括号注释,例如 target.<triple>,其中 <triple> 部分可以是任何目标三元组,例如 target.x86_64-pc-windows-msvc

paths

  • 类型:字符串数组(路径)
  • 默认:无
  • 环境变量:不支持

本地包的路径数组,这些路径将用作依赖项的覆盖。有关更多信息,请参阅覆盖依赖项指南

[alias]

  • 类型:字符串或字符串数组
  • 默认:见下文
  • 环境变量:CARGO_ALIAS_<name>

[alias] 表定义 CLI 命令别名。例如,运行 cargo b 是运行 cargo build 的别名。表中的每个键都是子命令,值是要运行的实际命令。该值可以是字符串数组,其中第一个元素是命令,其余是参数。它也可以是字符串,它将被空格拆分为子命令和参数。以下别名内置于 Cargo:

[alias]
b = "build"
c = "check"
d = "doc"
t = "test"
r = "run"
rm = "remove"

不允许别名重新定义现有的内置命令。

别名是递归的。

[alias]
rr = "run --release"
recursive_example = "rr --example recursions"

[build]

[build] 表控制构建时操作和编译器设置。

build.jobs

  • 类型:整数或字符串
  • 默认:逻辑 CPU 的数量
  • 环境变量:CARGO_BUILD_JOBS

设置并行运行的编译器进程的最大数量。如果为负数,则将编译器进程的最大数量设置为逻辑 CPU 的数量加上提供的值。不应为 0。如果提供字符串 default,则将值设置回默认值。

可以使用 --jobs CLI 选项覆盖。

build.rustc

  • 类型:字符串(程序路径)
  • 默认:"rustc"
  • 环境变量:CARGO_BUILD_RUSTCRUSTC

设置用于 rustc 的可执行文件。

build.rustc-wrapper

  • 类型:字符串(程序路径)
  • 默认:无
  • 环境变量:CARGO_BUILD_RUSTC_WRAPPERRUSTC_WRAPPER

设置要执行的包装器,而不是 rustc。传递给包装器的第一个参数是要使用的实际可执行文件的路径(即,如果设置了 build.rustc,则为该路径,否则为 "rustc")。

build.rustc-workspace-wrapper

  • 类型:字符串(程序路径)
  • 默认:无
  • 环境变量:CARGO_BUILD_RUSTC_WORKSPACE_WRAPPERRUSTC_WORKSPACE_WRAPPER

设置要执行的包装器,而不是 rustc,仅适用于工作区成员。当构建没有工作区的单包项目时,该包将被视为工作区。传递给包装器的第一个参数是要使用的实际可执行文件的路径(即,如果设置了 build.rustc,则为该路径,否则为 "rustc")。它会影响文件名哈希,以便包装器生成的工件可以单独缓存。

如果同时设置了 rustc-wrapperrustc-workspace-wrapper,则它们将嵌套:最终调用是 $RUSTC_WRAPPER $RUSTC_WORKSPACE_WRAPPER $RUSTC

build.rustdoc

  • 类型:字符串(程序路径)
  • 默认:"rustdoc"
  • 环境变量:CARGO_BUILD_RUSTDOCRUSTDOC

设置用于 rustdoc 的可执行文件。

build.target

  • 类型:字符串或字符串数组
  • 默认:主机平台
  • 环境变量:CARGO_BUILD_TARGET

要编译到的默认目标平台三元组

这允许传递字符串或字符串数组。每个字符串值都是一个目标平台三元组。选定的构建目标将为每个选定的架构构建。

字符串值也可以是 .json 目标规范文件的相对路径。

可以使用 --target CLI 选项覆盖。

[build]
target = ["x86_64-unknown-linux-gnu", "i686-unknown-linux-gnu"]

build.target-dir

  • 类型:字符串(路径)
  • 默认:"target"
  • 环境:CARGO_BUILD_TARGET_DIRCARGO_TARGET_DIR

所有编译器输出的存放路径。如果未指定,则默认为工作区根目录下的名为 target 的目录。

可以使用 --target-dir 命令行选项覆盖。

build.rustflags

  • 类型:字符串或字符串数组
  • 默认:无
  • 环境:CARGO_BUILD_RUSTFLAGSCARGO_ENCODED_RUSTFLAGSRUSTFLAGS

传递给 rustc 的额外命令行标志。该值可以是字符串数组或以空格分隔的字符串。

额外的标志有四个互斥的来源。它们按顺序检查,并使用第一个找到的来源:

  1. CARGO_ENCODED_RUSTFLAGS 环境变量。
  2. RUSTFLAGS 环境变量。
  3. 所有匹配的 target.<triple>.rustflagstarget.<cfg>.rustflags 配置项组合在一起。
  4. build.rustflags 配置值。

也可以使用 cargo rustc 命令传递额外的标志。

如果使用 --target 标志(或 build.target),则这些标志将仅传递给目标编译器的编译。为主机构建的内容,例如构建脚本或过程宏,将不会接收这些参数。如果没有 --target,标志将传递给所有编译器调用(包括构建脚本和过程宏),因为依赖项是共享的。如果你有不想传递给构建脚本或过程宏的参数,并且是为主机构建的,请使用 主机三元组 传递 --target

不建议传入 Cargo 通常自己管理的标志。例如,由 配置文件驱动的标志最好通过设置相应的配置文件设置来处理。

注意:由于直接将标志传递给编译器的底层特性,这可能会与 Cargo 的未来版本发生冲突,这些版本可能会自己发出相同或类似的标志,这可能会干扰你指定的标志。这是一个 Cargo 可能不总是向后兼容的领域。

build.rustdocflags

  • 类型:字符串或字符串数组
  • 默认:无
  • 环境:CARGO_BUILD_RUSTDOCFLAGSCARGO_ENCODED_RUSTDOCFLAGSRUSTDOCFLAGS

传递给 rustdoc 的额外命令行标志。该值可以是字符串数组或以空格分隔的字符串。

额外的标志有四个互斥的来源。它们按顺序检查,并使用第一个找到的来源:

  1. CARGO_ENCODED_RUSTDOCFLAGS 环境变量。
  2. RUSTDOCFLAGS 环境变量。
  3. 所有匹配的 target.<triple>.rustdocflags 配置项组合在一起。
  4. build.rustdocflags 配置值。

也可以使用 cargo rustdoc 命令传递额外的标志。

注意:由于直接将标志传递给编译器的底层特性,这可能会与 Cargo 的未来版本发生冲突,这些版本可能会自己发出相同或类似的标志,这可能会干扰你指定的标志。这是一个 Cargo 可能不总是向后兼容的领域。

build.incremental

  • 类型:bool
  • 默认值:来自配置文件
  • 环境:CARGO_BUILD_INCREMENTALCARGO_INCREMENTAL

是否执行增量编译。如果未设置,则默认为使用配置文件中的值。否则,这将覆盖所有配置文件的设置。

可以将 CARGO_INCREMENTAL 环境变量设置为 1 以强制为所有配置文件启用增量编译,或者设置为 0 以禁用它。此环境变量会覆盖配置设置。

build.dep-info-basedir

  • 类型:字符串(路径)
  • 默认:无
  • 环境:CARGO_BUILD_DEP_INFO_BASEDIR

依赖信息文件路径中删除给定的路径前缀。此配置设置旨在将绝对路径转换为相对路径,以供需要相对路径的工具使用。

设置本身是相对于配置文件的路径。因此,例如,值 "." 将删除所有以 .cargo 目录的父目录开头的路径。

build.pipelining

此选项已弃用且未使用。Cargo 始终启用流水线。

[credential-alias]

  • 类型:字符串或字符串数组
  • 默认值:空
  • 环境:CARGO_CREDENTIAL_ALIAS_<name>

[credential-alias] 表定义了凭据提供程序别名。这些别名可以作为 registry.global-credential-providers 数组的一个元素引用,或者作为 registries.<NAME>.credential-provider 下特定注册表的凭据提供程序。

如果指定为字符串,则该值将以空格分割为路径和参数。

例如,定义一个名为 my-alias 的别名

[credential-alias]
my-alias = ["/usr/bin/cargo-credential-example", "--argument", "value", "--flag"]

有关更多信息,请参阅注册表身份验证

[doc]

[doc] 表定义了 cargo doc 命令的选项。

doc.browser

  • 类型:字符串或字符串数组(带有参数的程序路径
  • 默认值:BROWSER 环境变量,或者,如果缺少该变量,则以系统特定的方式打开链接

此选项设置 cargo doc 要使用的浏览器,当使用 --open 选项打开文档时,将覆盖 BROWSER 环境变量。

[cargo-new]

[cargo-new] 表定义了 cargo new 命令的默认值。

cargo-new.name

此选项已弃用且未使用。

cargo-new.email

此选项已弃用且未使用。

cargo-new.vcs

  • 类型:字符串
  • 默认值:"git""none"
  • 环境:CARGO_CARGO_NEW_VCS

指定用于初始化新存储库的源代码控制系统。有效值是 githg(用于 Mercurial)、pijulfossilnone 以禁用此行为。默认为 git,如果已经在 VCS 存储库中,则默认为 none。可以使用 --vcs 命令行选项覆盖。

[env]

[env] 部分允许你为构建脚本、rustc 调用、cargo runcargo build 设置额外的环境变量。

[env]
OPENSSL_DIR = "/opt/openssl"

默认情况下,指定的变量不会覆盖环境中已存在的值。可以通过设置 force 标志来更改此行为。

设置 relative 标志会将该值评估为相对于包含 config.toml 文件的 .cargo 目录的父目录的配置文件相对路径。环境变量的值将是完整的绝对路径。

[env]
TMPDIR = { value = "/home/tmp", force = true }
OPENSSL_DIR = { value = "vendor/openssl", relative = true }

[future-incompat-report]

[future-incompat-report] 表控制未来不兼容报告的设置

future-incompat-report.frequency

  • 类型:字符串
  • 默认值:"always"
  • 环境:CARGO_FUTURE_INCOMPAT_REPORT_FREQUENCY

控制当未来不兼容报告可用时,我们在终端显示通知的频率。可能的值:

  • always(默认):当命令(例如 cargo build)生成未来不兼容报告时,始终显示通知
  • never:从不显示通知

[http]

[http] 表定义了 HTTP 行为的设置。这包括获取 crate 依赖项和访问远程 git 存储库。

http.debug

  • 类型:布尔值
  • 默认值:false
  • 环境:CARGO_HTTP_DEBUG

如果为 true,则启用 HTTP 请求的调试。可以通过设置 CARGO_LOG=network=debug 环境变量(或使用 network=trace 以获得更多信息)来查看调试信息。

在公共位置发布此输出的日志时要谨慎。输出可能包含带有身份验证令牌的标头,你不想泄漏这些令牌!请务必在发布日志之前查看它们。

http.proxy

  • 类型:字符串
  • 默认:无
  • 环境:CARGO_HTTP_PROXYHTTPS_PROXYhttps_proxyhttp_proxy

设置要使用的 HTTP 和 HTTPS 代理。格式为 libcurl 格式,如 [协议://]主机[:端口]。如果未设置,Cargo 还将检查你的全局 git 配置中的 http.proxy 设置。如果未设置这些,则 HTTPS_PROXYhttps_proxy 环境变量会设置 HTTPS 请求的代理,而 http_proxy 会设置 HTTP 请求的代理。

http.timeout

  • 类型:整数
  • 默认值:30
  • 环境:CARGO_HTTP_TIMEOUTHTTP_TIMEOUT

设置每个 HTTP 请求的超时时间(以秒为单位)。

http.cainfo

  • 类型:字符串(路径)
  • 默认:无
  • 环境:CARGO_HTTP_CAINFO

证书颁发机构 (CA) 捆绑文件的路径,用于验证 TLS 证书。如果未指定,Cargo 会尝试使用系统证书。

http.check-revoke

  • 类型:布尔值
  • 默认值:true(Windows)false(所有其他平台)
  • 环境:CARGO_HTTP_CHECK_REVOKE

这决定是否应执行 TLS 证书吊销检查。这仅适用于 Windows。

http.ssl-version

  • 类型:字符串或 min/max 表
  • 默认:无
  • 环境:CARGO_HTTP_SSL_VERSION

这将设置要使用的最低 TLS 版本。它采用一个字符串,其中一个可能的值为 "default""tlsv1""tlsv1.0""tlsv1.1""tlsv1.2""tlsv1.3"

这也可以采用一个具有两个键(minmax)的表,每个键都采用一个相同类型的字符串值,该字符串值指定要使用的 TLS 版本的最小和最大范围。

默认值为 "tlsv1.0" 的最小版本和你平台上支持的最新版本(通常为 "tlsv1.3")的最大版本。

http.low-speed-limit

  • 类型:整数
  • 默认值:10
  • 环境:CARGO_HTTP_LOW_SPEED_LIMIT

此设置控制慢速连接的超时行为。如果每秒的平均传输速度低于给定值,并且持续 http.timeout 秒(默认 30 秒),则认为连接速度太慢,Cargo 将中止并重试。

http.multiplexing

  • 类型:布尔值
  • 默认值:true
  • 环境:CARGO_HTTP_MULTIPLEXING

当为 true 时,Cargo 将尝试使用具有多路复用的 HTTP2 协议。这允许多个请求使用相同的连接,通常可以提高获取多个文件时的性能。如果为 false,Cargo 将使用没有流水线的 HTTP 1.1。

http.user-agent

  • 类型:字符串
  • 默认值:Cargo 的版本
  • 环境:CARGO_HTTP_USER_AGENT

指定要使用的自定义用户代理标头。如果未指定,则默认值为包含 Cargo 版本的字符串。

[install]

[install] 表定义了 cargo install 命令的默认值。

install.root

  • 类型:字符串(路径)
  • 默认值:Cargo 的主目录
  • 环境:CARGO_INSTALL_ROOT

设置用于为 cargo install 安装可执行文件的根目录路径。可执行文件将进入根目录下的 bin 目录。

为了跟踪已安装可执行文件的信息,还会在该根目录下创建一些额外的文件,例如 .crates.toml.crates2.json

如果未指定,则默认为 Cargo 的主目录(在您的主目录中默认为 .cargo)。

可以使用 --root 命令行选项覆盖此设置。

[net]

[net] 表控制网络配置。

net.retry

  • 类型:整数
  • 默认值:3
  • 环境变量:CARGO_NET_RETRY

重试可能出现的虚假网络错误的次数。

net.git-fetch-with-cli

  • 类型:布尔值
  • 默认值:false
  • 环境变量:CARGO_NET_GIT_FETCH_WITH_CLI

如果此值为 true,则 Cargo 将使用 git 可执行文件来获取注册表索引和 git 依赖项。如果为 false,则使用内置的 git 库。

如果您的身份验证要求比较特殊,而 Cargo 不支持,则将其设置为 true 会很有帮助。有关设置 git 身份验证的更多信息,请参阅 Git 身份验证

net.offline

  • 类型:布尔值
  • 默认值:false
  • 环境变量:CARGO_NET_OFFLINE

如果此值为 true,则 Cargo 将避免访问网络,并尝试使用本地缓存的数据继续。如果为 false,Cargo 将根据需要访问网络,并在遇到网络错误时生成错误。

可以使用 --offline 命令行选项覆盖此设置。

net.ssh

[net.ssh] 表包含 SSH 连接的设置。

net.ssh.known-hosts

  • 类型:字符串数组
  • 默认值:请参阅描述
  • 环境变量:不支持

known-hosts 数组包含一个 SSH 主机密钥列表,在连接到 SSH 服务器(例如用于 SSH git 依赖项)时,这些密钥应被接受为有效。每个条目应为一个字符串,格式类似于 OpenSSH known_hosts 文件。每个字符串应以一个或多个以逗号分隔的主机名开头,后跟一个空格,密钥类型名称,一个空格,以及 base64 编码的密钥。例如

[net.ssh]
known-hosts = [
    "example.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFO4Q5T0UV0SQevair9PFwoxY9dl4pQl3u5phoqJH3cF"
]

Cargo 将尝试从 OpenSSH 支持的常见位置加载已知主机密钥,并将其与 Cargo 配置文件中列出的密钥合并。如果任何匹配的条目具有正确的密钥,则允许连接。

Cargo 内置了 github.com 的主机密钥。如果这些密钥发生更改,您可以将新密钥添加到配置文件或 known_hosts 文件中。

有关更多详细信息,请参阅 Git 身份验证

[patch]

正如您可以使用 Cargo.toml 中的 [patch] 覆盖依赖项一样,您也可以在 cargo 配置文件中覆盖它们,以将这些补丁应用于任何受影响的构建。其格式与 Cargo.toml 中使用的格式相同。

由于 .cargo/config.toml 文件通常不签入到源代码控制中,因此您应尽可能优先使用 Cargo.toml 进行修补,以确保其他开发人员可以在自己的环境中编译您的 crate。通过 cargo 配置文件进行修补通常仅在补丁部分由外部构建工具自动生成时才适用。

如果给定的依赖项在 cargo 配置文件和 Cargo.toml 文件中都被修补,则使用配置文件中的补丁。如果多个配置文件修补同一依赖项,则使用标准的 cargo 配置合并,该合并优先使用离当前目录最近定义的值,其中 $HOME/.cargo/config.toml 的优先级最低。

此类 [patch] 部分中的相对 path 依赖项是相对于它们出现的配置文件解析的。

[profile]

[profile] 表可用于全局更改配置文件设置,并覆盖 Cargo.toml 中指定的设置。它具有与 Cargo.toml 中指定的配置文件相同的语法和选项。有关选项的详细信息,请参阅 配置文件章节

[profile.<name>.build-override]

  • 环境变量:CARGO_PROFILE_<name>_BUILD_OVERRIDE_<key>

build-override 表覆盖构建脚本、过程宏及其依赖项的设置。它具有与普通配置文件相同的键。有关更多详细信息,请参阅覆盖部分

[profile.<name>.package.<name>]

  • 环境变量:不支持

package 表覆盖特定包的设置。它具有与普通配置文件相同的键,但不包括 panicltorpath 设置。有关更多详细信息,请参阅覆盖部分

profile.<name>.codegen-units

  • 类型:整数
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_CODEGEN_UNITS

请参阅 codegen-units

profile.<name>.debug

  • 类型:整数或布尔值
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_DEBUG

请参阅 debug

profile.<name>.split-debuginfo

  • 类型:字符串
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_SPLIT_DEBUGINFO

请参阅 split-debuginfo

profile.<name>.debug-assertions

  • 类型:布尔值
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_DEBUG_ASSERTIONS

请参阅 debug-assertions

profile.<name>.incremental

  • 类型:布尔值
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_INCREMENTAL

请参阅 incremental

profile.<name>.lto

  • 类型:字符串或布尔值
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_LTO

请参阅 lto

profile.<name>.overflow-checks

  • 类型:布尔值
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_OVERFLOW_CHECKS

请参阅 overflow-checks

profile.<name>.opt-level

  • 类型:整数或字符串
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_OPT_LEVEL

请参阅 opt-level

profile.<name>.panic

  • 类型:字符串
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_PANIC

请参阅 panic

profile.<name>.rpath

  • 类型:布尔值
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_RPATH

请参阅 rpath

profile.<name>.strip

  • 类型:字符串或布尔值
  • 默认值:请参阅配置文件文档。
  • 环境变量:CARGO_PROFILE_<name>_STRIP

请参阅 strip

[resolver]

[resolver] 表覆盖本地开发的依赖项解析行为(例如,排除 cargo install)。

resolver.incompatible-rust-versions

  • 类型:字符串
  • 默认值:请参阅 resolver 文档
  • 环境变量:CARGO_RESOLVER_INCOMPATIBLE_RUST_VERSIONS

在解析要使用的依赖项版本时,选择如何处理具有不兼容 package.rust-version 的版本。值包括

  • allow:像对待任何其他版本一样对待与 rust-version 不兼容的版本
  • fallback:仅当没有其他版本匹配时才考虑与 rust-version 不兼容的版本

可以使用以下方式覆盖:

  • --ignore-rust-version CLI 选项
  • 将依赖项的版本要求设置得高于任何具有兼容 rust-version 的版本
  • 使用 --precise 将版本指定为 cargo update

有关更多详细信息,请参阅 resolver 章节。

MSRV

  • 任何版本都支持 allow
  • fallback 从 1.84 版本开始支持

[registries]

[registries] 表用于指定其他注册表。它由每个命名注册表的子表组成。

registries.<name>.index

  • 类型:字符串(url)
  • 默认:无
  • 环境变量:CARGO_REGISTRIES_<name>_INDEX

指定注册表的索引 URL。

registries.<name>.token

  • 类型:字符串
  • 默认:无
  • 环境变量:CARGO_REGISTRIES_<name>_TOKEN

指定给定注册表的身份验证令牌。此值应仅出现在 凭据 文件中。这用于需要身份验证的注册表命令,例如 cargo publish

可以使用 --token 命令行选项覆盖此设置。

registries.<name>.credential-provider

  • 类型:字符串或路径和参数的数组
  • 默认:无
  • 环境变量:CARGO_REGISTRIES_<name>_CREDENTIAL_PROVIDER

指定给定注册表的凭据提供程序。如果未设置,将使用 registry.global-credential-providers 中的提供程序。

如果指定为字符串,则路径和参数将以空格分隔。对于包含空格的路径或参数,请使用数组。

如果该值存在于 [credential-alias] 表中,将使用该别名。

有关更多信息,请参阅注册表身份验证

registries.crates-io.protocol

  • 类型:字符串
  • 默认值:"sparse"
  • 环境变量:CARGO_REGISTRIES_CRATES_IO_PROTOCOL

指定用于访问 crates.io 的协议。允许的值为 gitsparse

git 会导致 Cargo 从 https://github.com/rust-lang/crates.io-index/ 克隆所有已发布到 crates.io 的包的整个索引。由于索引的大小,这可能会对性能产生影响。sparse 是一种较新的协议,它使用 HTTPS 仅从 https://index.crates.io/ 下载必要的内容。在大多数情况下,这可以显著提高解析新依赖项的性能。

有关注册表协议的更多信息,请参见 注册表章节

[registry]

[registry] 表控制未指定时的默认注册表。

registry.index

此值不再被接受,不应使用。

registry.default

  • 类型:字符串
  • 默认值:"crates-io"
  • 环境变量:CARGO_REGISTRY_DEFAULT

要默认用于注册表命令(如 cargo publish)的注册表名称(来自 registries)。

可以使用 --registry 命令行选项覆盖此设置。

registry.credential-provider

  • 类型:字符串或路径和参数的数组
  • 默认:无
  • 环境变量:CARGO_REGISTRY_CREDENTIAL_PROVIDER

指定 crates.io 的凭据提供程序。如果未设置,将使用 registry.global-credential-providers 中的提供程序。

如果指定为字符串,则路径和参数将以空格分隔。对于包含空格的路径或参数,请使用数组。

如果该值存在于 [credential-alias] 表中,将使用该别名。

有关更多信息,请参阅注册表身份验证

registry.token

  • 类型:字符串
  • 默认:无
  • 环境变量:CARGO_REGISTRY_TOKEN

指定 crates.io 的身份验证令牌。此值应仅出现在 凭据 文件中。这用于需要身份验证的注册表命令,例如 cargo publish

可以使用 --token 命令行选项覆盖此设置。

registry.global-credential-providers

  • 类型:数组
  • 默认值:["cargo:token"]
  • 环境变量:CARGO_REGISTRY_GLOBAL_CREDENTIAL_PROVIDERS

指定全局凭据提供程序的列表。如果未使用 registries.<name>.credential-provider 为特定注册表设置凭据提供程序,Cargo 将使用此列表中的凭据提供程序。列表末尾的提供程序具有优先权。

路径和参数以空格分隔。如果路径或参数包含空格,则应在 [credential-alias] 表中定义凭据提供程序,并在此处通过其别名引用。

有关更多信息,请参阅注册表身份验证

[source]

[source] 表定义可用的注册表源。有关更多信息,请参阅源替换。它由每个命名源的子表组成。一个源应仅定义一种类型(目录、注册表、本地注册表或 git)。

source.<name>.replace-with

  • 类型:字符串
  • 默认:无
  • 环境变量:不支持

如果设置,则将此源替换为给定的命名源或命名注册表。

source.<name>.directory

  • 类型:字符串(路径)
  • 默认:无
  • 环境变量:不支持

设置用作目录源的目录路径。

source.<name>.registry

  • 类型:字符串(url)
  • 默认:无
  • 环境变量:不支持

设置用于注册表源的 URL。

source.<name>.local-registry

  • 类型:字符串(路径)
  • 默认:无
  • 环境变量:不支持

设置用作本地注册表源的目录路径。

source.<name>.git

  • 类型:字符串(url)
  • 默认:无
  • 环境变量:不支持

设置用于 git 仓库源的 URL。

source.<name>.branch

  • 类型:字符串
  • 默认:无
  • 环境变量:不支持

设置用于 git 仓库的分支名称。

如果未设置 branchtagrev,则默认为 master 分支。

source.<name>.tag

  • 类型:字符串
  • 默认:无
  • 环境变量:不支持

设置用于 git 仓库的标签名称。

如果未设置 branchtagrev,则默认为 master 分支。

source.<name>.rev

  • 类型:字符串
  • 默认:无
  • 环境变量:不支持

设置用于 git 仓库的修订版本

如果未设置 branchtagrev,则默认为 master 分支。

[target]

[target] 表用于指定特定平台目标的设置。它由一个子表组成,该子表可以是平台三元组cfg() 表达式。如果目标平台与 <triple> 值或 <cfg> 表达式匹配,则将使用给定值。

[target.thumbv7m-none-eabi]
linker = "arm-none-eabi-gcc"
runner = "my-emulator"
rustflags = ["…", "…"]

[target.'cfg(all(target_arch = "arm", target_os = "none"))']
runner = "my-arm-wrapper"
rustflags = ["…", "…"]

cfg 值来自编译器内置的值(运行 rustc --print=cfg 查看)和传递给 rustc 的额外 --cfg 标志(例如在 RUSTFLAGS 中定义的那些)。不要尝试匹配 debug_assertionstest、Cargo 功能(如 feature="foo")或构建脚本设置的值。

如果使用目标规范 JSON 文件,则<triple> 值是文件名词干。例如,--target foo/bar.json 将匹配 [target.bar]

target.<triple>.ar

此选项已弃用且未使用。

target.<triple>.linker

  • 类型:字符串(程序路径)
  • 默认:无
  • 环境变量:CARGO_TARGET_<triple>_LINKER

指定当为<triple> 编译时,传递给 rustc 的链接器(通过 -C linker)。默认情况下,不会覆盖链接器。

target.<cfg>.linker

这类似于目标链接器,但使用cfg() 表达式。如果<triple><cfg> 运行器都匹配,则 <triple> 将优先。如果多个 <cfg> 运行器匹配当前目标,则会出错。

target.<triple>.runner

如果提供了运行器,则目标<triple> 的可执行文件将通过调用指定的运行器并以实际的可执行文件作为参数来执行。这适用于 cargo runcargo testcargo bench 命令。默认情况下,编译的可执行文件会直接执行。

target.<cfg>.runner

这类似于目标运行器,但使用cfg() 表达式。如果<triple><cfg> 运行器都匹配,则 <triple> 将优先。如果多个 <cfg> 运行器匹配当前目标,则会出错。

target.<triple>.rustflags

  • 类型:字符串或字符串数组
  • 默认:无
  • 环境变量:CARGO_TARGET_<triple>_RUSTFLAGS

为此<triple> 向编译器传递一组自定义标志。该值可以是字符串数组或空格分隔的字符串。

有关指定额外标志的不同方式的更多详细信息,请参阅build.rustflags

target.<cfg>.rustflags

这类似于目标 rustflags,但使用cfg() 表达式。如果多个 <cfg><triple> 条目匹配当前目标,则这些标志将合并在一起。

target.<triple>.rustdocflags

  • 类型:字符串或字符串数组
  • 默认:无
  • 环境变量:CARGO_TARGET_<triple>_RUSTDOCFLAGS

为此<triple> 向编译器传递一组自定义标志。该值可以是字符串数组或空格分隔的字符串。

有关指定额外标志的不同方式的更多详细信息,请参阅build.rustdocflags

链接子表提供了一种覆盖构建脚本的方式。指定后,将不会运行给定 links 库的构建脚本,而是使用给定的值。

[target.x86_64-unknown-linux-gnu.foo]
rustc-link-lib = ["foo"]
rustc-link-search = ["/path/to/foo"]
rustc-flags = "-L /some/path"
rustc-cfg = ['key="value"']
rustc-env = {key = "value"}
rustc-cdylib-link-arg = ["…"]
metadata_key1 = "value"
metadata_key2 = "value"

[term]

[term] 表控制终端输出和交互。

term.quiet

  • 类型:布尔值
  • 默认值:false
  • 环境变量:CARGO_TERM_QUIET

控制是否显示 Cargo 的日志消息。

指定 --quiet 标志将覆盖并强制静默输出。指定 --verbose 标志将覆盖并禁用静默输出。

term.verbose

  • 类型:布尔值
  • 默认值:false
  • 环境变量:CARGO_TERM_VERBOSE

控制是否显示 Cargo 的额外详细消息。

指定 --quiet 标志将覆盖并禁用详细输出。指定 --verbose 标志将覆盖并强制详细输出。

term.color

  • 类型:字符串
  • 默认值:"auto"
  • 环境变量:CARGO_TERM_COLOR

控制是否在终端中使用彩色输出。可能的值:

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

可以使用 --color 命令行选项覆盖。

  • 类型:bool
  • 默认值:自动检测
  • 环境变量:CARGO_TERM_HYPERLINKS

控制是否在终端中使用超链接。

term.unicode

  • 类型:bool
  • 默认值:自动检测
  • 环境变量:CARGO_TERM_UNICODE

控制输出是否可以使用非 ASCII unicode 字符呈现。

term.progress.when

  • 类型:字符串
  • 默认值:"auto"
  • 环境变量:CARGO_TERM_PROGRESS_WHEN

控制是否在终端中显示进度条。可能的值:

  • auto(默认值):智能地猜测是否显示进度条。
  • always:始终显示进度条。
  • never:从不显示进度条。

term.progress.width

  • 类型:整数
  • 默认:无
  • 环境变量:CARGO_TERM_PROGRESS_WIDTH

设置进度条的宽度。