rbsys/x64-mingw32

rb-sys

镜像概述和主要用途

rb-sys 是一个旨在简化使用 Rust 构建 Ruby 原生扩展的工具集，其核心目标是让 Rust 实现的 Ruby 扩展开发比 C 语言更简单。它提供了完整的工具链支持，包括 Rust 绑定、编译工具、测试辅助和 Docker 交叉编译工具，帮助开发者高效、安全地开发 Ruby 原生扩展。

核心功能和特性

主要组件

• rb-sys crate：经过实战测试的 Ruby C API Rust 绑定
• rb_sys gem：简化将 Rust 代码编译为 Ruby 扩展的过程
• rb-sys-test-helpers：用于从 Rust 测试 Ruby 扩展的实用工具
• rb-sys-dock：基于 Docker 的交叉编译工具

核心特性

• 提供 Ruby C API 的类型安全 Rust 绑定
• 简化 Ruby 扩展的编译和打包流程
• 内置测试辅助工具，便于扩展功能验证
• 支持跨平台开发和交叉编译
• 完善的文档和示例支持

使用场景和适用范围

rb-sys 适用于以下场景：

• 开发高性能 Ruby 原生扩展
• 需要利用 Rust 内存安全特性的 Ruby 扩展开发
• 跨平台 Ruby 扩展的构建和分发
• 希望简化 Ruby 扩展测试流程的开发团队

详细使用方法和配置说明

文档资源

完整文档请参考 https://oxidize-rb.github.io/rb-sys/%EF%BC%8C%E6%B6%B5%E7%9B%96%EF%BC%9A

• 快速入门教程
• Ruby 对象、类和模块操作
• 内存管理与安全
• 跨平台开发
• 测试与调试
• rb-sys crate 和 rb_sys gem 的 API 参考

安装与使用

1. 添加依赖：在 Rust 项目的 Cargo.toml 中添加 rb-sys crate

   toml
   [dependencies]
   rb-sys = "0.9"
   

2. 使用 rb_sys gem：在 Ruby 项目的 Gemfile 中添加

   ruby
   gem 'rb_sys'
   

3. 交叉编译：使用 rb-sys-dock 进行跨平台编译

   bash
   # 示例：使用 Docker 交叉编译 Ruby 扩展
   rb-sys-dock build --target x86_64-pc-windows-msvc
   

支持的工具链

• Ruby：2.7 及以上版本
• Rust：1.71 及以上版本

实际应用示例

• https://github.com/oxidize-rb/oxi-test - rb-sys 使用的标准示例（最小化、经过测试、支持交叉编译）
• https://github.com/oxidize-rb/blake3-ruby - 基于 rb-sys 的快速加密哈希函数实现
• https://github.com/bytecodealliance/wasmtime-rb - 结合 rb-sys 和 Magnus 的 WebAssembly 运行时
• https://github.com/yoshoku/lz4-ruby - 基于 rb-sys 的 LZ4 压缩库

获取帮助

• 加入 Oxidize Ruby Slack 并在 #general 频道提问
• 在 GitHub 上 https://github.com/oxidize-rb/rb-sys/issues

贡献

关于搭建开发环境的信息，请参见 https://github.com/oxidize-rb/rb-sys/blob/main/CONTRIBUTING.md 文件。

许可证

可选择以下任一许可证：

• Apache License, Version 2.0 (https://github.com/oxidize-rb/rb-sys/blob/main/LICENSE-APACHE)
• MIT license (https://github.com/oxidize-rb/rb-sys/blob/main/LICENSE-MIT)