Struct jlrs::runtime::sync_rt::Julia

pub struct Julia { /* private fields */ }

A Julia instance.

You must create this instance with RuntimeBuilder::start before you can start using Julia from Rust. While this struct exists Julia is active, dropping it causes the shutdown code to be called but this doesn’t leave Julia in a state from which it can be reinitialized.

Implementations

impl Julia

pub fn error_color(&mut self, enable: bool) -> JlrsResult<()>

Enable or disable colored error messages originating from Julia. If this is enabled the error message in JlrsError::Exception can contain ANSI color codes. This feature is disabled by default.

pub unsafe fn include<P: AsRef<Path>>(&mut self, path: P) -> JlrsResult<()>

Calls include in the Main module in Julia, which executes the file’s contents in that module. This has the same effect as calling include in the Julia REPL.

This is unsafe because the contents of the file are evaluated.

Example:

unsafe { julia.include("Path/To/MyJuliaCode.jl").unwrap(); }

pub fn scope<T, F>(&mut self, func: F) -> JlrsResult<T> where
    for<'base> F: FnOnce(Global<'base>, GcFrame<'base, Sync>) -> JlrsResult<T>, 

This method is a main entrypoint to interact with Julia. It takes a closure with two arguments, a Global and a GcFrame, and can return arbitrary results.

Example:

  julia.scope(|_global, mut frame| {
      let _i = Value::new(&mut frame, 1u64)?;
      Ok(())
  }).unwrap();

pub fn scope_with_capacity<T, F>(
    &mut self,
    capacity: usize,
    func: F
) -> JlrsResult<T> where
    for<'base> F: FnOnce(Global<'base>, GcFrame<'base, Sync>) -> JlrsResult<T>, 

This method is a main entrypoint to interact with Julia. It takes a closure with two arguments, a Global and a GcFrame, and can return arbitrary results. The frame will have capacity for at least capacity roots.

Example:

  julia.scope_with_capacity(1, |_global, mut frame| {
      let _i = Value::new(&mut frame, 1u64)?;
      Ok(())
  }).unwrap();

Trait Implementations

impl Drop for Julia

fn drop(&mut self)

Executes the destructor for this type.

impl Gc for Julia

fn enable_gc(&mut self, on: bool) -> bool

Enable or disable the GC.

fn enable_gc_logging(&mut self, on: bool)

Enable or disable GC logging.

fn gc_is_enabled(&mut self) -> bool

Returns true if the GC is enabled.

fn gc_collect(&mut self, mode: GcCollection)

Force a collection.

fn gc_safepoint(&mut self)

Insert a safepoint, a point where the garbage collector may run.