Rust程序如何从它的Cargo包中访问元数据?

如何从包中的Rust代码中访问Cargo包的元数据(例如版本)?在我的例子中,我正在构建一个命令行工具,我希望它有一个标准的--version标志,并且我希望实现从Cargo.toml读取包的版本,这样我就不必在两个地方维护它。我可以想象,还有其他原因可能会有人想要从程序中访问Cargo元数据。

35789 次浏览

Cargo通过环境变量将一些元数据传递给编译器,这些环境变量的列表可以在货物文件页. conf中找到。

编译器环境由Cargo代码中的fill_env填充。与早期版本相比,这段代码变得更加复杂,整个变量列表不再明显,因为它可以是动态的。然而,至少在那里设置了以下变量(来自文档里的列表):

CARGO_MANIFEST_DIR
CARGO_PKG_AUTHORS
CARGO_PKG_DESCRIPTION
CARGO_PKG_HOMEPAGE
CARGO_PKG_NAME
CARGO_PKG_REPOSITORY
CARGO_PKG_VERSION
CARGO_PKG_VERSION_MAJOR
CARGO_PKG_VERSION_MINOR
CARGO_PKG_VERSION_PATCH
CARGO_PKG_VERSION_PRE

可以使用env!()宏访问环境变量。要插入程序的版本号,您可以这样做:

const VERSION: &str = env!("CARGO_PKG_VERSION");


// ...


println!("MyProgram v{}", VERSION);

如果你想让你的程序即使没有Cargo也能编译,你可以使用option_env!():

const VERSION: Option<&str> = option_env!("CARGO_PKG_VERSION");


// ...


println!("MyProgram v{}", VERSION.unwrap_or("unknown"));

-crate有助于序列化大量Cargo的环境,而不需要所有的样板文件。

在构建时(如build.rs), cargo_metadata可能有用。例如:

let path = std::env::var("CARGO_MANIFEST_DIR").unwrap();
let meta = MetadataCommand::new()
.manifest_path("./Cargo.toml")
.current_dir(&path)
.exec()
.unwrap();


let root = meta.root_package().unwrap();
let option = root.metadata["my"]["option"].as_str().unwrap();
let version = &root.version;
...