pub struct StoreContextMut<'a, T>(/* private fields */)
where
T: 'static;
Expand description
A temporary handle to a &mut Store<T>
.
This type is suitable for AsContextMut
or AsContext
trait bounds on
methods if desired. For more information, see Store
.
Implementations§
Source§impl<'a, T> StoreContextMut<'a, T>
impl<'a, T> StoreContextMut<'a, T>
Sourcepub async fn gc_async(&mut self, why: Option<&GcHeapOutOfMemory<()>>)where
T: Send + 'static,
pub async fn gc_async(&mut self, why: Option<&GcHeapOutOfMemory<()>>)where
T: Send + 'static,
Perform garbage collection of ExternRef
s.
Same as Store::gc
.
This method is only available when the gc
Cargo feature is enabled.
Sourcepub fn epoch_deadline_async_yield_and_update(&mut self, delta: u64)
pub fn epoch_deadline_async_yield_and_update(&mut self, delta: u64)
Configures epoch-deadline expiration to yield to the async caller and the update the deadline.
For more information see
Store::epoch_deadline_async_yield_and_update
.
Source§impl<'a, T> StoreContextMut<'a, T>
impl<'a, T> StoreContextMut<'a, T>
Sourcepub fn data(&self) -> &T
pub fn data(&self) -> &T
Access the underlying data owned by this Store
.
Same as Store::data
.
Sourcepub fn data_mut(&mut self) -> &mut T
pub fn data_mut(&mut self) -> &mut T
Access the underlying data owned by this Store
.
Same as Store::data_mut
.
Sourcepub fn gc(&mut self, why: Option<&GcHeapOutOfMemory<()>>)
pub fn gc(&mut self, why: Option<&GcHeapOutOfMemory<()>>)
Perform garbage collection of ExternRef
s.
Same as Store::gc
.
This method is only available when the gc
Cargo feature is enabled.
Sourcepub fn get_fuel(&self) -> Result<u64, Error>
pub fn get_fuel(&self) -> Result<u64, Error>
Returns remaining fuel in this store.
For more information see Store::get_fuel
Sourcepub fn set_fuel(&mut self, fuel: u64) -> Result<(), Error>
pub fn set_fuel(&mut self, fuel: u64) -> Result<(), Error>
Set the amount of fuel in this store.
For more information see Store::set_fuel
Sourcepub fn fuel_async_yield_interval(
&mut self,
interval: Option<u64>,
) -> Result<(), Error>
pub fn fuel_async_yield_interval( &mut self, interval: Option<u64>, ) -> Result<(), Error>
Configures this Store
to periodically yield while executing futures.
For more information see Store::fuel_async_yield_interval
Sourcepub fn set_epoch_deadline(&mut self, ticks_beyond_current: u64)
pub fn set_epoch_deadline(&mut self, ticks_beyond_current: u64)
Sets the epoch deadline to a certain number of ticks in the future.
For more information see Store::set_epoch_deadline
.
Sourcepub fn epoch_deadline_trap(&mut self)
pub fn epoch_deadline_trap(&mut self)
Configures epoch-deadline expiration to trap.
For more information see Store::epoch_deadline_trap
.
Sourcepub fn throw<R>(
&mut self,
exception: Rooted<ExnRef>,
) -> Result<R, ThrownException>
pub fn throw<R>( &mut self, exception: Rooted<ExnRef>, ) -> Result<R, ThrownException>
Set an exception as the currently pending exception, and return an error that propagates the throw.
See Store::throw
for more details.
Sourcepub fn take_pending_exception(&mut self) -> Option<Rooted<ExnRef>>
pub fn take_pending_exception(&mut self) -> Option<Rooted<ExnRef>>
Take the currently pending exception, if any, and return it, removing it from the “pending exception” slot.
See Store::take_pending_exception
for more details.
Sourcepub fn has_pending_exception(&self) -> bool
pub fn has_pending_exception(&self) -> bool
Tests whether there is a pending exception.
See Store::has_pending_exception
for more details.
Source§impl<T> StoreContextMut<'_, T>
impl<T> StoreContextMut<'_, T>
Sourcepub fn spawn(
self,
task: impl AccessorTask<T, HasSelf<T>, Result<(), Error>>,
) -> JoinHandle ⓘwhere
T: 'static,
pub fn spawn(
self,
task: impl AccessorTask<T, HasSelf<T>, Result<(), Error>>,
) -> JoinHandle ⓘwhere
T: 'static,
Spawn a background task to run as part of this instance’s event loop.
The task will receive an &Accessor<U>
and run concurrently with
any other tasks in progress for the instance.
Note that the task will only make progress if and when the event loop for this instance is run.
The returned [SpawnHandle
] may be used to cancel the task.
Sourcepub async fn run_concurrent<R>(
self,
fun: impl AsyncFnOnce(&Accessor<T>) -> R,
) -> Result<R, Error>where
T: Send + 'static,
pub async fn run_concurrent<R>(
self,
fun: impl AsyncFnOnce(&Accessor<T>) -> R,
) -> Result<R, Error>where
T: Send + 'static,
Run the specified closure fun
to completion as part of this store’s
event loop.
This will run fun
as part of this store’s event loop until it
yields a result. fun
is provided an Accessor
, which provides
controlled access to the store and its data.
This function can be used to invoke Func::call_concurrent
for
example within the async closure provided here.
§Example
store.run_concurrent(async |accessor| -> wasmtime::Result<_> {
let resource = accessor.with(|mut access| access.get().table.push(MyResource(42)))?;
let (another_resource,) = foo.call_concurrent(accessor, (resource,)).await?.0;
let value = accessor.with(|mut access| access.get().table.delete(another_resource))?;
bar.call_concurrent(accessor, (value.0,)).await?;
Ok(())
}).await??;
Trait Implementations§
Source§impl<T> AsContext for StoreContextMut<'_, T>where
T: 'static,
impl<T> AsContext for StoreContextMut<'_, T>where
T: 'static,
Source§fn as_context(&self) -> StoreContext<'_, T>
fn as_context(&self) -> StoreContext<'_, T>
Source§impl<T> AsContextMut for StoreContextMut<'_, T>where
T: 'static,
impl<T> AsContextMut for StoreContextMut<'_, T>where
T: 'static,
Source§fn as_context_mut(&mut self) -> StoreContextMut<'_, T>
fn as_context_mut(&mut self) -> StoreContextMut<'_, T>
Source§impl<'a, T> From<&'a mut T> for StoreContextMut<'a, <T as AsContext>::Data>where
T: AsContextMut,
impl<'a, T> From<&'a mut T> for StoreContextMut<'a, <T as AsContext>::Data>where
T: AsContextMut,
Source§impl<'a, T> From<StoreContextMut<'a, T>> for StoreContext<'a, T>where
T: 'static,
impl<'a, T> From<StoreContextMut<'a, T>> for StoreContext<'a, T>where
T: 'static,
Source§fn from(store: StoreContextMut<'a, T>) -> StoreContext<'a, T>
fn from(store: StoreContextMut<'a, T>) -> StoreContext<'a, T>
Source§impl<I, T> Index<I> for StoreContextMut<'_, T>where
StoreOpaque: Index<I>,
impl<I, T> Index<I> for StoreContextMut<'_, T>where
StoreOpaque: Index<I>,
Auto Trait Implementations§
impl<'a, T> Freeze for StoreContextMut<'a, T>
impl<'a, T> !RefUnwindSafe for StoreContextMut<'a, T>
impl<'a, T> Send for StoreContextMut<'a, T>where
T: Send,
impl<'a, T> Sync for StoreContextMut<'a, T>where
T: Sync,
impl<'a, T> Unpin for StoreContextMut<'a, T>
impl<'a, T> !UnwindSafe for StoreContextMut<'a, T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more