Skip to content

Latest commit

 

History

History
123 lines (90 loc) · 6.13 KB

readme.md

File metadata and controls

123 lines (90 loc) · 6.13 KB

rb-sys

.github/workflows/ci.yml Join the discussion Crates.io Gem

The primary goal of rb-sys is to make building native Ruby extensions in Rust easier than it would be in C. If it's not easy, it's a bug.

Features

  • Battle-tested Rust bindings for the Ruby C API
  • Support for Ruby 2.4+
  • Supports all major platforms (Linux, macOS, Windows)
  • Cross compilation of gems
  • Integration with rake-compiler

New to rb-sys?

Quick links

Usage

Below are some examples of how to use rb-sys to build native Rust extensions. Use these as a starting point for your building your own gem.

FAQ

What dependencies do I need to build a Ruby extension in Rust?

rb-sys will handle most of the dependencies for you, but you will need to have libclang installed on your system.

On MacOS, you can install it with brew install llvm.

On Linux, you can install it with apt-get install libclang-dev.

Supported Toolchains

  • Ruby: 2.6+ (for full compatibility with Rubygems)
  • Rust: 1.65+

Supported Platforms

We support cross compilation to the following platforms (this information is also available in the ./data directory for automation purposes):

Platform Supported Docker Image
x86_64-linux rbsys/x86_64-linux:0.9.102
x86_64-linux-musl rbsys/x86_64-linux-musl:0.9.102
aarch64-linux rbsys/aarch64-linux:0.9.102
aarch64-linux-musl rbsys/aarch64-linux-musl:0.9.102
arm-linux rbsys/arm-linux:0.9.102
arm64-darwin rbsys/arm64-darwin:0.9.102
x64-mingw32 rbsys/x64-mingw32:0.9.102
x64-mingw-ucrt rbsys/x64-mingw-ucrt:0.9.102
mswin not available on Docker

Getting Help

We make a concerted effort to help out new users. If you have questions, please join our Slack and post your question in the #general channel. Alternatively, you can open an issue and we'll try to help you out.

Contributing

See the CONTRIBUTING.md file for information about setting up a development environment.

Bug reports and pull requests are welcome on GitHub at https://github.com/oxidize-rb/rb-sys.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.