【Rust】——Cargo工作空间
Y小夜 2024-08-20 12:05:02 阅读 99
💻博主现有专栏:
C51单片机(STC89C516),c语言,c++,离散数学,算法设计与分析,数据结构,Python,Java基础,MySQL,linux,基于HTML5的网页设计及应用,Rust(官方文档重点总结),jQuery,前端vue.js,Javaweb开发,Python机器学习等
🥏主页链接:
Y小夜-CSDN博客
目录
🎯创建工作空间
🎯在工作空间中创建第二个包
🎃在工作空间中依赖外部包
🎃为工作空间增加测试
🎯使用cargo install安装二进制文件
🎯Cargo自定义扩展命令
🎯创建工作空间
工作空间 是一系列共享同样的 Cargo.lock 和输出目录的包。让我们使用工作空间创建一个项目 —— 这里采用常见的代码以便可以关注工作空间的结构。有多种组织工作空间的方式,所以我们只展示一个常用方法。我们的工作空间有一个二进制项目和两个库。二进制项目会提供主要功能,并会依赖另两个库。一个库会提供 <code>add_one 方法而第二个会提供
add_two
方法。这三个 crate 将会是相同工作空间的一部分。让我们以新建工作空间目录开始:
$ mkdir add
$ cd add
接着在 add 目录中,创建 Cargo.toml 文件。这个 Cargo.toml 文件配置了整个工作空间。它不会包含
[package]
部分。相反,它以[workspace]
部分作为开始,并通过指定 adder 的路径来为工作空间增加成员,如下会加入二进制 crate:
[workspace]
members = [
"adder",
]
接下来,在 add 目录运行
cargo new
新建adder
二进制 crate:
$ cargo new adder
Created binary (application) `adder` package
到此为止,可以运行
cargo build
来构建工作空间。add 目录中的文件应该看起来像这样:
├── Cargo.lock
├── Cargo.toml
├── adder
│ ├── Cargo.toml
│ └── src
│ └── main.rs
└── target
工作空间在顶级目录有一个 target 目录;
adder
并没有自己的 target 目录。即使进入 adder 目录运行cargo build
,构建结果也位于 add/target 而不是 add/adder/target。工作空间中的 crate 之间相互依赖。如果每个 crate 有其自己的 target 目录,为了在自己的 target 目录中生成构建结果,工作空间中的每一个 crate 都不得不相互重新编译其他 crate。通过共享一个 target 目录,工作空间可以避免其他 crate 重复构建。
🎯在工作空间中创建第二个包
接下来,让我们在工作空间中指定另一个成员 crate。这个 crate 位于 add_one 目录中,所以修改顶级 Cargo.toml 为也包含 add_one 路径:
[workspace]
members = [
"adder",
"add_one",
]
接着新生成一个叫做
add_one
的库:
$ cargo new add_one --lib
Created library `add_one` package
├── Cargo.lock
├── Cargo.toml
├── add_one
│ ├── Cargo.toml
│ └── src
│ └── lib.rs
├── adder
│ ├── Cargo.toml
│ └── src
│ └── main.rs
└── target
在 add_one/src/lib.rs 文件中,增加一个
add_one
函数:
pub fn add_one(x: i32) -> i32 {
x + 1
}
现在我们有了二进制
adder
依赖库 crateadd_one
。首先需要在 adder/Cargo.toml 文件中增加add_one
作为路径依赖:
[dependencies]
add_one = { path = "../add_one" }
cargo 并不假定工作空间中的 Crates 会相互依赖,所以需要明确表明工作空间中 crate 的依赖关系。
接下来,在
adder
crate 中使用(add_one
crate 中的)函数add_one
。打开 adder/src/main.rs 在顶部增加一行use
将新add_one
库 crate 引入作用域。接着修改main
函数来调用add_one
函数
use add_one;
fn main() {
let num = 10;
println!("Hello, world! {num} plus one is {}!", add_one::add_one(num));
}
在 add 目录中运行
cargo build
来构建工作空间!
$ cargo build
Compiling add_one v0.1.0 (file:///projects/add/add_one)
Compiling adder v0.1.0 (file:///projects/add/adder)
Finished dev [unoptimized + debuginfo] target(s) in 0.68s
为了在顶层 add 目录运行二进制 crate,可以通过
-p
参数和包名称来运行cargo run
指定工作空间中我们希望使用的包:
$ cargo run -p adder
Finished dev [unoptimized + debuginfo] target(s) in 0.0s
Running `target/debug/adder`
Hello, world! 10 plus one is 11!
🎃在工作空间中依赖外部包
需注意的是工作空间只在根目录有一个 Cargo.lock,而不是在每一个 crate 目录都有 Cargo.lock。这确保了所有的 crate 都使用完全相同版本的依赖。如果在 Cargo.toml 和 add_one/Cargo.toml 中都增加
rand
crate,则 Cargo 会将其都解析为同一版本并记录到唯一的 Cargo.lock 中。使得工作空间中的所有 crate 都使用相同的依赖意味着其中的 crate 都是相互兼容的。让我们在 add_one/Cargo.toml 中的[dependencies]
部分增加rand
crate 以便能够在add_one
crate 中使用rand
crate:
[dependencies]
rand = "0.8.5"
现在就可以在 add_one/src/lib.rs 中增加
use rand;
了,接着在 add 目录运行cargo build
构建整个工作空间就会引入并编译rand
crate:
$ cargo build
Updating crates.io index
Downloaded rand v0.8.5
--snip--
Compiling rand v0.8.5
Compiling add_one v0.1.0 (file:///projects/add/add_one)
warning: unused import: `rand`
--> add_one/src/lib.rs:1:5
|
1 | use rand;
| ^^^^
|
= note: `#[warn(unused_imports)]` on by default
warning: `add_one` (lib) generated 1 warning
Compiling adder v0.1.0 (file:///projects/add/adder)
Finished dev [unoptimized + debuginfo] target(s) in 10.18s
🎃为工作空间增加测试
作为另一个提升,让我们为
add_one
crate 中的add_one::add_one
函数增加一个测试:
pub fn add_one(x: i32) -> i32 {
x + 1
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_works() {
assert_eq!(3, add_one(2));
}
}
在顶级 add 目录运行
cargo test
。在像这样的工作空间结构中运行cargo test
会运行工作空间中所有 crate 的测试。:
$ cargo test
Compiling add_one v0.1.0 (file:///projects/add/add_one)
Compiling adder v0.1.0 (file:///projects/add/adder)
Finished test [unoptimized + debuginfo] target(s) in 0.27s
Running unittests src/lib.rs (target/debug/deps/add_one-f0253159197f7841)
running 1 test
test tests::it_works ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Running unittests src/main.rs (target/debug/deps/adder-49979ff40686fa8e)
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Doc-tests add_one
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
输出的第一部分显示
add_one
crate 的it_works
测试通过了。下一个部分显示adder
crate 中找到了 0 个测试,最后一部分显示add_one
crate 中有 0 个文档测试。
🎯使用cargo install安装二进制文件
cargo install
命令用于在本地安装和使用二进制 crate。它并不打算替换系统中的包;它意在作为一个方便 Rust 开发者们安装其他人已经在 crates.io 上共享的工具的手段。只有拥有二进制目标文件的包能够被安装。二进制目标 文件是在 crate 有 src/main.rs 或者其他指定为二进制文件时所创建的可执行程序,这不同于自身不能执行但适合包含在其他程序中的库目标文件。通常 crate 的 README 文件中有该 crate 是库、二进制目标还是两者兼有的信息。
所有来自
cargo install
的二进制文件都安装到 Rust 安装根目录的 bin 文件夹中。如果你是使用 rustup.rs 来安装 Rust 且没有自定义任何配置,这个目录将是$HOME/.cargo/bin
。确保将这个目录添加到$PATH
环境变量中就能够运行通过cargo install
安装的程序了。
$ cargo install ripgrep
Updating crates.io index
Downloaded ripgrep v13.0.0
Downloaded 1 crate (243.3 KB) in 0.88s
Installing ripgrep v13.0.0
--snip--
Compiling ripgrep v13.0.0
Finished release [optimized + debuginfo] target(s) in 3m 10s
Installing ~/.cargo/bin/rg
Installed package `ripgrep v13.0.0` (executable `rg`)
🎯Cargo自定义扩展命令
Cargo 的设计使得开发者可以通过新的子命令来对 Cargo 进行扩展,而无需修改 Cargo 本身。如果
$PATH
中有类似cargo-something
的二进制文件,就可以通过cargo something
来像 Cargo 子命令一样运行它。像这样的自定义命令也可以运行cargo --list
来展示出来。能够通过cargo install
向 Cargo 安装扩展并可以如内建 Cargo 工具那样运行它们是 Cargo 设计上的一个非常方便的优点
声明
本文内容仅代表作者观点,或转载于其他网站,本站不以此文作为商业用途
如有涉及侵权,请联系本站进行删除
转载本站原创文章,请注明来源及作者。