rosy 0.0.1

Ruby bindings for Rust.
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
71
72
73
74
75
76
77

# Rosy

[![Build status][travis-badge]][travis]
![Lines of code][loc-badge]
[![crates.io][crate-badge] ![downloads][dl-badge]][crate]
[![docs.rs][docs-badge]][docs]

High-level bindings of [Ruby]'s C API for [Rust].

## Installation

This crate is available [on crates.io][crate] and can be used by adding the
following to your project's [`Cargo.toml`]:

```toml
[dependencies]
rosy = "0.0.1"
```

Rosy has functionality that is only available for certain Ruby versions. The
following features can currently be enabled:

- `ruby_2_6`

For example:

```toml
[dependencies.rosy]
version = "0.0.1"
features = ["ruby_2_6"]
```

Finally add this to your crate root (`main.rs` or `lib.rs`):

```rust
extern crate rosy;
```

## Usage

Rosy allows you to perform _many_ operations over Ruby objects in a way that
feels very natural in Rust.

```rust
use rosy::String;

// The VM should be initialized before doing anything
rosy::vm::init().expect("Could not initialize Ruby");

let string = String::from("hello\r\n");
string.call("chomp!").unwrap();

assert_eq!(string, "hello");
```

## License

This project is released under either:

- [MIT License](https://github.com/nvzqz/rosy/blob/master/LICENSE-MIT)

- [Apache License (Version 2.0)](https://github.com/nvzqz/rosy/blob/master/LICENSE-APACHE)

at your choosing.

[Ruby]:         https://www.ruby-lang.org
[Rust]:         https://www.rust-lang.org
[`Cargo.toml`]: https://doc.rust-lang.org/cargo/reference/manifest.html

[travis]:       https://travis-ci.com/oceanpkg/rosy
[travis-badge]: https://travis-ci.com/oceanpkg/rosy.svg?branch=master
[loc-badge]:    https://tokei.rs/b1/github/oceanpkg/rosy?category=code
[crate]:        https://crates.io/crates/rosy
[crate-badge]:  https://img.shields.io/crates/v/rosy.svg
[dl-badge]:     https://img.shields.io/crates/d/rosy.svg
[docs]:         https://docs.rs/rosy
[docs-badge]:   https://docs.rs/rosy/badge.svg