Rust-Decimal 项目教程

Rust-Decimal 项目教程

rust-decimal Decimal number implementation written in pure Rust suitable for financial and fixed-precision calculations. 项目地址: https://gitcode.com/gh_mirrors/ru/rust-decimal

1. 项目目录结构及介绍

Rust-Decimal 项目的目录结构如下：

rust-decimal/
├── benches/
├── examples/
├── fuzz/
├── macros/
├── make/
├── src/
├── tests/
├── buildnumber
├── editorconfig
├── gitignore
├── BUILD.md
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Cargo.toml
├── LICENSE
├── Makefile.toml
├── README.md
├── build.rs
├── rustfmt.toml

目录介绍：

• benches/：包含性能测试代码。
• examples/：包含示例代码，展示了如何使用 Rust-Decimal。
• fuzz/：包含模糊测试代码，用于发现潜在的 bug。
• macros/：包含用于创建 Decimal 的宏代码。
• make/：包含与构建相关的脚本或配置文件。
• src/：包含项目的核心源代码。
• tests/：包含单元测试代码。
• buildnumber：可能用于生成构建编号。
• editorconfig：编辑器配置文件。
• gitignore：Git 忽略文件配置。
• BUILD.md：构建说明文档。
• CHANGELOG.md：项目变更日志。
• CODE_OF_CONDUCT.md：行为准则。
• CONTRIBUTING.md：贡献指南。
• Cargo.toml：Rust 项目的依赖和元数据配置文件。
• LICENSE：项目许可证。
• Makefile.toml：Makefile 配置文件。
• README.md：项目介绍和使用说明。
• build.rs：构建脚本。
• rustfmt.toml：Rustfmt 配置文件。

2. 项目启动文件介绍

Rust-Decimal 项目的启动文件是 src/lib.rs。这个文件是 Rust 库的入口点，包含了项目的核心逻辑和对外暴露的 API。

src/lib.rs 文件介绍：

• 模块导入：导入了项目中其他模块的代码。
• 公共 API：定义了对外暴露的函数和结构体，供其他项目使用。
• 内部逻辑：包含了 Decimal 类型的实现，包括加减乘除等基本运算。

3. 项目的配置文件介绍

Cargo.toml

Cargo.toml 是 Rust 项目的依赖和元数据配置文件，包含了项目的名称、版本、作者、依赖等信息。

[package]
name = "rust_decimal"
version = "1.36.0"
authors = ["paupino <paupino@example.com>"]
edition = "2018"

[dependencies]
rust_decimal_macros = "1.36"

[features]
borsh = []
c-repr = []
legacy-ops = []
maths = []
ndarray = []
rkyv = []
rocket-traits = []
rust-fuzz = []
serde-float = []
serde-str = []
serde-arbitrary-precision = []

配置项介绍：

• [package]：定义了项目的名称、版本、作者和 Rust 版本。
• [dependencies]：列出了项目依赖的其他库。
• [features]：定义了项目的可选特性，如 borsh、c-repr 等。

rustfmt.toml

rustfmt.toml 是 Rustfmt 的配置文件，用于配置代码格式化的规则。

max_width = 100
use_small_heuristics = "Max"

配置项介绍：

• max_width：设置代码行的最大宽度。
• use_small_heuristics：设置代码格式化的小技巧。

通过以上配置文件，可以定制项目的构建和代码格式化规则，确保项目的一致性和可维护性。

rust-decimal Decimal number implementation written in pure Rust suitable for financial and fixed-precision calculations. 项目地址: https://gitcode.com/gh_mirrors/ru/rust-decimal