Gulag Cleaner Rust 分发版

设置 Rust

要将 Rust 组件集成到 Gulag Cleaner 中，请确保您的系统已正确安装 Rust。有关详细信息，请遵循官方 Rust 网站上的安装指南。这包括安装 Rust 工具链管理器 rustup 和 Rust 编译器 (rustc)。

运行 Rust 测试

Gulag Cleaner 利用 Rust 执行某些操作，提供性能和安全性优势。为确保这些组件按预期工作，已包含全面的测试。

要运行测试

1. 打开终端。

2. 导航到 Gulag Cleaner 的根目录。

3. 执行以下命令以运行所有测试

   cargo test
   

   要获取更详细的测试输出，包括测试中的打印语句，请使用

   cargo test --package gulagcleaner_rs --lib -- tests --nocapture
   

   此命令针对特定的 Rust 包 (gulagcleaner_rs)，并通过 --nocapture 启用详细输出。

   注意：目前此测试仅包括对 Wuolah 和 Studocs 的 2 个示例 PDF 的读取、清理和写入。

Rust 开发指南

要为 Gulag Cleaner 的 Rust 部分做出贡献，请遵守以下指南

• 代码清晰度：编写清晰、易读的代码，使用有意义的变量名和简洁的函数。
• 注释和文档：添加注释解释复杂逻辑或重要决策。在添加新功能或进行重大更改时，请更新 README.md，包括相关的示例和说明。
• 性能：优化效率。Rust 以其性能而闻名，因此确保您的贡献提高或保持当前的速度和内存使用。
• 测试：如果可能，为新功能或错误修复编写测试。确保现有测试在修改的情况下通过，除非更改有意更新测试行为。

Rust TODO

如果您想做出贡献，以下是需要关注的领域

• 编写测试：我们可以改进测试覆盖率。为 Rust 代码编写额外的单元和集成测试是优先事项。
• 文档：需要添加详细的 README.md，包括设置说明、使用示例和可用功能的描述。
• 代码优化：总是有提高性能的空间。对现有Rust代码进行分析和优化可以显著影响整体工具的性能。

贡献

非常鼓励对Gulag Cleaner的Rust代码库做出贡献。无论您是修复错误、优化性能还是添加新功能，您的意见都是宝贵的。遵循项目的贡献指南，并提交包含您更改的pull请求。

许可证

Gulag Cleaner遵循GPL-3许可证分发，这意味着它是开源的且免费使用的。