pub struct AsyncGcFrame<'scope> { /* private fields */ }
Expand description

A frame associated with an async scope.

The only difference between a GcFrame and an AsyncGcFrame is that the latter allows calling several async methods, most importantly those of CallAsync. An AsyncGcFrame can be (mutably) dereferenced as a GcFrame, so all methods of GcFrame are available to AsyncGcFrame.

Implementations§

source§

impl<'scope> AsyncGcFrame<'scope>

source

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

An async version of GcFrame::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.

source

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,

AsyncGcFrame::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 borrow of self, it’s possible to return data rooted in that scope which you must not do.

Methods from Deref<Target = GcFrame<'scope>>§

source

pub fn as_mut(&mut self) -> &mut Self

Returns a mutable reference to this frame.

source

pub fn reserve(&mut self, additional: usize)

Reserve capacity for at least additional roots.

source

pub fn borrow<'borrow>( &'borrow mut self ) -> BorrowedFrame<'borrow, 'scope, Self>

Borrow the current frame.

When a frame is borrowed, no more roots can be pushed until a new scope has been created. This is useful when a function needs to root Julia data but doesn’t return Julia data.

source

pub fn extended_target<'target, 'borrow, T>( &'borrow mut self, target: T ) -> ExtendedTarget<'target, 'scope, 'borrow, T>where T: Target<'target>,

Borrow this frame as an ExtendedTarget with the provided target.

source

pub fn as_extended_target<'borrow>( &'borrow mut self ) -> ExtendedTarget<'scope, 'scope, 'borrow, Output<'scope>>

Borrow this frame as an ExtendedTarget with an Output that targets this frame.

source

pub fn n_roots(&self) -> usize

Returns the number of values rooted in this frame.

source

pub fn stack_size(&self) -> usize

Returns the number of values rooted in this frame.

source

pub fn output(&self) -> Output<'scope>

Returns an Output that targets the current frame.

source

pub fn reusable_slot(&self) -> ReusableSlot<'scope>

Returns a ReusableSlot that targets the current frame.

source

pub fn unrooted(&self) -> Unrooted<'scope>

Returns a Unrooted that targets the current frame.

source

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

Create a temporary scope and call func with that scope’s GcFrame.

Example:

julia
    .scope(|mut frame| {
        let output = frame.output();

        let _sum = frame.scope(|mut frame| {
            let i = Value::new(&mut frame, 1u64);
            let j = Value::new(&mut frame, 2u64);

            unsafe {
                Module::base(&frame)
                    .function(&mut frame, "+")?
                    .call2(output, i, j)
                    .into_jlrs_result()
            }
        })?;

        Ok(())
    })
    .unwrap();

Trait Implementations§

source§

impl<'scope> Deref for AsyncGcFrame<'scope>

§

type Target = GcFrame<'scope>

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl<'scope> DerefMut for AsyncGcFrame<'scope>

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl<'target> RootingTarget<'target> for &mut AsyncGcFrame<'target>

source§

fn into_output(self) -> Output<'target>

Convert this target into an Output.
source§

impl<'target> RootingTarget<'target> for AsyncGcFrame<'target>

source§

fn into_output(self) -> Output<'target>

Convert this target into an Output.
source§

impl<'target> Target<'target> for &mut AsyncGcFrame<'target>

source§

fn unrooted(&self) -> Unrooted<'target>

Returns a new Unrooted.
source§

fn into_extended_target<'borrow, 'current>( self, frame: &'borrow mut GcFrame<'current> ) -> ExtendedTarget<'target, 'current, 'borrow, Self>

Convert self to an ExtendedTarget.
source§

fn into_extended_async_target<'borrow, 'current>( self, frame: &'borrow mut AsyncGcFrame<'current> ) -> ExtendedAsyncTarget<'target, 'current, 'borrow, Self>

Convert self to an ExtendedAsyncTarget.
source§

impl<'target> Target<'target> for AsyncGcFrame<'target>

source§

fn unrooted(&self) -> Unrooted<'target>

Returns a new Unrooted.
source§

fn into_extended_target<'borrow, 'current>( self, frame: &'borrow mut GcFrame<'current> ) -> ExtendedTarget<'target, 'current, 'borrow, Self>

Convert self to an ExtendedTarget.
source§

fn into_extended_async_target<'borrow, 'current>( self, frame: &'borrow mut AsyncGcFrame<'current> ) -> ExtendedAsyncTarget<'target, 'current, 'borrow, Self>

Convert self to an ExtendedAsyncTarget.
source§

impl<'target> TargetType<'target> for &mut AsyncGcFrame<'target>

§

type Data<'data, T: Managed<'target, 'data>> = T

Type returned by methods that don’t catch Julia exceptions. Read more
§

type Result<'data, T: Managed<'target, 'data>> = Result<T, Value<'target, 'data>>

Type returned by methods that catch Julia exceptions. Read more
§

type Exception<'data, T> = Result<T, Value<'target, 'data>>

Type returned by methods that don’t return Julia data on succes, but can throw a Julia exception which is caught. Read more
source§

impl<'target> TargetType<'target> for AsyncGcFrame<'target>

§

type Data<'data, T: Managed<'target, 'data>> = T

Type returned by methods that don’t catch Julia exceptions. Read more
§

type Result<'data, T: Managed<'target, 'data>> = Result<T, Value<'target, 'data>>

Type returned by methods that catch Julia exceptions. Read more
§

type Exception<'data, T> = Result<T, Value<'target, 'data>>

Type returned by methods that don’t return Julia data on succes, but can throw a Julia exception which is caught. Read more

Auto Trait Implementations§

§

impl<'scope> !RefUnwindSafe for AsyncGcFrame<'scope>

§

impl<'scope> Send for AsyncGcFrame<'scope>

§

impl<'scope> Sync for AsyncGcFrame<'scope>

§

impl<'scope> Unpin for AsyncGcFrame<'scope>

§

impl<'scope> !UnwindSafe for AsyncGcFrame<'scope>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AttachParachute for Twhere T: 'static + Send + Sync,

source§

fn attach_parachute<'scope, T: RootingTarget<'scope>>( self, target: T ) -> WithParachute<'scope, Self>

Attach a parachute to this data. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> Twhere Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<'frame, T> Gc for Twhere T: Target<'frame>,

source§

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

Enable or disable the GC.
source§

fn enable_gc_logging(&self, on: bool)

Enable or disable GC logging. Read more
source§

fn gc_is_enabled(&self) -> bool

Returns true if the GC is enabled.
source§

fn gc_collect(&self, mode: GcCollection)

Force a collection.
source§

fn gc_safepoint(&self)

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

fn gc_set_max_memory(max_mem: u64)

Set GC memory trigger in bytes for greedy memory collecting
source§

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

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.

§

impl<T> Pipe for Twhere T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> Rwhere Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.