binny

一个通用的库，用于解析常见的二进制文件格式，如mp3、wav、jpeg等。

关于

binny 用于从提供的 Read trait 解析和验证常见的二进制文件格式。该文件被解析到表示文件物理结构的结构体中，例如文件头、元数据或用于编码信息的文件内容，假设正在解析的文件是有效的。如果正在解析的文件无效，将返回一个枚举错误，详细说明该文件格式的任何违规。

binny 不是一个解码器，而是处理解码文件步骤的前置条件。解码文件的任务留给其他库或方法。

用法

要在项目中使用 binny，只需将 binny 添加到项目的 Cargo.toml 文件中，如下所示

[dependencies]
binny = "0.1.0" 

路线图

以下是为 binny 的开发计划的功能和功能列表

• mp3 解析和验证支持
• 项目文档中的教程部分
• wav 解析和验证支持
• flac 解析和验证支持
• jpeg 解析和验证支持
• png 解析和验证支持
• gif 解析和验证支持
• tiff 解析和验证支持
• bmp 解析和验证

许可证

binny 是免费的、开源的软件，许可协议为 GNU Lesser General Public License 版本 3.0。有关更多信息，请参阅 COPYING 文件或 此处。

如何贡献

兼容性

binny 重视语义版本，因此许多关于贡献的指南和政策都集中在避免破坏性更改。

binny 将将 Rust 的最低要求版本锁定在 CI 构建。这意味着提高 Rust 的最低要求版本将导致 次要 版本提高，因为对新版本 Rust 的要求是一个破坏性更改。

binny 将正式支持当前稳定版本的 Rust 和前两个版本，但与更早版本兼容性不能保证。

文档

贡献应当充分文档化。这是一个对所有可调用项、模块和特质的文档字符串。所有

测试

贡献应附带针对各个组件的单元测试和针对任何通过公开成员形成的 API 的集成测试。

Git 分支

本项目遵循 GitFlow 分支策略。简而言之，master 分支应始终匹配项目的标记版本。development 分支应仅包含为下一个版本准备的开发成果。直接提交到 master 和 development 分支是不允许的，而应通过拉取请求进行合并。更改应仅通过 feature 分支进行新功能的直接提交，通过 enhancement 分支进行现有功能的改进，或通过 bugfix 分支进行错误修复。有关 GitFlow 的更详细说明，请参阅这篇 博客文章。