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

use crate::metrics::{
    def::{Metric, RawMetricId},
    registry::MetricRegistry,
};

use super::Transform;

/// Trait for transform builders.
///
///  # Example
/// ```
/// use alumet::pipeline::elements::transform::builder::{TransformBuilder, TransformBuildContext};
/// use alumet::pipeline::Transform;
///
/// fn build_my_transform() -> anyhow::Result<Box<dyn Transform>> {
///     todo!("build a new transform")
/// }
///
/// let builder: &dyn TransformBuilder = &|ctx: &mut dyn TransformBuildContext| {
///     let transform = build_my_transform()?;
///     Ok(transform)
/// };
/// ```
pub trait TransformBuilder: FnOnce(&mut dyn TransformBuildContext) -> anyhow::Result<Box<dyn Transform>> {}
impl<F> TransformBuilder for F where F: FnOnce(&mut dyn TransformBuildContext) -> anyhow::Result<Box<dyn Transform>> {}

pub(super) struct BuildContext<'a> {
    pub(super) metrics: &'a MetricRegistry,
}

/// Context accessible when building a transform.
pub trait TransformBuildContext {
    /// Retrieves a metric by its name.
    fn metric_by_name(&self, name: &str) -> Option<(RawMetricId, &Metric)>;
}

impl TransformBuildContext for BuildContext<'_> {
    fn metric_by_name(&self, name: &str) -> Option<(RawMetricId, &Metric)> {
        self.metrics.by_name(name)
    }
}