【跟小嘉学 Rust 编程】二、Rust 包管理工具使用

系列文章目录

【跟小嘉学 Rust 编程】一、Rust 编程基础
【跟小嘉学 Rust 编程】二、Rust 包管理工具使用

---

前言

本章节讲解 Cargo 如何使用，以及 cargo 配置文件内容

主要教材参考 《The Rust Programming Language》

---

一、Cargo 是什么

Cargo 是 rust 的构建系统和包管理工具，大多数的 rust 开发者都会使用这个工具来管理 Rust 项目，因为 Cargo 会为我们处理很多任务，比如说构建代码、下载代码所依赖的库，以及构建这些库(依赖库)

二、Cargo的简单使用

2.1、查看 cargo 的版本

cargo --version
cargo -V

2.2、使用 cargo 创建项目

cargo new projectName

该命令会为我们创建一个以 projectName 为名的目录，目录下面有一个src目录,src目录有一个main.rs 文件，以及一个 Cargo.toml 文件 和一个 git的忽略文件(.gitignore)

默认使用git进行，如果你的 vcs 不是使用git 可以使用 --vcs 命令来指定

cargo new --vcs=git projectName

2.3、Cargo 项目配置文件(Cargo.toml)

该配置文件采用的 TOML(Tom’s Obvious, Minimal Language) 格式。

2.3.1、Cargo.toml 默认内容

[package]
name = "hello"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]

2.3.2、 Cargo 的配置文件清单内容

配置文件的清单 内容可以参看如下地址：https://doc.rust-lang.org/cargo/reference/manifest.html

2.3.2.1、[package] 部分

该部分主要定义包的内容，主要包含如下属性

• name： 包的名字
• version：包的版本
• authors: 包的作者
• edition：包的发行版本
• rust-version: 最小的 rust 支持版本
• description： 包的描述信息
• documentation ：包的文档的URL地址
• readme： 包的 README 文件路径
• homepage：包的主页 URL 地址
• repository ：包的源代码仓库 URL 地址
• license：包的开源协议
• license-file：宝的开源协议路径
• keywords：包的关键字
• categories：包的分类字段
• autobins:
• autoexamples：
• autotests
• autobenches

auto 开头为对象自动发现的配置。

2.3.2.2、cargo-features 部分

该部分是不稳定

cargo-features = ["test-dummy-unstable"]

2.3.2.3、对象介绍

2.3.2.3.1、库对象(Library)

库对象用于定义一个库，该库可以被其他的库或可执行文件所链接，该对象包含的默认文件名是 src/lib.rs，且默认情况下，库对象的名称和项目名是一致的。

一个工程只能有一个库对象，因此也只能有一个 src/lib.rs 文件。

[lib]
crate-type = ["cdylib"]
bench = false

2.3.2.3.2、二进制对象(Binaries)

二进制对象在被编译后可以生成可执行的文件，默认的文件名是 src/main.rs，二进制对象的名称跟项目名也是相同的。

大家应该还记得，一个项目拥有多个二进制文件，因此一个项目可以拥有多个二进制对象。当拥有多个对象时，对象的文件默认会被放在 src/bin/ 目录下。

二进制对象可以使用库对象提供的公共 API，也可以通过 [dependencies] 来引入外部的依赖库。

我们可以使用 cargo run --bin <bin-name> 的方式来运行指定的二进制对象，以下是二进制对象的配置示例：

[[bin]]
name = "cool-tool"
test = false
bench = false

[[bin]]
name = "frobnicator"
required-features = ["frobnicate"]

2.3.2.3.3、示例对象(Examples)

示例对象的文件在根目录下的 examples 目录中。既然是示例，自然是使用项目中的库对象的功能进行演示。示例对象编译后的文件会存储在 target/debug/examples 目录下。

如上所示，示例对象可以使用库对象的公共 API，也可以通过 [dependencies] 来引入外部的依赖库。

默认情况下，示例对象都是可执行的二进制文件( 带有 fn main() 函数入口)，毕竟例子是用来测试和演示我们的库对象，是用来运行的。而你完全可以将示例对象改成库的类型:

[[]example]
name = "foo"
crate -type = ["staticlib"]

如果想要指定运行某个示例对象，可以使用 cargo run --example <example-name> 命令。如果是库类型的示例对象，则可以使用 cargo build --example <example-name> 进行构建。

与此类似，还可以使用 cargo install --example <example-name> 来将示例对象编译出的可执行文件安装到默认的目录中，将该目录添加到 $PATH 环境变量中，就可以直接全局运行安装的可执行文件。

最后， cargo test 命令默认会对示例对象进行编译，以防止示例代码因为长久没运行，导致严重过期以至于无法运行。

2.3.2.3.3、测试对象(Tests)

测试对象的文件位于根目录下的 tests 目录中，如果大家还有印象的话，就知道该目录是集成测试所使用的。

当运行 时，里面的 cargo test 每个文件都会被编译成独立的包，然后被执行。

测试对象可以使用库对象提供的公共 API，也可以通过 [dependencies] 来引入外部的依赖库。

2.3.2.3.4、基准性能对象(Benches)

该对象的文件位于 benches 目录下，可以通过 cargo bench 命令来运行。

2.3.2.4、依赖表

2.3.2.4.1、简单依赖 [dependencies]

2.3.2.4.2、开发依赖 [dev-dependencies]

示例对象(Examples)、测试对象(Tests)、基准对象(benchmarks)使用的依赖。

2.3.2.4.3、编译脚本的依赖 [build-dependencies]

2.3.2.4.4、平台特性依赖 [target]

2.3.2.5、Profile 部分

该部分主要是编译设置和优化设置，针对 dev、release 等版本的优化设置。

2.4、代码编译

cargo build

编译完成之后会生成一个 target 目录

2.5、运行代码

cargo run

2.6、代码检测

cargo check

速度会快很多，用于检查代码是否存在编译问题。

总结

以上就是今天要讲的内容

• 1、本文介绍cargo 部分使用；
• 2、介绍 cargo 配置文件的部分内容；