Struct jlrs::runtime::sync_rt::Julia

pub struct Julia<'context> { /* private fields */ }

An active Julia instance.

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 content of the file is 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(GcFrame<'base>) -> JlrsResult<T>,

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

Example:

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

Trait Implementations

impl Gc for Julia<'_>

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

Enable or disable the GC.

fn enable_gc_logging(&self, on: bool)

Enable or disable GC logging.

fn gc_is_enabled(&self) -> bool

Returns true if the GC is enabled.

fn gc_collect(&self, mode: GcCollection)

Force a collection.

fn gc_safepoint(&self)

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

unsafe fn gc_safe_enter() -> i8

Put the current task in a GC-safe state.

unsafe fn gc_safe_leave(state: i8)

Leave a GC-safe region and return to the previous GC-state.

unsafe fn gc_unsafe_enter() -> i8

Put the current task in a GC-unsafe state.

unsafe fn gc_unsafe_leave(state: i8)

Leave a GC-unsafe region and return to the previous GC-state.

fn gc_set_max_memory(max_mem: u64)

Set GC memory trigger in bytes for greedy memory collecting