rb-sys

概述和主要用途

rb-sys 是一个专注于简化使用 Rust 构建 Ruby 原生扩展的工具集。其核心目标是使 Rust 开发 Ruby 原生扩展的过程比使用 C 语言更加便捷。该工具集整合了多个组件，涵盖从 Rust 到 Ruby C API 的绑定、编译工具、测试辅助功能，以及基于 Docker 的交叉编译支持（rb-sys-dock），适用于需要高性能、内存安全特性的 Ruby 扩展开发场景。

核心功能和特性

主要组件

• rb-sys crate：经过实战验证的 Rust 绑定库，提供 Ruby C API 的安全访问接口
• rb_sys gem：简化 Rust 代码编译为 Ruby 扩展的工具，降低构建流程复杂度
• rb-sys-test-helpers：用于从 Rust 环境测试 Ruby 扩展的实用工具集
• rb-sys-dock：基于 Docker 的交叉编译工具，支持跨平台 Ruby 扩展开发

支持的工具链版本

• Ruby：2.6 及更高版本
• Rust：1.71 及更高版本

使用场景和适用范围

• 开发需要高性能特性的 Ruby 原生扩展，替代传统 C 实现
• 构建需确保内存安全和类型安全的 Ruby 扩展项目
• 进行跨平台 Ruby 扩展开发，需在多操作系统环境中编译
• 简化 Ruby 扩展的测试、调试及部署流程

详细使用方法和配置说明

***文档

完整的使用指南和教程请参考 Ruby on Rust Book，涵盖以下内容：

• 快速入门与基础教程
• Ruby 对象、类及模块的 Rust 交互方法
• 内存管理与安全最佳实践
• 跨平台开发配置指南
• 测试与调试工具使用说明
• rb-sys crate 和 rb_sys gem 的 API 参考文档

Docker 交叉编译工具（rb-sys-dock）

rb-sys-dock 提供基于 Docker 的标准化环境，用于 Ruby 扩展的交叉编译。该工具简化了跨平台编译流程，支持在单一环境中生成多目标平台的扩展文件。具体使用方法请参考***文档，典型流程包括：

1. 拉取或构建 rb-sys-dock 镜像
2. 挂载项目目录到 Docker 容器
3. 执行容器内交叉编译命令生成目标平台扩展

实际应用示例

以下项目基于 rb-sys 构建，可作为参考案例：

• oxi-test：rb-sys 标准使用示例（最小化配置、完整测试、支持交叉编译）
• blake3-ruby：基于 Rust 实现的高性能加密哈希函数扩展
• wasmtime-rb：结合 rb-sys 与 Magnus 的 WebAssembly 运行时扩展
• lz4-ruby：LZ4 压缩算法的 Ruby 扩展实现

获取帮助

• 加入 Oxidize Ruby Slack 社区，在 #general 频道提问
• 在 GitHub 仓库 提交 issue 反馈问题或需求

贡献指南

关于开发环境搭建及贡献流程的详细信息，请参见 CONTRIBUTING.md。

许可证

本项目采用双许可证授权，您可根据需求选择以下任一许可证：

• Apache License, Version 2.0 (LICENSE-APACHE)
• MIT 许可证 (LICENSE-MIT)