gungraun 0.18.0

High-precision, one-shot and consistent benchmarking framework/harness for Rust. All Valgrind tools at your fingertips.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

use crate::ValgrindTool;

type MacroLibBenches<'a> = &'a [&'a (
    &'static str,
    fn() -> Option<crate::__internal::InternalLibraryBenchmarkConfig>,
    &'a [crate::__internal::InternalMacroLibBench],
)];

#[derive(Debug)]
pub struct GroupsBuilder(crate::__internal::InternalLibraryBenchmarkGroups);

impl GroupsBuilder {
    #[cfg(feature = "cachegrind")]
    pub fn new(
        config: Option<crate::__internal::InternalLibraryBenchmarkConfig>,
        args: Vec<String>,
        has_setup: bool,
        has_teardown: bool,
    ) -> Self {
        Self(crate::__internal::InternalLibraryBenchmarkGroups {
            config: config.unwrap_or_default(),
            groups: Vec::default(),
            command_line_args: args,
            has_setup,
            has_teardown,
            default_tool: ValgrindTool::Cachegrind,
        })
    }

    #[cfg(not(feature = "cachegrind"))]
    pub fn new(
        config: Option<crate::__internal::InternalLibraryBenchmarkConfig>,
        args: Vec<String>,
        has_setup: bool,
        has_teardown: bool,
    ) -> Self {
        Self(crate::__internal::InternalLibraryBenchmarkGroups {
            config: config.unwrap_or_default(),
            groups: Vec::default(),
            command_line_args: args,
            has_setup,
            has_teardown,
            default_tool: ValgrindTool::Callgrind,
        })
    }

    pub fn add_group(
        &mut self,
        id: String,
        config: Option<crate::__internal::InternalLibraryBenchmarkConfig>,
        compare_by_id: Option<bool>,
        max_parallel: Option<usize>,
        has_setup: bool,
        has_teardown: bool,
        benches: MacroLibBenches,
    ) {
        let mut internal_group = crate::__internal::InternalLibraryBenchmarkGroup {
            id,
            config,
            has_setup,
            has_teardown,
            compare_by_id,
            max_parallel,
            ..Default::default()
        };

        for (function_name, get_config, macro_lib_benches) in benches {
            let mut benches = crate::__internal::InternalLibraryBenchmarkBenches {
                benches: vec![],
                config: get_config(),
            };
            for macro_lib_bench in *macro_lib_benches {
                let bench = crate::__internal::InternalLibraryBenchmarkBench {
                    id: macro_lib_bench.id_display.map(ToString::to_string),
                    args: macro_lib_bench.args_display.map(ToString::to_string),
                    consts_display: macro_lib_bench.consts_display.map(ToString::to_string),
                    function_name: (*function_name).to_owned(),
                    config: macro_lib_bench.config.map(|f| f()),
                    iter_count: match macro_lib_bench.func {
                        super::InternalLibFunctionKind::Iter(func) => Some(func(None)),
                        super::InternalLibFunctionKind::Default(_) => None,
                    },
                };
                benches.benches.push(bench);
            }
            internal_group.library_benchmarks.push(benches);
        }

        self.0.groups.push(internal_group);
    }

    pub fn build(self) -> crate::__internal::InternalLibraryBenchmarkGroups {
        self.0
    }
}