Struct muse_reactor::BudgetPoolHandle

pub struct BudgetPoolHandle<Work = NoWork>(/* private fields */);

A handle to a budget pool.

Tasks spawned in a budget pool will only be able to execute while the budget pool has remaining budget.

When all handles to a budget pool have been dropped, all outstanding tasks belonging to the budget pool will be cancelled.

Implementations

impl<Work> BudgetPoolHandle<Work>

where Work: WorkUnit,

pub fn id(&self) -> BudgetPoolId

Returns the id of this pool.

pub fn spawn(&self, vm: Vm) -> Result<TaskHandle, ReactorShutdown>

Spawns vm in the reactor, returning a handle to the spawned task.

Builder::new_vm can be used to customize what functionality is available in every virtual machine.

This task will execute with a shared budget and will be paused when no budget is available in this pool.

pub fn spawn_source( &self, source: impl Into<String>, ) -> Result<TaskHandle, ReactorShutdown>

Spawns a task that compiles and executes source.

Builder::new_vm can be used to customize how source is compiled and what functionality is available in every virtual machine.

This task will execute with a shared budget and will be paused when no budget is available in this pool.

pub fn spawn_call( &self, code: Code, args: Vec<RootedValue>, ) -> Result<TaskHandle, ReactorShutdown>

Spawns a task that executes code after loading args to the virtual machine registers.

Builder::new_vm can be used to customize what functionality is available in every virtual machine.

This task will execute with a shared budget and will be paused when no budget is available in this pool.

pub fn spawn_work(&self, work: Work) -> Result<TaskHandle, ReactorShutdown>

Spawns a task that executes work.

This function allows a user-specified type to be spawned and converted into a task using the WorkUnit trait.

Builder::new_vm can be used to customize the Work generic and what functionality is available in every virtual machine.

This task will execute with a shared budget and will be paused when no budget is available in this pool.

pub fn increase_budget(&self, amount: usize)

Adds amount to the budget.

This function cannot increase the budget above BudgetPoolConfig::maximum.

pub fn remaining_budget(&self) -> usize

Returns the currently remaining budget.

pub fn reactor(&self) -> &ReactorHandle<Work>

Returns a handle to the reactor this pool belongs to.

Trait Implementations

impl<Work> Clone for BudgetPoolHandle<Work>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Work> Debug for BudgetPoolHandle<Work>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Work> ContainsNoRefs for BudgetPoolHandle<Work>

where Work: WorkUnit,