Struct jlrs::frame::StaticFrame

pub struct StaticFrame<'frame, U> where
    U: Mode,  { /* fields omitted */ }

A StaticFrame is a frame that has a definite number of slots on the GC stack. With some exceptions, creating new Values and calling them require one slot each. Rather than using new slots on the GC stack when a slot is needed, a StaticFrame uses the slots it acquired on creation. See the documentation in the value module for more information about the costs. You get access to a StaticFrame by calling Julia::frame or Frame::frame, most of their functionality is defined in the Frame trait.

Implementations

impl<'frame, M: Mode> StaticFrame<'frame, M>

pub fn capacity(&self) -> usize

Returns the total number of slots.

Trait Implementations

impl<'frame, U> Drop for StaticFrame<'frame, U> where
    U: Mode, 

fn drop(&mut self)

Executes the destructor for this type.

impl<'frame, M: Mode> Frame<'frame> for StaticFrame<'frame, M>

fn frame<'nested, T, F: FnOnce(&mut StaticFrame<'nested, M>) -> 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, M>) -> 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.