Struct soroban_sdk::testutils::budget::Budget

pub struct Budget(_);

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.budget().reset();
// ...
println!("{}", env.budget());

Implementations

impl Budget

pub fn reset(&mut self)

Reset the budget.

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 input(&self, cost_type: CostType) -> u64

Get inputs that have led to the cost.

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

pub fn print(&self)

Print the budget costs and inputs to stdout.

Trait Implementations

impl Display for Budget

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

Formats the value using the given formatter.