From b05c60534cc7589b15510dd0f870a49d0e22bcc8 Mon Sep 17 00:00:00 2001 From: KaiserY Date: Mon, 23 Jan 2023 15:04:06 +0800 Subject: [PATCH] update ch14 --- src/SUMMARY.md | 2 +- src/ch14-03-cargo-workspaces.md | 35 +++++++++++++++--------------- src/ch14-04-installing-binaries.md | 14 ++++++------ 3 files changed, 25 insertions(+), 26 deletions(-) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 018c694..042a544 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -84,7 +84,7 @@ - [采用发布配置自定义构建](ch14-01-release-profiles.md) - [将 crate 发布到 Crates.io](ch14-02-publishing-to-crates-io.md) - [Cargo 工作空间](ch14-03-cargo-workspaces.md) - - [使用 `cargo install` 从 Crates.io 安装二进制文件](ch14-04-installing-binaries.md) + - [使用 `cargo install` 安装二进制文件](ch14-04-installing-binaries.md) - [Cargo 自定义扩展命令](ch14-05-extending-cargo.md) - [智能指针](ch15-00-smart-pointers.md) diff --git a/src/ch14-03-cargo-workspaces.md b/src/ch14-03-cargo-workspaces.md index 84b59a4..82a78c3 100644 --- a/src/ch14-03-cargo-workspaces.md +++ b/src/ch14-03-cargo-workspaces.md @@ -2,20 +2,20 @@ > [ch14-03-cargo-workspaces.md](https://github.com/rust-lang/book/blob/main/src/ch14-03-cargo-workspaces.md) >
-> commit 7ddc28cfe0bfa6c531a6475c7fa41dfa66e8943c +> commit 704c51eec2f26a0133ae17a2c01986590c05a045 -第十二章中,我们构建一个包含二进制 crate 和库 crate 的包。你可能会发现,随着项目开发的深入,库 crate 持续增大,而你希望将其进一步拆分成多个库 crate。对于这种情况,Cargo 提供了一个叫 **工作空间**(*workspaces*)的功能,它可以帮助我们管理多个相关的协同开发的包。 +第十二章中,我们构建一个包含二进制 crate 和库 crate 的包。你可能会发现,随着项目开发的深入,库 crate 持续增大,而你希望将其进一步拆分成多个库 crate。Cargo 提供了一个叫 **工作空间**(*workspaces*)的功能,它可以帮助我们管理多个相关的协同开发的包。 ### 创建工作空间 -**工作空间** 是一系列共享同样的 *Cargo.lock* 和输出目录的包。让我们使用工作空间创建一个项目 —— 这里采用常见的代码以便可以关注工作空间的结构。有多种组织工作空间的方式;我们将展示一个常用方法。我们的工作空间有一个二进制项目和两个库。二进制项目会提供主要功能,并会依赖另两个库。一个库会提供 `add_one` 方法而第二个会提供 `add_two` 方法。这三个 crate 将会是相同工作空间的一部分。让我们以新建工作空间目录开始: +**工作空间** 是一系列共享同样的 *Cargo.lock* 和输出目录的包。让我们使用工作空间创建一个项目 —— 这里采用常见的代码以便可以关注工作空间的结构。有多种组织工作空间的方式,所以我们只展示一个常用方法。我们的工作空间有一个二进制项目和两个库。二进制项目会提供主要功能,并会依赖另两个库。一个库会提供 `add_one` 方法而第二个会提供 `add_two` 方法。这三个 crate 将会是相同工作空间的一部分。让我们以新建工作空间目录开始: ```console $ mkdir add $ cd add ``` -接着在 *add* 目录中,创建 *Cargo.toml* 文件。这个 *Cargo.toml* 文件配置了整个工作空间。它不会包含 `[package]` 或其他我们在 *Cargo.toml* 中见过的元信息。相反,它以 `[workspace]` 部分作为开始,并通过指定 *adder* 的路径来为工作空间增加成员,如下会加入二进制 crate: +接着在 *add* 目录中,创建 *Cargo.toml* 文件。这个 *Cargo.toml* 文件配置了整个工作空间。它不会包含 `[package]` 部分。相反,它以 `[workspace]` 部分作为开始,并通过指定 *adder* 的路径来为工作空间增加成员,如下会加入二进制 crate: 文件名:Cargo.toml @@ -85,7 +85,7 @@ $ cargo new add_one --lib {{#rustdoc_include ../listings/ch14-more-about-cargo/no-listing-02-workspace-with-two-crates/add/add_one/src/lib.rs}} ``` -现在工作空间中有了一个库 crate,让 `adder` 依赖库 crate `add_one`。首先需要在 *adder/Cargo.toml* 文件中增加 `add_one` 作为路径依赖: +现在我们有了二进制 `adder` 依赖库 crate `add_one`。首先需要在 *adder/Cargo.toml* 文件中增加 `add_one` 作为路径依赖: 文件名:adder/Cargo.toml @@ -95,7 +95,7 @@ $ cargo new add_one --lib cargo 并不假定工作空间中的 Crates 会相互依赖,所以需要明确表明工作空间中 crate 的依赖关系。 -接下来,在 `adder` crate 中使用 `add_one` crate 的函数 `add_one`。打开 *adder/src/main.rs* 在顶部增加一行 `use` 将新 `add_one` 库 crate 引入作用域。接着修改 `main` 函数来调用 `add_one` 函数,如示例 14-7 所示。 +接下来,在 `adder` crate 中使用( `add_one` crate 中的)函数 `add_one`。打开 *adder/src/main.rs* 在顶部增加一行 `use` 将新 `add_one` 库 crate 引入作用域。接着修改 `main` 函数来调用 `add_one` 函数,如示例 14-7 所示。 文件名:adder/src/main.rs @@ -141,9 +141,9 @@ Hello, world! 10 plus one is 11! ```console $ cargo build Updating crates.io index - Downloaded rand v0.8.3 + Downloaded rand v0.8.5 --snip-- - Compiling rand v0.8.3 + 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 @@ -153,8 +153,7 @@ warning: unused import: `rand` | = note: `#[warn(unused_imports)]` on by default -warning: 1 warning emitted - +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 ``` @@ -172,7 +171,7 @@ error[E0432]: unresolved import `rand` | ^^^^ no external crate `rand` ``` -为了修复这个错误,修改顶级 `adder` crate 的 *Cargo.toml* 来表明 `rand` 也是这个 crate 的依赖。构建 `adder` crate 会将 `rand` 加入到 *Cargo.lock* 中 `adder` 的依赖列表中,但是这并不会下载 `rand` 的额外拷贝。Cargo 确保了工作空间中任何使用 `rand` 的 crate 都采用相同的版本。在整个工作空间中使用相同版本的 `rand` 节省了空间,因为这样就无需多个拷贝并确保了工作空间中的 crate 将是相互兼容的。 +为了修复这个错误,修改顶级 `adder` crate 的 *Cargo.toml* 来表明 `rand` 也是这个 crate 的依赖。构建 `adder` crate 会将 `rand` 加入到 *Cargo.lock* 中 `adder` 的依赖列表中,但是这并不会下载 `rand` 的额外拷贝。Cargo 确保了工作空间中任何使用 `rand` 的 crate 都采用相同的版本,这节省了空间并确保了工作空间中的 crate 将是相互兼容的。 #### 为工作空间增加测试 @@ -184,21 +183,21 @@ error[E0432]: unresolved import `rand` {{#rustdoc_include ../listings/ch14-more-about-cargo/no-listing-04-workspace-with-tests/add/add_one/src/lib.rs}} ``` -在顶级 *add* 目录运行 `cargo test`: +在顶级 *add* 目录运行 `cargo test`。在像这样的工作空间结构中运行 `cargo test` 会运行工作空间中所有 crate 的测试。: ```console $ 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 target/debug/deps/add_one-f0253159197f7841 + 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 target/debug/deps/adder-49979ff40686fa8e + Running unittests src/main.rs (target/debug/deps/adder-49979ff40686fa8e) running 0 tests @@ -211,14 +210,14 @@ 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_workstests` 测试通过了。下一个部分显示 `adder` crate 中找到了 0 个测试,最后一部分显示 `add_one` crate 中有 0 个文档测试。在像这样的工作空间结构中运行 `cargo test` 会运行工作空间中所有 crate 的测试。 +输出的第一部分显示 `add_one` crate 的 `it_workstests` 测试通过了。下一个部分显示 `adder` crate 中找到了 0 个测试,最后一部分显示 `add_one` crate 中有 0 个文档测试。 也可以选择运行工作空间中特定 crate 的测试,通过在根目录使用 `-p` 参数并指定希望测试的 crate 名称: ```console $ cargo test -p add_one Finished test [unoptimized + debuginfo] target(s) in 0.00s - Running target/debug/deps/add_one-b3235fea9a156f74 + Running unittests src/lib.rs (target/debug/deps/add_one-b3235fea9a156f74) running 1 test test tests::it_works ... ok @@ -234,8 +233,8 @@ test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; fini 输出显示了 `cargo test` 只运行了 `add_one` crate 的测试而没有运行 `adder` crate 的测试。 -如果你选择向 [crates.io](https://crates.io/)发布工作空间中的 crate,每一个工作空间中的 crate 需要单独发布。`cargo publish` 命令并没有 `--all` 或者 `-p` 参数,所以必须进入每一个 crate 的目录并运行 `cargo publish` 来发布工作空间中的每一个 crate。 +如果你选择向 [crates.io](https://crates.io/)发布工作空间中的 crate,每一个工作空间中的 crate 需要单独发布。就像 `cargo test` 一样,可以通过 `-p` 参数并指定期望发布的 crate 名来发布工作空间中的某个特定的 crate。 现在尝试以类似 `add_one` crate 的方式向工作空间增加 `add_two` crate 来作为更多的练习! -随着项目增长,考虑使用工作空间:每一个更小的组件比一大块代码要容易理解。如果它们经常需要同时被修改的话,将 crate 保持在工作空间中更易于协调他们的改变。 +随着项目增长,考虑使用工作空间:每一个更小的组件比一大块代码要容易理解。如果它们经常需要同时被修改的话,将 crate 保持在工作空间中更易于协调 crate 的改变。 diff --git a/src/ch14-04-installing-binaries.md b/src/ch14-04-installing-binaries.md index 7ea3ba4..6ae62b6 100644 --- a/src/ch14-04-installing-binaries.md +++ b/src/ch14-04-installing-binaries.md @@ -1,26 +1,26 @@ -## 使用 `cargo install` 从 Crates.io 安装二进制文件 +## 使用 `cargo install` 安装二进制文件 > [ch14-04-installing-binaries.md](https://github.com/rust-lang/book/blob/main/src/ch14-04-installing-binaries.md) >
-> commit 359895c6b2e440275a663ee1a3c17e6a94fdc62b +> commit 704c51eec2f26a0133ae17a2c01986590c05a045 `cargo install` 命令用于在本地安装和使用二进制 crate。它并不打算替换系统中的包;它意在作为一个方便 Rust 开发者们安装其他人已经在 [crates.io](https://crates.io/) 上共享的工具的手段。只有拥有二进制目标文件的包能够被安装。**二进制目标** 文件是在 crate 有 *src/main.rs* 或者其他指定为二进制文件时所创建的可执行程序,这不同于自身不能执行但适合包含在其他程序中的库目标文件。通常 crate 的 *README* 文件中有该 crate 是库、二进制目标还是两者都是的信息。 所有来自 `cargo install` 的二进制文件都安装到 Rust 安装根目录的 *bin* 文件夹中。如果你使用 *rustup.rs* 安装的 Rust 且没有自定义任何配置,这将是 `$HOME/.cargo/bin`。确保将这个目录添加到 `$PATH` 环境变量中就能够运行通过 `cargo install` 安装的程序了。 -例如,第十二章提到的叫做 `ripgrep` 的用于搜索文件的 `grep` 的 Rust 实现。如果想要安装 `ripgrep`,可以运行如下: +例如,第十二章提到的叫做 `ripgrep` 的用于搜索文件的 `grep` 的 Rust 实现。为了安装 `ripgrep` 运行如下: ```console $ cargo install ripgrep Updating crates.io index - Downloaded ripgrep v11.0.2 + Downloaded ripgrep v13.0.0 Downloaded 1 crate (243.3 KB) in 0.88s - Installing ripgrep v11.0.2 + Installing ripgrep v13.0.0 --snip-- - Compiling ripgrep v11.0.2 + Compiling ripgrep v13.0.0 Finished release [optimized + debuginfo] target(s) in 3m 10s Installing ~/.cargo/bin/rg - Installed package `ripgrep v11.0.2` (executable `rg`) + Installed package `ripgrep v13.0.0` (executable `rg`) ``` 最后一行输出展示了安装的二进制文件的位置和名称,在这里 `ripgrep` 被命名为 `rg`。只要你像上面提到的那样将安装目录加入 `$PATH`,就可以运行 `rg --help` 并开始使用一个更快更 Rust 的工具来搜索文件了!