Struct jlrs::memory::frame::GcFrame

pub struct GcFrame<'frame, M: Mode> { /* fields omitted */ }

A frame that can be used to root values.

Roots are stored in slots, each slot can contain one root. Frames created with slots will preallocate that number of slots. Frames created without slots will dynamically create new slots as needed. If a frame is created without slots it is able to create at least 16 slots.

If there is sufficient capacity available, a new frame will use this remaining capacity. If the capacity is insufficient, more stack space is allocated.

Implementations

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

pub fn n_roots(&self) -> usize

Returns the number of values currently rooted in this frame.

pub fn n_slots(&self) -> usize

Returns the number of slots that are currently allocated to this frame.

pub fn capacity(&self) -> usize

Returns the maximum number of slots this frame can use.

#[must_use]

pub fn alloc_slots(&mut self, additional: usize) -> bool

Try to allocate additional slots in the current frame. Returns true on success, or false if self.n_slots() + additional > self.capacity().

Trait Implementations

impl<'frame, M: Mode> Drop for GcFrame<'frame, M>

fn drop(&mut self)

Executes the destructor for this type.

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

#[must_use]

fn alloc_slots(&mut self, additional: usize) -> bool

Reserve additional slots in the current frame. Returns true on success, or false if self.n_slots() + additional > self.capacity().

fn n_roots(&self) -> usize

Returns the number of values currently rooted in this frame.

fn n_slots(&self) -> usize

Returns the number of slots that are currently allocated to this frame.

fn capacity(&self) -> usize

Returns the maximum number of slots this frame can use.

fn as_scope(&mut self) -> &mut Self

This method takes a mutable reference to a frame and returns it; this method can be used as an alternative to reborrowing a frame with &mut *frame when a Scope is needed.