rb-sys 0.9.7

Rust bindings for the CRuby API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# rb-sys

[![Join the discussion](https://img.shields.io/badge/slack-chat-blue.svg)](https://join.slack.com/t/oxidize-rb/shared_invite/zt-16zv5tqte-Vi7WfzxCesdo2TqF_RYBCw)

Autogenerated Rust bindings for Ruby. Uses the [`rust-bindgen`](https://github.com/rust-lang/rust-bindgen) crate to
generate bindings from the `ruby.h` header.https://github.com/rust-lang/rust-bindgen

## ⚠️ Notice

This is a very low-level library. If you are looking to write a gem in Rust, you should probably use
https://github.com/matsadler/magnus crate, with the `rb-sys-interop` feature.

If you actually _need_ raw/unsafe bindings to libruby, the this crate if for you!

## Usage

1. Add the following to your `Cargo.toml`:

   ```toml
   [dependencies]
   rb-sys = "0.9"
   ```

2. [See this example of creating a Ruby gem in Rust](./examples/rust_reverse)

### Linking libruby

If you need to link libruby (i.e. you are initializing a Ruby VM in your Rust code), use can enable the `link-ruby`
feature:

```rust
rb-sys = { version = "0.9",  features = ["link-ruby"] }
```

If you are authoring a Ruby gem, you do not need to enable this feature.

### Static libruby

You can also force static linking of libruby:

```rust
rb-sys = { version = "0.9", features = ["ruby-static"] }
```

Alternatively, you can set the `RUBY_STATIC=true` environment variable.

### Other features

- `gem`: Setup boilerplate for a Ruby gem (enabled by default).
- `ruby-abi-version`: Set the Ruby ABI version. (enabled by default).
- `ruby-macros`: Generate Rust functions for Ruby macros like `RSTRING_PTR` (enabled by default).
- `global-allocator`: Report Rust memory allocations to the Ruby GC (_recommended_).
- `ruby-static`: Link the static version of libruby.
- `link-ruby`: Link libruby.
- `bindgen-rbimpls`: Include the Ruby impl types in bindings.
- `bindgen-deprecated-types`: Include deprecated Ruby methods in bindings.

## License

Licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.