joule-profiler-core 2.0.0

Core library for joule-profiler, handling orchestration and energy measurements
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

use crate::source::MetricSourceError;
use crate::source::types::SourceEvent;
use thiserror::Error;
use tokio::{sync::mpsc::error::SendError, task::JoinError};

/// Errors that can occur during orchestration.
#[derive(Debug, Error)]
pub enum OrchestratorError {
    /// Happens when an error occur while joining sources.
    #[error("Join error")]
    JoinError(
        #[from]
        #[source]
        JoinError,
    ),

    /// Returned when an error occur when sending an event to the sources channel.
    #[error("Send error")]
    SendError(
        #[from]
        #[source]
        SendError<SourceEvent>,
    ),

    /// Returned when an error occured while sending the initialization event.
    #[error("Cannot initialize source: {0}.")]
    InitializationError(&'static str),

    /// Phase count mismatch between two sensor sources during aggregation.
    #[error(
        "Cannot aggregate sensor results: phase count mismatch (lhs={lhs}, rhs={rhs}). \
        Sources must produce the same number of phases."
    )]
    PhaseMismatch { lhs: usize, rhs: usize },

    /// All sources returned zero phases.
    #[error("All sensor sources produced zero phases.")]
    AllSourcesEmpty,

    /// No results to merge.
    #[error("No sensor results to merge.")]
    NoSensorResults,

    /// An error thrown by a metric source.
    #[error("Metric source error.")]
    MetricSourceError(
        #[from]
        #[source]
        MetricSourceError,
    ),
}