Skip to content

Cargo 教程

Cargo 是 Rust 的包管理工具,它负责项目的创建、构建、依赖管理和测试等功能。本章节将详细介绍 Cargo 的使用方法。

Cargo 简介

Cargo 是 Rust 的官方包管理工具,它提供了以下功能:

  • 创建新的 Rust 项目
  • 管理项目依赖
  • 构建项目
  • 运行测试
  • 生成文档
  • 发布 crate 到 crates.io

创建新项目

要创建一个新的 Rust 项目,可以使用 cargo new 命令:

bash
cargo new project_name

这将创建一个名为 project_name 的目录,包含以下文件:

  • Cargo.toml:项目配置文件
  • src/:源代码目录
    • main.rs:主入口文件

项目结构

一个典型的 Rust 项目结构如下:

project_name/
├── Cargo.toml
├── Cargo.lock
└── src/
    ├── main.rs
    └── lib.rs
  • Cargo.toml:项目配置文件,包含项目名称、版本、依赖等信息
  • Cargo.lock:自动生成的依赖版本锁定文件
  • src/main.rs:二进制项目的主入口
  • src/lib.rs:库项目的主入口

Cargo.toml 文件

Cargo.toml 是 Cargo 的配置文件,包含以下内容:

toml
[package]
name = "project_name"
version = "0.1.0"
edition = "2021"

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

[dependencies]
# 依赖项

添加依赖

要添加依赖,可以在 Cargo.toml 文件的 [dependencies] 部分添加:

toml
[dependencies]
serde = "1.0"
rand = "0.8"

也可以使用 cargo add 命令添加依赖:

bash
cargo add serde

构建项目

要构建项目,可以使用 cargo build 命令:

bash
cargo build

这将编译项目并生成可执行文件,位于 target/debug/ 目录。

要构建发布版本,可以使用 cargo build --release 命令:

bash
cargo build --release

这将生成优化后的可执行文件,位于 target/release/ 目录。

运行项目

要运行项目,可以使用 cargo run 命令:

bash
cargo run

这将编译并运行项目。

运行测试

要运行项目的测试,可以使用 cargo test 命令:

bash
cargo test

生成文档

要生成项目的文档,可以使用 cargo doc 命令:

bash
cargo doc

这将生成文档,位于 target/doc/ 目录。

要在浏览器中打开文档,可以使用 cargo doc --open 命令:

bash
cargo doc --open

发布 crate

要发布 crate 到 crates.io,需要先注册一个账号,然后运行:

bash
cargo publish

其他常用命令

  • cargo check:检查代码是否有编译错误,但不生成可执行文件
  • cargo clean:清除构建产物
  • cargo update:更新依赖到最新版本
  • cargo tree:查看依赖树

总结

Cargo 是 Rust 的强大包管理工具,它简化了项目的创建、构建和依赖管理。通过本章节的学习,你应该已经掌握了 Cargo 的基本使用方法,可以开始创建和管理 Rust 项目了。