Struct jlrs::memory::frame::GcFrame

source · [−]

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

Expand description

A frame that can be used to root Julia data.

Frames created with a capacity can store at least that number of roots. A frame’s capacity is at least 16.

Trait Implementations

source

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

source

fn reusable_slot(&mut self) -> JlrsResult<ReusableSlot<'frame>>

Reserve a new reusable slot in the current frame. Read more

source

fn n_roots(&self) -> usize

Returns the number of values currently rooted in this frame.

source

fn capacity(&self) -> usize

Returns the maximum number of values that can be rooted in this frame.

source

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

Reserve a new output in the current frame. Read more

source

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

Convert the frame to a scope. Read more

source

fn scope<T, F>(&mut self, func: F) -> JlrsResult<T> where
for<'inner> F: FnOnce(GcFrame<'inner, Self::Mode>) -> JlrsResult<T>,

Create a new scope and call func with that scope’s frame. Read more

source

fn scope_with_capacity<T, F>(
 &mut self,
 capacity: usize,
 func: F
) -> JlrsResult<T> where
 for<'inner> F: FnOnce(GcFrame<'inner, Self::Mode>) -> JlrsResult<T>,

Create a new scope and call func with that scope’s frame. Read more

Auto Trait Implementations

impl<'frame, M> !RefUnwindSafe for GcFrame<'frame, M>

impl<'frame, M> !Send for GcFrame<'frame, M>

impl<'frame, M> !Sync for GcFrame<'frame, M>

impl<'frame, M> Unpin for GcFrame<'frame, M> where
M: Unpin,

impl<'frame, M> !UnwindSafe for GcFrame<'frame, M>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<'frame, T> Gc for T where
T: Frame<'frame>,

source

fn enable_gc(&mut self, on: bool) -> bool

Enable or disable the GC.

source

fn enable_gc_logging(&mut self, on: bool)

Enable or disable GC logging. Read more

source

fn gc_is_enabled(&mut self) -> bool

Returns true if the GC is enabled.

source

fn gc_collect(&mut self, mode: GcCollection)

Force a collection.

source

fn gc_safepoint(&mut self)

Insert a safepoint, a point where the garbage collector may run.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct jlrs::memory::frame::GcFrame

Trait Implementations

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

fn reusable_slot(&mut self) -> JlrsResult<ReusableSlot<'frame>>

fn n_roots(&self) -> usize

fn capacity(&self) -> usize

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

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

fn scope<T, F>(&mut self, func: F) -> JlrsResult<T> where
for<'inner> F: FnOnce(GcFrame<'inner, Self::Mode>) -> JlrsResult<T>,

fn scope_with_capacity<T, F>(
    &mut self,
    capacity: usize,
    func: F
) -> JlrsResult<T> where
    for<'inner> F: FnOnce(GcFrame<'inner, Self::Mode>) -> JlrsResult<T>,

Auto Trait Implementations

impl<'frame, M> !RefUnwindSafe for GcFrame<'frame, M>

impl<'frame, M> !Send for GcFrame<'frame, M>

impl<'frame, M> !Sync for GcFrame<'frame, M>

impl<'frame, M> Unpin for GcFrame<'frame, M> where
M: Unpin,

impl<'frame, M> !UnwindSafe for GcFrame<'frame, M>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<'frame, T> Gc for T where
T: Frame<'frame>,

fn enable_gc(&mut self, on: bool) -> bool

fn enable_gc_logging(&mut self, on: bool)

fn gc_is_enabled(&mut self) -> bool

fn gc_collect(&mut self, mode: GcCollection)

fn gc_safepoint(&mut self)

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct jlrs::memory::frame::GcFrame

Trait Implementations

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

fn reusable_slot(&mut self) -> JlrsResult<ReusableSlot<'frame>>

fn n_roots(&self) -> usize

fn capacity(&self) -> usize

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

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

fn scope<T, F>(&mut self, func: F) -> JlrsResult<T> where for<'inner> F: FnOnce(GcFrame<'inner, Self::Mode>) -> JlrsResult<T>,

fn scope_with_capacity<T, F>( &mut self, capacity: usize, func: F) -> JlrsResult<T> where for<'inner> F: FnOnce(GcFrame<'inner, Self::Mode>) -> JlrsResult<T>,

Auto Trait Implementations

impl<'frame, M> !RefUnwindSafe for GcFrame<'frame, M>

impl<'frame, M> !Send for GcFrame<'frame, M>

impl<'frame, M> !Sync for GcFrame<'frame, M>

impl<'frame, M> Unpin for GcFrame<'frame, M> where M: Unpin,

impl<'frame, M> !UnwindSafe for GcFrame<'frame, M>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<'frame, T> Gc for T where T: Frame<'frame>,

fn enable_gc(&mut self, on: bool) -> bool

fn enable_gc_logging(&mut self, on: bool)

fn gc_is_enabled(&mut self) -> bool

fn gc_collect(&mut self, mode: GcCollection)

fn gc_safepoint(&mut self)

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn scope<T, F>(&mut self, func: F) -> JlrsResult<T> where
for<'inner> F: FnOnce(GcFrame<'inner, Self::Mode>) -> JlrsResult<T>,

fn scope_with_capacity<T, F>(
&mut self,
capacity: usize,
func: F
) -> JlrsResult<T> where
for<'inner> F: FnOnce(GcFrame<'inner, Self::Mode>) -> JlrsResult<T>,

impl<'frame, M> Unpin for GcFrame<'frame, M> where
M: Unpin,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<'frame, T> Gc for T where
T: Frame<'frame>,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,