» Rust创建命令行程序grep » 2. 开发 » 2.1 目录结构

目录结构

lr_grustep/
|-- src/
|   |-- main.rs       # CLI 应用程序的主入口点
|   |-- lib.rs        # 库代码,代码可多处复用
|   |-- utils.rs      # 辅助用的函数或模块
|-- tests/
|   |-- unit.rs       # 单元测试
|-- Cargo.toml        # Rust 包清单
|-- README.md         # 项目文档
|-- License           # 许可信息
|-- .gitignore        # Git 忽略文件

对每个文件夹/文件的解释:

  • src/: 源代码所在目录。

  • src/main.rs: 该文件包含你的 CLI 应用程序的主入口点。这是程序执行的起点,在这里定义 main 函数。

  • src/lib.rs: 该文件用于定义一个 Rust 库,放入主业务逻辑代码。如果你的项目涉及可由其他程序使用的可重用代码,可以将其组织成一个库。

  • src/utils.rs: 在其中放置通用的业务无关的实用函数或模块代码。

  • tests/: 此目录用于组织你的测试。

  • Cargo.toml: 这是 Rust 包清单。它包含项目、依赖项和其他配置的元数据。 Cargo1 包管理器使用它来构建、测试和打包项目。

  • README.md: 项目文档。包括如何安装、配置和使用 CLI 应用程序的信息。

  • LICENSE:2 开源许可文件,其指定了软件分发的条款。

  • .gitignore: 该文件指定 Git 应该忽略的项目相关文件,防止被意外提交到版本控制系统中。

这个结构很好地分离了关注点,使得将来扩展维护项目更容易。

Footnotes

  1. Rust中的Cargo和Cargo.toml是什么?

  2. 开源许可