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
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
93
94
95
96
97
98
99

use tokio::sync::oneshot;

use crate::pipeline::{
    control::{matching::OutputMatcher, messages},
    elements::output::control::{ConfigureMessage, ControlMessage, TaskState},
};

use super::DirectResponseReceiver;

pub struct OutputRequestBuilder {
    matcher: OutputMatcher,
}

#[derive(Debug)]
pub struct OutputRequest {
    msg: ControlMessage,
}

/// Returns a builder that allows to build a request for controlling outputs.
pub fn output(matcher: impl Into<OutputMatcher>) -> OutputRequestBuilder {
    OutputRequestBuilder {
        matcher: matcher.into(),
    }
}

pub enum RemainingDataStrategy {
    Write,
    Ignore,
}

impl OutputRequestBuilder {
    pub fn enable(self) -> OutputRequest {
        OutputRequest {
            msg: ControlMessage::Configure(ConfigureMessage {
                matcher: self.matcher,
                new_state: TaskState::Run,
            }),
        }
    }

    /// Enables the output and discards any pending data.
    pub fn enable_discard(self) -> OutputRequest {
        OutputRequest {
            msg: ControlMessage::Configure(ConfigureMessage {
                matcher: self.matcher,
                new_state: TaskState::RunDiscard,
            }),
        }
    }

    pub fn disable(self) -> OutputRequest {
        OutputRequest {
            msg: ControlMessage::Configure(ConfigureMessage {
                matcher: self.matcher,
                new_state: TaskState::Pause,
            }),
        }
    }

    pub fn stop(self, remaining_strategy: RemainingDataStrategy) -> OutputRequest {
        let new_state = match remaining_strategy {
            RemainingDataStrategy::Write => TaskState::StopFinish,
            RemainingDataStrategy::Ignore => TaskState::StopNow,
        };
        OutputRequest {
            msg: ControlMessage::Configure(ConfigureMessage {
                matcher: self.matcher,
                new_state,
            }),
        }
    }
}

impl OutputRequest {
    fn into_body(self) -> messages::EmptyResponseBody {
        messages::EmptyResponseBody::Single(messages::SpecificBody::Output(self.msg))
    }
}

impl super::AnonymousControlRequest for OutputRequest {
    type OkResponse = ();
    type Receiver = DirectResponseReceiver<()>;

    fn serialize(self) -> messages::ControlRequest {
        messages::ControlRequest::NoResult(messages::RequestMessage {
            response_tx: None,
            body: self.into_body(),
        })
    }

    fn serialize_with_response(self) -> (messages::ControlRequest, Self::Receiver) {
        let (tx, rx) = oneshot::channel();
        let req = messages::ControlRequest::NoResult(messages::RequestMessage {
            response_tx: Some(tx),
            body: self.into_body(),
        });
        (req, DirectResponseReceiver(rx))
    }
}