要在 Rust 项目中使用 build.rs
,请按照以下步骤操作:
-
在项目的根目录下创建一个名为
build.rs
的文件。这个文件将被用作构建脚本。 -
打开
build.rs
文件并编写 Rust 代码。例如,你可以编写一个简单的脚本来检查系统是否支持某个特定的功能:
fn main() { if cfg!(feature = "some_feature") { println!("Feature 'some_feature' is enabled."); } else { println!("Feature 'some_feature' is disabled."); } }
在这个例子中,我们使用了 cfg!
宏来检查是否定义了名为 some_feature
的特性。
- 在项目的
Cargo.toml
文件中,将build.rs
文件添加到build-dependencies
部分。这将确保在构建项目时运行build.rs
脚本:
[package] name = "your_project_name" version = "0.1.0" edition = "2018" [dependencies] # 添加你的依赖项 [build-dependencies] # 如果你需要使用外部库,请在这里添加它们
- 在
Cargo.toml
文件中的[features]
部分定义你将在build.rs
脚本中使用的特性。例如:
[features] some_feature = []
在这个例子中,我们定义了一个名为 some_feature
的特性,但没有为其指定任何依赖项。
- 现在,当你运行
cargo build
或cargo build --features some_feature
时,build.rs
脚本将被执行。你可以根据需要修改build.rs
脚本以执行其他任务,例如编译外部库、运行测试等。
注意:build.rs
脚本的主要目的是在构建过程中执行自定义逻辑,而不是直接与 Rust 代码交互。如果你需要在 Rust 代码中使用某些功能,请考虑将这些功能作为依赖项添加到 Cargo.toml
文件中。