Lust

一个旨在为给定文件路径提供简单数据的 Rust 库！

入门指南

以下说明将帮助您在本地机器上获取项目副本并运行，用于开发和测试。

用法

1. get_file_name(file_path: &str) - 给定一个绝对或相对路径，返回文件名（作为 OsString）

let file_name = get_file_name("C:/Users/JohnDoe/Desktop/repos/Lust/README.md");
println!("{:?}", file_name);  //prints "README.md"

2. get_file_size(file_path: &str) - 给定一个绝对或相对路径，返回文件大小（作为 u64）

let file_size = get_file_size("C:/Users/JohnDoe/Desktop/repos/Lust/README.md");
println!("{:?}", file_size);  //prints "82"

3. generate_sha1(file_path: &str) - 给定一个绝对或相对路径，返回 sha1 哈希（作为 String）

let sha1_hash = generate_sha1("C:/Users/JohnDoe/Desktop/repos/Lust/README.md");
println!("{:?}", sha1_hash);  //prints "e2ae20d9ae7fcacb605c03c198e0a1c51d446f50"

4. generate_md5(file_path: &str) - 给定一个绝对或相对路径，返回 md5 哈希（作为 String）

let md5_hash = generate_md5("C:/Users/JohnDoe/Desktop/repos/Lust/README.md");
println!("{:?}", md5_hash);  //prints "b958ee170050ed7a2f93509f13bf16c3"

安装先决条件

以下列出了构建和编译 Lust 所需的内容

Rust 和 Cargo

OSX/Unix 安装（通过 终端）

curl -sSf https://static.rust-lang.org/rustup.sh | sh

Microsoft Windows 的说明可能在此处找到 这里。

更详细的安装说明可在此处找到 这里。

构建 Lust

安装上述先决条件后，您就可以开始构建了！

1. 首先，通过 git 将仓库克隆到您的本地机器

git clone https://github.com/SeanPrashad/Lust.git

或者下载 .zip 相当版本，可在 此处 找到。

注意：请记住将 .zip 文件提取到您进行工作的位置！

2. 接下来，使用您的终端（或在Windows上使用Git Bash）进入下载的仓库中的 cd

cd whereMyReposAreStored/Lust/

3. 要构建源代码，请使用

cargo build

注意：提供 --verbose 参数以获得更详细的输出（例如：cargo build --verbose）

运行测试套件

测试套件位于 src/lib.rs 中的模块 tests。要构建和运行所有测试套件，请简单地使用

cargo test

注意：提供 --verbose 参数以获得更详细的输出（例如：cargo test --verbose）

代码风格检查

Rust自带了一个内置的代码风格检查器Clippy，它会在构建Lust时自动配置。

要按需调用Clippy，请运行

cargo clippy

注意：提供 --verbose 参数以获得更详细的输出（例如：cargo clippy --verbose）。更多信息请参阅 此处。

技术 & 工具

• Rust - 系统编程语言
• Crates.io - Rust的包管理器
• Clippy - Rust的代码风格检查
• Rust-Crypto - 常见加密算法库

贡献

欢迎任何形式的贡献，无论您的编程经验如何。请参阅 CONTRIBUTING.md 了解如何开始。

作者

• Sean Prashad - 初始和持续维护 - @SeanPrashad
• David Humphrey - 文档改进/开发建议 - @humphd
• Marco Beltempo - 源代码优化 - @marcobeltempo

还可以查看参与此项目的贡献者列表。

许可证

此项目受MIT许可证的许可 - 有关详细信息，请参阅LICENSE.md 文件。

致谢

• 在Mozilla的IRC服务器上为所有帮助提供#rust-beginners
• David Humphrey教授，在指导、挑战并奖励我们开源世界方面