Rustdx 项目使用教程

1. 项目的目录结构及介绍

rustdx/
├── assets/
├── rustdx-cmd/
│   ├── src/
│   └── Cargo.toml
├── src/
│   ├── bytes_helper/
│   ├── file/
│   ├── tcp/
│   └── main.rs
├── tests-integration/
├── tests/
├── .gitignore
├── CHANGELOG.md
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── README.md
└── rustfmt.toml

目录结构介绍

• assets/: 存放项目所需的静态资源文件。
• rustdx-cmd/: 包含命令行工具的源代码和配置文件。
  • src/: 命令行工具的源代码。
  • Cargo.toml: 命令行工具的依赖配置文件。
• src/: 项目的主要源代码目录。
  • bytes_helper/: 字节处理相关的模块。
  • file/: 文件处理相关的模块。
  • tcp/: TCP 网络处理相关的模块。
  • main.rs: 项目的启动文件。
• tests-integration/: 集成测试代码。
• tests/: 单元测试代码。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• Cargo.lock: 依赖锁定文件。
• Cargo.toml: 项目的主要依赖配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• rustfmt.toml: Rust 代码格式化配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/main.rs。该文件是 Rustdx 项目的入口点，负责初始化项目并启动主要功能。

main.rs 文件内容概览

fn main() {
    // 初始化日志
    env_logger::init();

    // 解析命令行参数
    let args = Args::parse();

    // 根据命令行参数执行相应的功能
    match args.command {
        Command::Day => day_command(),
        Command::East => east_command(),
        // 其他命令...
    }
}

主要功能

• 初始化日志: 使用 env_logger::init() 初始化日志系统。
• 解析命令行参数: 使用 Args::parse() 解析命令行参数。
• 执行命令: 根据解析的命令行参数执行相应的功能，如 day_command() 和 east_command()。

3. 项目的配置文件介绍

Cargo.toml

Cargo.toml 是 Rust 项目的依赖配置文件，定义了项目的依赖库、版本信息、构建配置等。

[package]
name = "rustdx"
version = "0.4.1"
authors = ["zjp-CN <[e-mail]>"]
edition = "2018"

[dependencies]
chrono = "0.4"
encoding_rs = "0.8"
lazy_static = "1"
log = "0.4"
miniz_oxide = "0.7"
serde = "1"
thiserror = "1"

[dev-dependencies]
csv = "1"
insta = "1"

[features]
default = []

配置文件内容介绍

• [package]: 定义项目的基本信息，如名称、版本、作者等。
• [dependencies]: 定义项目的主要依赖库及其版本。
• [dev-dependencies]: 定义开发环境下的依赖库。
• [features]: 定义项目的特性（features），用于条件编译。

rustfmt.toml

rustfmt.toml 是 Rust 代码格式化工具 rustfmt 的配置文件，定义了代码格式化的规则。

max_width = 100
use_small_heuristics = "Max"

配置文件内容介绍

• max_width: 设置代码行的最大宽度为 100 个字符。
• use_small_heuristics: 使用小规模的启发式规则进行代码格式化。

通过以上配置文件，可以确保项目的依赖管理和代码格式化符合预期。