IronCalc 开源项目使用教程

IronCalc 开源项目使用教程

IronCalc Main engine of the IronCalc ecosystem 项目地址: https://gitcode.com/gh_mirrors/ir/IronCalc

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

IronCalc 是一个用 Rust 编写的现代化电子表格引擎和相关工具集。以下是项目的目录结构及其功能的简要介绍：

• assets/: 存放项目所需的静态资源，如图标和样式文件。
• base/: 包含 IronCalc 的核心代码，定义了电子表格的基本模型和功能。
• bindings/: 包含不同编程语言绑定的代码，例如 Python、JavaScript (WebAssembly) 等。
• docs/: 存放项目文档，包括 API 文档和用户手册。
• generate_locale/: 用于生成本地化文件的工具代码。
• xlsx/: 包含处理 Excel 文件格式（.xlsx）的代码。
• webapp/: 包含用于在网页上运行 IronCalc 的前端代码。
• .github/: 存放 GitHub Actions 工作流和代码审查的配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• Cargo.lock 和 Cargo.toml: Rust 项目的依赖管理和配置文件。
• LICENSE-Apache-2.0 和 LICENSE-MIT: 项目的许可文件。
• Makefile: 用于简化构建和测试过程的 Makefile 文件。
• README.md: 项目的自述文件，介绍了项目的目的和用法。
• codecov.yml: CodeCov 代码覆盖配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是位于项目根目录下的 main.rs 文件。以下是 main.rs 的基本结构：

mod base {
    // ... 基础模块代码 ...
}

mod export {
    // ... 导出模块代码 ...
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 创建新的电子表格模型
    let mut model = Model::new_empty("hello-calc.xlsx", "en", "UTC")?;

    // ... 电子表格操作代码 ...

    // 保存电子表格到磁盘
    save_to_xlsx(&model, "hello-calc.xlsx")?;

    Ok(())
}

main.rs 文件包含了程序的入口点，在这里创建和操作电子表格模型，以及保存模型到文件。

3. 项目的配置文件介绍

项目的配置主要通过 Cargo.toml 文件进行。以下是 Cargo.toml 的基本结构：

[package]
name = "ironcalc"
version = "0.5"
edition = "2021"

[dependencies]
# ... 项目依赖 ...

[build-dependencies]
# ... 构建依赖 ...

在 Cargo.toml 文件中，你可以定义项目的名称、版本和依赖项。此外，还可以指定构建依赖和构建脚本。

确保在使用项目之前，你已经安装了 Rust 编译器和相应的依赖项。然后，你可以使用以下命令构建项目：

cargo build --release

构建完成后，你可以运行 main.rs 文件来启动项目。

IronCalc Main engine of the IronCalc ecosystem 项目地址: https://gitcode.com/gh_mirrors/ir/IronCalc