Ruru 项目教程

Ruru 项目教程

ruru Native Ruby extensions written in Rust 项目地址: https://gitcode.com/gh_mirrors/ru/ruru

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

Ruru 项目的目录结构如下：

ruru/
├── src/
│   ├── appveyor.yml
│   ├── .gitignore
│   ├── .travis.yml
│   ├── Cargo.toml
│   ├── LICENSE
│   ├── NEWS.md
│   ├── README.md
│   └── 其他源代码文件
├── examples/
│   └── 示例代码文件
├── tests/
│   └── 测试代码文件
└── 其他配置文件和文档

目录结构介绍

• src/: 包含项目的源代码文件，包括 Rust 和 Ruby 的扩展代码。
• examples/: 包含项目的示例代码，展示了如何使用 Ruru 编写 Ruby 扩展。
• tests/: 包含项目的测试代码，用于确保代码的正确性和稳定性。
• 其他配置文件和文档: 包括项目的配置文件（如 Cargo.toml）和文档文件（如 README.md）。

2. 项目的启动文件介绍

Ruru 项目的启动文件主要是 src/main.rs 或 src/lib.rs，具体取决于项目的结构。以下是一个典型的启动文件示例：

#[macro_use]
extern crate ruru;

use ruru::{Class, Object, RString};

class!(Hello);

methods!(
    Hello,
    itself,
    fn say_hello() -> RString {
        RString::new("Hello, World!")
    }
);

#[no_mangle]
pub extern fn initialize_hello() {
    Class::new("Hello", None).define(|itself| {
        itself.def("say_hello", say_hello);
    });
}

启动文件介绍

• #[macro_use] extern crate ruru;: 引入 Ruru 库。
• class!(Hello);: 定义一个名为 Hello 的 Ruby 类。
• methods!(...): 定义 Hello 类的方法，例如 say_hello。
• #[no_mangle] pub extern fn initialize_hello(): 定义一个初始化函数，用于在 Ruby 中注册 Hello 类。

3. 项目的配置文件介绍

Ruru 项目的主要配置文件是 Cargo.toml，它用于配置 Rust 项目的依赖和构建选项。以下是一个典型的 Cargo.toml 文件示例：

[package]
name = "ruru"
version = "0.1.0"
authors = ["Your Name <your.email@example.com>"]
edition = "2018"

[dependencies]
ruru = "0.10.0"

[lib]
crate-type = ["dylib"]

配置文件介绍

• [package]: 定义项目的元数据，如名称、版本和作者。
• [dependencies]: 定义项目的依赖项，例如 ruru。
• [lib]: 定义库的类型，例如 dylib，表示生成动态链接库。

通过以上配置，Ruru 项目可以正确地构建和运行，并生成适用于 Ruby 的扩展库。

ruru Native Ruby extensions written in Rust 项目地址: https://gitcode.com/gh_mirrors/ru/ruru