Struct jlrs::frame::NullFrame

pub struct NullFrame<'frame>(_);

A NullFrame can be used if you call Rust from Julia through ccall and want to borrow array data but not perform any allocations. It can’t be nested or be used for functions that allocate (like creating new values or calling functions). Functions that depend on allocation will return JlrsError::NullFrame if you call them with a NullFrame.

Trait Implementations

impl<'frame> Frame<'frame> for NullFrame<'frame>

fn frame<'nested, T, F: FnOnce(&mut StaticFrame<'nested, Sync>) -> JlrsResult<T>>(
    &'nested mut self,
    _: usize,
    _: F
) -> JlrsResult<T>

Create a StaticFrame that can hold capacity values, and call the given closure. Returns the result of this closure, or an error if the new frame can’t be created because there’s not enough space on the GC stack. The number of required slots on the stack is capacity + 2.

fn dynamic_frame<'nested, T, F: FnOnce(&mut DynamicFrame<'nested, Sync>) -> JlrsResult<T>>(
    &'nested mut self,
    _: F
) -> JlrsResult<T>

Create a DynamicFrame and call the given closure. Returns the result of this closure, or an error if the new frame can’t be created because the stack is too small. The number of required slots on the stack is 2.

fn output(&mut self) -> JlrsResult<Output<'frame>>

Returns a new Output, this takes one slot on the GC stack. A function that uses this output will not use a slot on the GC stack, but the one associated with this output. This extends the lifetime of that value to be valid until the frame that created the output goes out of scope.

fn size(&self) -> usize

Returns the number of values belonging to this frame.

fn print_memory(&self)

fn global(&self) -> Global<'frame>

Create a new Global which can be used to access a global in Julia. These globals are limited to the frame’s lifetime rather than the base lifetime.