Struct rune::Runtime

pub struct Runtime { /* fields omitted */ }

A rune runtime, which simplifies embedding and using rune.

Implementations

impl Runtime

pub fn new() -> Result<Self, ContextError>

Construct a new runtime with the default context.

pub fn has_issues(&self) -> bool

Indicate that the runtime has issues it can report with emit_diagnostics.

pub fn with_context(context: Context) -> Self

Construct a new runtime with a custom context.

pub fn vm(&self) -> &Vm

Access the underlying virtual machine of the runtime.

pub fn context(&self) -> &Context

Access the underlying context of the runtime.

pub fn unit(&self, file_id: usize) -> Option<&CompilationUnit>

Get the unit associated with the given file id.

pub fn call_function<'a, A, T, I>(
    &'a mut self,
    file_id: usize,
    name: I,
    args: A
) -> Result<Task<'a, T>, CallFunctionError> where
    I: IntoIterator,
    I::Item: AsRef<str>,
    A: 'a + IntoArgs,
    T: FromValue, 

Call the given function in the given named file.

Returns the associated task and the file id associated with the unit.

pub fn register_vm_error(
    &mut self,
    file_id: usize,
    error: VmError
) -> Result<(), VmError>

Register the runtime error.

If we don't have debuginfo, returns Err with the passed in error.

pub fn parse_optimization<I>(
    &mut self,
    options: I
) -> Result<(), ConfigurationError> where
    I: IntoIterator,
    I::Item: AsRef<str>, 

Prase the given optimization options.

pub fn load(&mut self, path: &Path) -> Result<usize, LoadError>

Load the given path into the runtime.

pub fn emit_diagnostics<O>(&mut self, out: &mut O) -> Result<()> where
    O: WriteColor, 

Emit diagnostics about the last error we encountered.