Struct jlrs::memory::frame::AsyncGcFrame

pub struct AsyncGcFrame<'frame> { /* private fields */ }

A frame that can be used to root Julia data and call async methods.

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

Implementations

impl<'frame> AsyncGcFrame<'frame>

pub async fn async_scope<'nested, T, F, G>(
    &'nested mut self,
    func: F
) -> JlrsResult<T> where
    T: 'frame,
    G: Future<Output = JlrsResult<T>>,
    F: FnOnce(AsyncGcFrame<'nested>) -> G, 

An async version of Frame::scope.

The closure func must return an async block. Note that the returned value is required to live at least as long the current frame.

pub async fn async_scope_with_capacity<'nested, T, F, G>(
    &'nested mut self,
    capacity: usize,
    func: F
) -> JlrsResult<T> where
    T: 'frame,
    G: Future<Output = JlrsResult<T>>,
    F: FnOnce(AsyncGcFrame<'nested>) -> G, 

An async version of Frame::scope_with_capacity.

The closure func must return an async block. Note that the returned value is required to live at least as long the current frame.

pub async unsafe fn relaxed_async_scope<'nested, T, F, G>(
    &'nested mut self,
    func: F
) -> JlrsResult<T> where
    T: 'nested,
    G: Future<Output = JlrsResult<T>>,
    F: FnOnce(AsyncGcFrame<'nested>) -> G, 

AsyncFrame::async_scope with less strict lifeitme bounds on the return value.

Safety: because this method only requires that the returned data lives at least as long as the borow of self, it’s possible to return data rooted in that scope.

pub async unsafe fn relaxed_async_scope_with_capacity<'nested, T, F, G>(
    &'nested mut self,
    capacity: usize,
    func: F
) -> JlrsResult<T> where
    T: 'nested,
    G: Future<Output = JlrsResult<T>>,
    F: for<'n> FnOnce(AsyncGcFrame<'n>) -> G, 

AsyncFrame::async_scope_wit_capacity with less strict lifeitme bounds on the return value.

Safety: because this method only requires that the returned data lives at least as long as the borow of self, it’s possible to return data rooted in that scope.

Trait Implementations

impl<'frame> Frame<'frame> for AsyncGcFrame<'frame>

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

Reserve a new reusable slot in the current frame.

fn n_roots(&self) -> usize

Returns the number of values currently rooted in this frame.

fn capacity(&self) -> usize

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

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

Reserve a new output in the current frame.

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

Convert the frame to a scope.

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.

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.