Struct jlrs::frame::AsyncFrame

pub struct AsyncFrame<'frame> { /* fields omitted */ }

An AsyncFrame is a special kind of DynamicFrame that’s available when you implement JuliaTask. In addition to the capabilities of a DynamicFrame it can be used to call Value::call_async which lets you call a function in a new thread in Julia. This feature is only available by using AsyncJulia.

Trait Implementations

impl<'frame> Drop for AsyncFrame<'frame>

fn drop(&mut self)

Executes the destructor for this type.

impl<'frame> Frame<'frame> for AsyncFrame<'frame>

fn frame<'nested, T, F: FnOnce(&mut StaticFrame<'nested, Async>) -> JlrsResult<T>>(
    &'nested mut self,
    capacity: usize,
    func: 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, Async>) -> JlrsResult<T>>(
    &'nested mut self,
    func: 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.