Rustler 开源项目指南

Rustler 开源项目指南

rustler 项目地址: https://gitcode.com/gh_mirrors/rus/rustler

欢迎来到 Rustler 的详细指南！本指南将带你深入了解这个强大的库，它让你能够用安全的 Rust 代码来创建 Erlang NIF（Native Implemented Functions）。以下是关键内容模块的概览：

1. 项目目录结构及介绍

Rustler 的仓库展示了一套精心组织的结构，旨在简化从 Rust 到 Erlang/Elixir 的桥梁构建过程。以下是核心目录的简要概述：

• root: 项目根目录，包含主要的文件和子目录。
  • LICENSE-APACHE, LICENSE-MIT: 提供了项目的双重许可信息，允许选择性地遵循 Apache 2.0 或 MIT 许可协议。
  • Cargo.toml: Rust 项目的元数据文件，定义依赖、版本和编译配置。
  • src: 存储 Rust 源代码的主要目录。
    • rustler*: 包含多个子模块，如 rustler_codegen、rustler_mix 等，用于处理代码生成和其他逻辑。
  • docs: 文档资料，可能包含额外的说明或 API 文档。
  • examples: 示例代码，展示了如何使用 Rustler 编写和集成 NIF 函数到你的项目中。
  • mix.exs: 对于与 Elixir 项目集成，提供了 Elixir Mix 项目配置。
  • test: 单元测试和集成测试所在的位置。

2. 项目的启动文件介绍

在 Rustler 库自身中，并不存在一个传统的“启动文件”，因为其主要是作为一个库被其他项目引用。然而，在使用 Rustler 创建的 Elixir 项目中，通常会有以下几个关键点：

• Elixir 项目中的 mix.exs：这是 Elixir 项目的主要配置文件，通过这里添加 Rustler 作为依赖项，然后运行 mix rustler.new 来初始化 NIF 支持。
• Rust 的入口点：若直接看 Rust 侧，初始化一个 NIF 功能通常由带有 rustler::init! 宏调用的地方开始，这通常位于 Rust 代码的一个特定文件中，用于注册所有的 NIF 函数至 Erlang/Elixir 环境中。

3. 项目的配置文件介绍

3.1 Cargo.toml

• Rustler 依赖配置：在此文件中定义 Rustler 及其依赖。例如，加入 [dependencies] 部分的 rustler 行以及任何特定版本或特性需求。

  [dependencies]
  rustler = { version = "...", features = ["serde"] }
  

3.2 mix.exs

• Elixir 项目的配置：对于结合 Elixir 使用的项目，mix.exs 文件内你会指定 Rustler 作为依赖并配置相关选项，确保 Elixir 能正确编译和链接 Rust 代码。

  defp deps do
    [
      {:rustler, "~> 0.24", runtime: false}
    ]
  end
  

在实际操作中，理解这些文件和结构是成功应用 Rustler 的基础。通过紧密跟随 Rustler 提供的官方示例和文档，开发者可以迅速上手，创建既高效又安全的跨语言功能。

rustler 项目地址: https://gitcode.com/gh_mirrors/rus/rustler