Struct WorkflowBudget 

pub struct WorkflowBudget { /* private fields */ }

A shared, workflow-scoped token ledger that also acts as a BudgetGuard.

Implementations

impl WorkflowBudget

pub fn new(limit_tokens: Option<u64>) -> Self

A ledger with an optional hard token ceiling and no inner guard.

pub fn with_inner(self, inner: Arc<dyn BudgetGuard>) -> Self

Delegate check/record to inner in addition to maintaining the shared ledger — lets a host’s existing per-tenant guard keep working while the workflow gets its aggregate cap.

pub fn consumed_tokens(&self) -> u64

Total tokens recorded so far.

pub fn snapshot(&self) -> BudgetSnapshot

A point-in-time view of the ledger.

pub fn is_exhausted(&self) -> bool

Whether the configured cap has been reached.

Trait Implementations

impl BudgetGuard for WorkflowBudget

fn check_before_llm<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, estimated_prompt_tokens: usize, ) -> Pin<Box<dyn Future<Output = BudgetDecision> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called immediately before an LLM API call.

fn record_after_llm<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session_id: &'life1 str, usage: &'life2 TokenUsage, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called after every successful LLM call with the actual usage reported by the provider. Lets the impl keep its running spend total in sync with reality.

fn check_before_tool<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session_id: &'life1 str, tool_name: &'life2 str, ) -> Pin<Box<dyn Future<Output = BudgetDecision> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called immediately before a tool invocation. The framework does not pass tool arguments — impls that need argument-aware caps must wrap the executor via a custom ToolExecutor.