anima-engine / mrusty Goto Github PK

View Code? Open in Web Editor NEW

205.0 10.0 19.0 612 KB

mruby safe bindings for Rust

License: Mozilla Public License 2.0

Rust 90.97% C 1.72% Shell 0.69% Ruby 6.61%

mruby ruby rust bridge

mrusty's Introduction

mrusty. mruby safe bindings for Rust

mrusty lets you:

run Ruby 1.9 files with a very restricted API (without having to install Ruby)
reflect Rust structs and enums in mruby and run them

It does all this in a safely neat way, while also bringing spec testing and a REPL to the table.

Documentation

Example

A very simple example of a Container struct which will be passed to mruby and which is perfectly callable.

// mrusty_class!
#[macro_use]
extern crate mrusty;

use mrusty::{Mruby, MrubyImpl};

let mruby = Mruby::new();

struct Cont {
    value: i32
}

// Cont should not flood the current namespace. We will add it with require.
mrusty_class!(Cont, "Container", {
    // Converts mruby types automatically & safely.
    def!("initialize", |v: i32| {
        Cont { value: v }
    });

    // Converts slf to Cont.
    def!("value", |mruby, slf: (&Cont)| {
        mruby.fixnum(slf.value)
    });
});

// Add file to the context, making it requirable.
mruby.def_file::<Cont>("cont");

// Add spec testing.
describe!(Cont, "
  context 'when containing 1' do
    it 'returns 1 when calling #value' do
      expect(Container.new(1).value).to eql 1
    end
  end
");

let result = mruby.run("
  require 'cont'

  Container.new(3).value
").unwrap(); // Returns Value.

println!("{}", result.to_i32().unwrap()); // Prints "3".

mrusty's People

Stargazers

Watchers

Forkers

neuroradiology steveklabnik plietar take-cheeze ess mikalv mlga matt-is-confused mattmcdonald wordijp udzura ajunlonglive standardgalactic playfloor icodein

mrusty's Issues

Host documentation.

See if casts can raise mruby exceptions.

Implement Value.type() with Rust's Any to aid fast type pattern matching.

match value.type() {
    f64 => ...
    Cont => ...
}

Find a way to connect Result with mruby Exception.

Repl should probably be abstracted to work with any kind of readline. (a trait would be nice)

The repl feature should be named gnu-readline and the Repl should always be available, on any platform.

Find a smart way of avoiding NULL pointers in mrfn!.

mrfn! accepts 2 parameters and mruby only sends one. Might be solved by mruby.

Investigate and test erroneous mruby.obj() calls.

mruby.obj(3.0);

Should panic with Class not found.

Do a little code cleanup & refactoring.

Add an OSX build in Travis.

Add Vec & Option to mrfn!.

Add runnable example.

Improve documentation & talk about the little things.

Implement mruby.value<T> with automated casting.

Add Exception type argument to raise() and make it return nil.

call should return Result<Value>, not Value.

Inline C functions.

Sources are not visible in Coveralls.

Add RSpec-style specification tests.

spec!("
  describe MyClass
    ...
  end
");

Rename project in all headers.

Try to replace null ending `C` string functions with known-size counterparts.

Add Data types to mrfn.

They should be cast with to_obj::<T>.

Rename all unused closure variables in docs.

Add more integration tests.

Consider adding cargo benchmarks.

Wrap mruby macros in C function for mrb_value and keep MRValue opaque.

Implement .mrb execution.

Fix mruby build documentation in README.md and lib.rs.

Rename MR* to Mr*.

Panics end process with 4 SIGILL when panic is called from mruby.

Remove \ from Repl and try to parse it.

Implement MRuby and Value with Arc and Mutex.

Consider using travis-cargo for travis ci.

With travis-cargo, you can upload the docs without needing to install anything, so you could use sudo: false in your .travis.yml. This makes use of Travis' container-based build, which is faster.