Type Definition mruby::Mrb

type Mrb = Rc<RefCell<State>>;

Interpreter instance.

The interpreter State is wrapped in an Rc<RefCell<_>>.

The Rc enables the State to be cloned so it can be stored in the sys::mrb_state, extracted in extern "C" functions, and used in Value instances.

The RefCell enables mutable access to the underlying State, even across an FFI boundary.

Functionality is added to the interpreter via traits, for example, garbage collection or eval.

Trait Implementations

impl MrbEval for Mrb

fn eval<T>(&self, code: T) -> Result<Value, MrbError> where
    T: AsRef<[u8]>, 

Eval code on the mruby interpreter using the current EvalContext or EvalContext::root if none is present on the stack.

fn unchecked_eval<T>(&self, code: T) -> Value where
    T: AsRef<[u8]>, 

Eval code on the mruby interpreter using the current EvalContext or EvalContext::root if none is present on the stack.

fn eval_with_context<T>(
    &self,
    code: T,
    context: EvalContext
) -> Result<Value, MrbError> where
    T: AsRef<[u8]>, 

Eval code on the mruby interpreter using a custom EvalContext.

fn unchecked_eval_with_context<T>(&self, code: T, context: EvalContext) -> Value where
    T: AsRef<[u8]>, 

Eval code on the mruby interpreter using a custom EvalContext.

fn peek_context(&self) -> Option<EvalContext>

Peek at the top of the EvalContext stack.

fn push_context(&self, context: EvalContext)

Push an EvalContext onto the stack.

fn pop_context(&self)

Pop an EvalContext from the stack.

impl MrbExceptionHandler for Mrb

fn last_error(&self) -> LastError

Extract the last thrown exception on the mruby interpreter if there is one.

impl MrbGarbageCollection for Mrb

fn create_arena_savepoint(&self) -> ArenaIndex

Create a savepoint in the GC arena which will allow mruby to deallocate all of the objects created via the C API.

fn live_object_count(&self) -> i32

Retrieve the number of live objects on the interpreter heap.

fn incremental_gc(&self)

Perform an incremental garbage collection.

fn full_gc(&self)

Perform a full garbage collection.

fn enable_gc(&self) -> bool

Enable garbage collection.

fn disable_gc(&self) -> bool

Disable garbage collection.

impl MrbLoadSources for Mrb

fn def_file<T>(
    &self,
    filename: T,
    require: fn(_: Self) -> Result<(), MrbError>
) -> Result<(), MrbError> where
    T: AsRef<str>, 

Add a Rust-backed Ruby source file to the virtual filesystem. A stub Ruby file is added to the filesystem and require will dynamically define Ruby items when invoked via Kernel#require.

fn def_file_for_type<T, F>(&self, filename: T) -> Result<(), MrbError> where
    T: AsRef<str>,
    F: MrbFile, 

Add a Rust-backed Ruby source file to the virtual filesystem. A stub Ruby file is added to the filesystem and MrbFile::require will dynamically define Ruby items when invoked via Kernel#require.

fn def_rb_source_file<T, F>(
    &self,
    filename: T,
    contents: F
) -> Result<(), MrbError> where
    T: AsRef<str>,
    F: AsRef<[u8]>, 

Add a pure Ruby source file to the virtual filesystem.

fn normalize_source_path<T>(&self, filename: T) -> PathBuf where
    T: AsRef<str>, 

Normalize path of a Ruby source to be relative to RUBY_LOAD_PATH unless the path is absolute.

impl MrbTopSelf for Mrb

fn top_self(&self) -> Value

Return a Value-wrapped reference to "top self".

impl MrbWarn for Mrb

fn warn(&self, message: &str) -> Result<(), MrbError>

Emit a warning message using Kernel#warn.