Struct Budget

pub struct Budget(/* private fields */);

Available on crate feature testutils only.

Budget that tracks the resources consumed for the environment.

The budget consistents of two cost dimensions:

• CPU instructions
• Memory

Inputs feed into those cost dimensions.

Note that all cost dimensions – CPU instructions, memory – and the VM cost type inputs are likely to be underestimated when running Rust code compared to running the WASM equivalent.

Examples

use soroban_sdk::{Env, Symbol};

env.cost_estimate().budget().reset_default();
// ...
println!("{}", env.cost_estimate().budget());

Implementations

impl Budget

pub fn reset_default(&mut self)

Reset the budget.

pub fn reset_unlimited(&mut self)

pub fn reset_limits(&mut self, cpu: u64, mem: u64)

pub fn reset_tracker(&mut self)

pub fn cpu_instruction_cost(&self) -> u64

Returns the CPU instruction cost.

Note that CPU instructions are likely to be underestimated when running Rust code compared to running the WASM equivalent.

pub fn memory_bytes_cost(&self) -> u64

Returns the memory cost.

Note that memory is likely to be underestimated when running Rust code compared to running the WASM equivalent.

pub fn tracker(&self, cost_type: ContractCostType) -> CostTracker

Get the cost tracker associated with the cost type. The tracker tracks the cumulative iterations and inputs and derived cpu and memory. If the underlying model is a constant model, then inputs is None and only iterations matter.

Note that VM cost types are likely to be underestimated when running natively as Rust code inside tests code compared to running the WASM equivalent.

pub fn print(&self)

Print the budget costs and inputs to stdout.

Trait Implementations

impl Debug for Budget

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

Formats the value using the given formatter.

impl Display for Budget

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

Formats the value using the given formatter.