包 ID 规范

包 ID 规范

Cargo 的子命令经常需要引用依赖图中的特定包,以便执行各种操作,例如更新、清理、构建等。为了解决这个问题,Cargo 支持 包 ID 规范。规范是一个字符串,用于在包图中唯一地引用一个包。

规范可以是完全限定的,例如 https://github.com/rust-lang/crates.io-index#regex@1.4.3,也可以是缩写的,例如 regex。只要缩写形式能够唯一地标识依赖图中的一个包,就可以使用。如果存在歧义,可以添加额外的限定符使其唯一。例如,如果依赖图中有两个版本的 regex 包,则可以通过版本对其进行限定使其唯一,例如 regex@1.4.3

规范语法

包 ID 规范的正式语法是

spec := pkgname |
        [ kind "+" ] proto "://" hostname-and-path [ "?" query] [ "#" ( pkgname | semver ) ]
query = ( "branch" | "tag" | "rev" ) "=" ref
pkgname := name [ ("@" | ":" ) semver ]
semver := digits [ "." digits [ "." digits [ "-" prerelease ] [ "+" build ]]]

kind = "registry" | "git" | "path"
proto := "http" | "git" | "file" | ...

在此,方括号表示内容是可选的。

URL 形式可用于 git 依赖项,或用于区分来自不同来源(例如不同注册表)的包。

规范示例

以下是 crates.io 上的 regex 包的引用示例

规范名称版本
regexregex*
regex@1.4regex1.4.*
regex@1.4.3regex1.4.3
https://github.com/rust-lang/crates.io-index#regexregex*
https://github.com/rust-lang/crates.io-index#regex@1.4.3regex1.4.3
registry+https://github.com/rust-lang/crates.io-index#regex@1.4.3regex1.4.3

以下是几种不同 git 依赖项的规范示例

规范名称版本
https://github.com/rust-lang/cargo#0.52.0cargo0.52.0
https://github.com/rust-lang/cargo#cargo-platform@0.1.2cargo-platform0.1.2
ssh://git@github.com/rust-lang/regex.git#regex@1.4.3regex1.4.3
git+ssh://git@github.com/rust-lang/regex.git#regex@1.4.3regex1.4.3
git+ssh://git@github.com/rust-lang/regex.git?branch=dev#regex@1.4.3regex1.4.3

文件系统上的本地包可以使用 file:// URL 来引用它们

规范名称版本
file:///path/to/my/project/foofoo*
file:///path/to/my/project/foo#1.1.8foo1.1.8
path+file:///path/to/my/project/foo#1.1.8foo1.1.8

规范的简洁性

其目标是为引用依赖图中的包提供简洁和详尽两种语法。模糊的引用可能指向一个或多个包。如果同一规范可以指向多个包,大多数命令会生成错误。