yab 0.2.0

Yet Another Benchmarking framework powered by `cachegrind`
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

//! Benchmark identifiers.

use std::{
    fmt,
    hash::{Hash, Hasher},
    panic::Location,
};

/// Benchmark identifier supplied to [`Bencher`](crate::Bencher) functions.
#[derive(Debug, Clone)]
pub struct BenchmarkId {
    pub(crate) name: String,
    pub(crate) location: &'static Location<'static>,
    pub(crate) args: Option<String>, // TODO: is this needed?
    pub(crate) capture: Option<&'static str>,
}

impl PartialEq for BenchmarkId {
    fn eq(&self, other: &Self) -> bool {
        self.name == other.name && self.args == other.args
    }
}

impl PartialEq<&str> for BenchmarkId {
    fn eq(&self, other: &&str) -> bool {
        if let Some(args) = &self.args {
            self.name.len() + 1 + args.len() == other.len()
                && other.starts_with(&self.name)
                && other.ends_with(args)
                && other.as_bytes()[self.name.len()] == b'/'
        } else {
            self.name == *other
        }
    }
}

impl Eq for BenchmarkId {}

impl Hash for BenchmarkId {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.name.hash(state);
        self.args.hash(state);
    }
}

impl fmt::Display for BenchmarkId {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(&self.name)?;
        if let Some(args) = &self.args {
            write!(formatter, "/{args}")?;
        }
        if let Some(capture) = self.capture {
            write!(formatter, "/{capture}")?;
        }
        Ok(())
    }
}

impl<S: Into<String>> From<S> for BenchmarkId {
    #[track_caller]
    fn from(name: S) -> Self {
        Self {
            name: name.into(),
            location: Location::caller(),
            args: None,
            capture: None,
        }
    }
}

impl BenchmarkId {
    /// Creates an ID consisting of the base function name, and an argument representation.
    #[track_caller]
    pub fn new(name: impl Into<String>, args: impl fmt::Display) -> Self {
        Self {
            name: name.into(),
            location: Location::caller(),
            args: Some(args.to_string()),
            capture: None,
        }
    }

    pub(crate) fn to_string_without_capture(&self) -> String {
        if self.capture.is_some() {
            let mut without_capture = self.clone();
            without_capture.capture = None;
            without_capture.to_string()
        } else {
            self.to_string()
        }
    }
}