Struct tokio::runtime::coop::Budget

pub(crate) struct Budget(Option<u8>);

Opaque type tracking the amount of “work” a task may still do before yielding back to the scheduler.

Tuple Fields

0: Option<u8>

Implementations

impl Budget

const fn initial() -> Budget

Budget assigned to a task on each poll.

The value itself is chosen somewhat arbitrarily. It needs to be high enough to amortize wakeup and scheduling costs, but low enough that we do not starve other tasks for too long. The value also needs to be high enough that particularly deep tasks are able to do at least some useful work at all.

Note that as more yield points are added in the ecosystem, this value will probably also have to be raised.

pub(super) const fn unconstrained() -> Budget

Returns an unconstrained budget. Operations will not be limited.

fn has_remaining(self) -> bool

impl Budget

fn decrement(&mut self) -> BudgetDecrement

Decrements the budget. Returns true if successful. Decrementing fails when there is not enough remaining budget.

fn is_unconstrained(self) -> bool

Trait Implementations

impl Clone for Budget

fn clone(&self) -> Budget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Budget

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

Formats the value using the given formatter.

impl Copy for Budget