alumet 0.8.0

Modular framework for hardware and software measurement (including energy consumption and more).
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

use super::Metric;

/// Specifies when a new metric registration is considered to be a duplicate
/// of an existing metric.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum DuplicateCriteria {
    /// If a metric with the same name already exists, that's a duplicate.
    Strict,
    /// If a metric with the exact same definition exists, ignore the new metric.
    /// If a metric with the same name but a **different** definition exists, that's a duplicate.
    ///
    /// # Different metrics
    /// Two metric definitions are deemed "different" if [`are_identical`] returns `false`.
    Different,
    /// If a metric with a compatible definition exists, ignore the new metric.
    /// If a metric with the same name but an **incompatible** definition exists, that's a duplicate.
    ///
    /// # Compatible metrics
    /// Two metric definitions are deemed "compatible" if [`are_compatible`] returns `true`.
    Incompatible,
}

/// What should we do when a duplicate is detected (according to a [`DuplicateCriteria`])?
#[derive(Clone, Debug)]
pub enum DuplicateReaction {
    /// Don't register the metric and return an error.
    Error,
    /// Generate a new, unique name for the metric by using the given `suffix`,
    /// and use that new name to register the metric.
    ///
    /// The first attempt is to use `"{name}_{suffix}"` as the new metric name.
    /// If a metric already exist with this name, `"{name}_{suffix}_2"` is tried,
    /// then `"{name}_{suffix}_3"`, and so on...
    Rename { suffix: String },
}

/// Checks whether two metric definitions are compatible.
///
/// # Compatible metrics
/// Two metric definitions are compatible if they have the same name, unit and value type.
/// The description is ignored.
///
/// # Transitivity
/// This relation is transitive: `are_compatible(a, b) == are_compatible(b, a)`
pub(super) fn are_compatible(m1: &Metric, m2: &Metric) -> bool {
    m1.name == m2.name && m1.unit == m2.unit && m1.value_type == m2.value_type
}

/// Checks whether two metric definitions are identical, that is, whether all their fields are equal.
///
/// # Transitivity
/// This relation is transitive: `are_identical(a, b) == are_identical(b, a)`
pub(super) fn are_identical(m1: &Metric, m2: &Metric) -> bool {
    are_compatible(m1, m2) && m1.description == m2.description
}

impl DuplicateCriteria {
    /// Applies the criteria: is `m1` a duplicate of `m2`?
    pub fn are_duplicate(self, m1: &Metric, m2: &Metric) -> bool {
        match self {
            DuplicateCriteria::Strict => m1.name == m2.name,
            DuplicateCriteria::Different => !are_identical(m1, m2),
            DuplicateCriteria::Incompatible => !are_compatible(m1, m2),
        }
    }
}