binggan 0.17.0

Benchmarking library for stable Rust
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

use std::any::Any;

use peakmem_alloc::PeakMemAllocTrait;

use crate::{
    bench_id::BenchId,
    plugins::{EventListener, PerBenchData, PluginEvents},
};

/// Plugin to track peak memory consumption.
pub struct PeakMemAllocPlugin {
    alloc_per_bench: PerBenchData<Vec<usize>>,
    alloc: &'static dyn PeakMemAllocTrait,
}
impl PeakMemAllocPlugin {
    /// Creates a new instance of `AllocPerBench`.
    /// The `alloc` parameter is the allocator that will be used to track memory consumption.
    ///
    pub fn new(alloc: &'static dyn PeakMemAllocTrait) -> Self {
        Self {
            alloc_per_bench: PerBenchData::new(),
            alloc,
        }
    }
    /// Returns the peak memory consumptions for each group run for the given bench id.
    pub fn get_by_bench_id(&self, bench_id: &BenchId) -> Option<&Vec<usize>> {
        self.alloc_per_bench.get(bench_id)
    }
}

/// The plugin name for PeakAllocPlugin.
pub static ALLOC_EVENT_LISTENER_NAME: &str = "_binggan_alloc";

impl EventListener for PeakMemAllocPlugin {
    fn prio(&self) -> u32 {
        u32::MAX - 2
    }

    fn as_any(&mut self) -> &mut dyn Any {
        self
    }
    fn name(&self) -> &'static str {
        ALLOC_EVENT_LISTENER_NAME
    }
    fn on_event(&mut self, event: PluginEvents) {
        match event {
            PluginEvents::BenchStart { bench_id } => {
                self.alloc_per_bench.insert_if_absent(bench_id, Vec::new);
                self.alloc.reset_peak_memory();
            }
            PluginEvents::BenchStop { bench_id, .. } => {
                let perf = self.alloc_per_bench.get_mut(bench_id).unwrap();
                perf.push(self.alloc.get_peak_memory());
            }
            _ => {}
        }
    }
}