Struct budget_executor::asynchronous::singlethreaded::Context

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

A budget-limited asynchronous context.

Implementations

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

pub fn run_with_budget<F>(
    future: impl FnOnce(Context<Budget>) -> F,
    initial_budget: Budget
) -> BudgetedFuture<Budget, F> where
    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 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 Context<Budget> where
    Budget: Budgetable, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.