Struct jlrs::frame::DynamicFrame

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

A DynamicFrame is a frame that has a dynamic number of slots on the GC stack. With some exceptions, creating new Values and calling them require one slot each. A DynamicFrame acquires a new slot every time one is needed. See the documentation in the value module for more information about the costs. You get access to a DynamicFrame by calling Julia::dynamic_frame or Frame::dynamic_frame, most of their functionality is defined in the Frame trait.

Trait Implementations

impl<'frame> Drop for DynamicFrame<'frame>

fn drop(&mut self)

Executes the destructor for this type.

impl<'frame> Frame<'frame> for DynamicFrame<'frame>

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