Struct budget_executor::blocking::singlethreaded::Runtime

pub struct Runtime<Budget>(_) 
where
    Budget: Budgetable;

A lightweight asynchronous runtime that runs a future while keeping track of a budget.

Regardless of whether the threadsafe or single-threaded versions of the Runtime are used, this Runtime will always be a single-threaded runtime. The benefit of using the threadsafe runtime is to be able to move paused runtimes between different threads or allow the running futures to be woken by external threads.

Implementations

impl<Budget> Runtime<Budget> where
    Budget: Budgetable, 

pub fn run_with_budget<F>(
    future: impl FnOnce(Self) -> F,
    initial_budget: Budget
) -> Progress<Budget, F> where
    Budget: Budgetable,
    F: Future, 

Executes future with the provided budget. The future will run until it completes or until it has invoked spend() enough to exhaust the budget provided. If the future never called spend(), this function will not return until the future has completed.

This function returns a Future which must be awaited to execute the function.

This implementation is runtime agnostic.

Panics

Panics when called within from within future or any code invoked by future.

pub fn spawn<F: Future + 'static>(&self, future: F) -> TaskHandle<F::Output>

Schedules future to run.

This runtime will only execute one future at any given moment in time. Context switches between futures will only happen when the running future yields control at an await.

Returns a handle that can be .awaited to wait for the task to complete.

pub fn budget(&self) -> usize

Retrieves the current budget.

This function should only be called by code that is guaranteed to be running by this executor. When called outside of code run by this executor, this function will.

pub fn spend(&self, amount: usize) -> SpendBudget<'_, Budget>

Spends amount from the curent budget.

This function returns a future which must be awaited.

Trait Implementations

impl<Budget: Clone> Clone for Runtime<Budget> where
    Budget: Budgetable, 

fn clone(&self) -> Runtime<Budget>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Budget: Debug> Debug for Runtime<Budget> where
    Budget: Budgetable, 

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

Formats the value using the given formatter.