Struct jlrs::extensions::multitask::async_frame::AsyncGcFrame

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

A frame is used to root Julia data, which guarantees the garbage collector doesn’t free the data while the frame has not been dropped. More information about this topic can be found in the memory module.

An AsyncGcFrame offers the same functionality as a GcFrame, and some additional async methods that can be used to create nested async scopes. It can also be used to call the trait methods of CallAsync.

Implementations

impl<'frame> AsyncGcFrame<'frame>

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

An async version of Scope::value_scope. Rather than a closure, it takes an async closure that provides a new AsyncGcFrame.

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

An async version of Scope::value_scope_with_slots. Rather than a closure, it takes an async closure that provides a new AsyncGcFrame.

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

An async version of Scope::result_scope. Rather than a closure, it takes an async closure that provides a new AsyncGcFrame.

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

An async version of Scope::result_scope_with_slots. Rather than a closure, it takes an async closure that provides a new AsyncGcFrame.

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(&'nested mut AsyncGcFrame<'nested>) -> G, 

An async version of ScopeExt::scope. Rather than a closure, it takes an async closure that provides a new AsyncGcFrame.

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

An async version of ScopeExt::scope_with_slots. Rather than a closure, it takes an async closure that provides a new AsyncGcFrame.

pub fn n_roots(&self) -> usize

Returns the number of values currently rooted in this frame.

pub fn capacity(&self) -> usize

Returns the maximum number of slots this frame can use.

Trait Implementations

impl<'frame> Drop for AsyncGcFrame<'frame>

fn drop(&mut self)

Executes the destructor for this type.

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

fn reusable_slot(&mut self) -> JlrsResult<ReusableSlot<'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 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.