Struct soroban_env_host::cost_runner::VmMemReadRun

pub struct VmMemReadRun;

Trait Implementations

impl CostRunner for VmMemReadRun

const COST_TYPE: CostType = CostType::VmMemRead

The type of cost we’re measuring.

type SampleType = (Rc<Vm>, usize)

Data type of the sample running with.

fn run_iter(host: &Host, _iter: u64, sample: Self::SampleType)

Run a iteration of the CostRunner, called by run for 0..RUN_ITERATIONS.

const RUN_ITERATIONS: u64 = 100u64

Number of iterations to run, used to divide the resulting measured values. Defaults to 100 to average out the measurement noises for fast-running cases. If you find your measurements are finishing too slow, reduce this number.

fn run(host: &Host, samples: Vec<Self::SampleType>)

Run the CostRunner. This method is called under CPU-and-memory tracking machinery, so anything that happens during it will be considered part of the cost for running the HostMeasurement at the returned input. Will call run_iter with iter set to each number in 0..RUN_ITERATIONS.

fn get_total_input(host: &Host, _sample: &Self::SampleType) -> u64

Get the total input from this run. Default to asking the host. May be overridden if host is not actually involved in the actual run. However, if overridden, there is a risk of the computed input being diverged from the actual input from the host’s perspective. So use it carefully. This should be after the run, outside of the CPU-and-memory tracking machineary.