Struct BenchSpec 

pub struct BenchSpec {
    pub name: String,
    pub iterations: u32,
    pub warmup: u32,
}

Benchmark specification defining what and how to benchmark.

Contains the benchmark name, number of measurement iterations, and warmup iterations to perform before measuring.

Example

use mobench_sdk::timing::BenchSpec;

// Create a spec for 100 iterations with 10 warmup runs
let spec = BenchSpec::new("sorting_benchmark", 100, 10)?;

assert_eq!(spec.name, "sorting_benchmark");
assert_eq!(spec.iterations, 100);
assert_eq!(spec.warmup, 10);

Serialization

BenchSpec implements Serialize and Deserialize for JSON persistence:

use mobench_sdk::timing::BenchSpec;

let spec = BenchSpec {
    name: "my_bench".to_string(),
    iterations: 50,
    warmup: 5,
};

let json = serde_json::to_string(&spec)?;
let restored: BenchSpec = serde_json::from_str(&json)?;

assert_eq!(spec.name, restored.name);

Fields

name: String

Name of the benchmark, typically the fully-qualified function name.

Examples: "my_crate::fibonacci", "sorting_benchmark"

iterations: u32

Number of iterations to measure.

Each iteration produces one BenchSample. Must be greater than zero.

warmup: u32

Number of warmup iterations before measurement.

Warmup iterations are not recorded. They allow CPU caches to warm and any JIT compilation to complete. Can be zero.

Implementations

impl BenchSpec

pub fn new( name: impl Into<String>, iterations: u32, warmup: u32, ) -> Result<Self, TimingError>

Creates a new benchmark specification.

Arguments

• name - Name identifier for the benchmark
• iterations - Number of measured iterations (must be > 0)
• warmup - Number of warmup iterations (can be 0)

Errors

Returns TimingError::NoIterations if iterations is zero.

Example

use mobench_sdk::timing::BenchSpec;

let spec = BenchSpec::new("test", 100, 10)?;
assert_eq!(spec.iterations, 100);

// Zero iterations is an error
let err = BenchSpec::new("test", 0, 10);
assert!(err.is_err());

pub fn validate(&self) -> Result<(), TimingError>

Validate the iteration counts on a specification built with public fields.

Trait Implementations

impl Clone for BenchSpec

fn clone(&self) -> BenchSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BenchSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BenchSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BenchSpec> for BenchSpecTemplate

fn from(spec: BenchSpec) -> Self

Converts to this type from the input type.

impl From<BenchSpec> for BenchSpecFfi

fn from(spec: BenchSpec) -> Self

Converts to this type from the input type.

impl From<BenchSpecFfi> for BenchSpec

fn from(spec: BenchSpecFfi) -> Self

Converts to this type from the input type.

impl From<BenchSpecTemplate> for BenchSpec

fn from(spec: BenchSpecTemplate) -> Self

Converts to this type from the input type.

impl Serialize for BenchSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.