Struct RunMeta 

pub struct RunMeta { /* private fields */ }

Informs a benchmark run callback about the basic metadata associated with the run.

This type is passed to various callback functions during benchmark execution, providing information about the current thread group, total number of groups, and iteration count. This allows callbacks to behave differently based on their context within the benchmark run.

Examples

use many_cpus::ProcessorSet;
use par_bench::{Run, ThreadPool};
use new_zealand::nz;

let mut pool = ThreadPool::new(&processors);

let run = Run::new()
    .groups(nz!(2)) // 2 groups of 2 threads each
    .prepare_thread(|args| {
        println!("Thread in group {} of {}",
                 args.meta().group_index(),
                 args.meta().group_count());
        println!("Will execute {} iterations", args.meta().iterations());
         
        // Return different state based on group
        if args.meta().group_index() == 0 {
            "reader_thread"
        } else {
            "writer_thread"
        }
    })
    .prepare_iter(|args| *args.thread_state())
    .iter(|mut args| {
        let thread_type = args.take_iter_state();
        match thread_type {
            "reader_thread" => { /* reader work */ },
            "writer_thread" => { /* writer work */ },
            _ => unreachable!(),
        }
    });

let _results = run.execute_on(&mut pool, 100);

Implementations

impl RunMeta

pub fn group_index(&self) -> usize

The index of the current thread group, starting from 0.

pub fn group_count(&self) -> NonZero<usize>

The total number of thread groups in the run.

pub fn thread_count(&self) -> NonZero<usize>

The total number of threads used to execute the run.

pub fn iterations(&self) -> u64

How many iterations will be executed as part of this run.

Trait Implementations

impl Clone for RunMeta

fn clone(&self) -> RunMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunMeta

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

Formats the value using the given formatter.

impl PartialEq for RunMeta

fn eq(&self, other: &RunMeta) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RunMeta

impl Eq for RunMeta

impl StructuralPartialEq for RunMeta