Struct TaskScope 

pub struct TaskScope { /* private fields */ }

The spending and the records of one phase of one turn.

Implementations

impl TaskScope

pub fn new(budget: Budget, locale: Locale) -> Self

A scope bounded by budget, for a turn in locale.

pub fn with_profiles(self, profiles: TaskProfiles) -> Self

Runs this scope’s tasks under profiles instead of the engine’s.

pub const fn with_effort(self, effort: Effort) -> Self

Labels this scope’s task signals with the turn’s effort.

pub const fn effort(&self) -> Option<Effort>

The effort this scope’s turn runs at, when it was given one.

pub fn for_turn(self, turn: impl Into<String>) -> Self

Labels every call of this scope with the turn it belongs to, for a trace or a provider’s own logs to group them.

pub fn records(&self) -> Vec<TaskRecord>

Every call recorded so far, in the order the calls finished.

pub fn budget_report(&self) -> BudgetReport

What was spent.

pub fn exhausted(&self) -> Option<BudgetBound>

The first bound reached, if any.

pub const fn locale(&self) -> &Locale

The turn’s locale.

Trait Implementations

impl Debug for TaskScope

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

Formats the value using the given formatter.