phoxal 0.67.0

Phoxal - production-oriented autonomous robot framework: the one framework library, holding the runtime engine, the api contract tree, the typed bus, the canonical model, and the bundle.
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

crate::endpoints! {
    state: State<State>;
}

#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
#[serde(try_from = "StateWire")]
pub struct State {
    pub voltage_v: f32,
    pub current_a: f32,
    pub charge_ratio: f32,
}
#[derive(serde::Deserialize)]
struct StateWire {
    voltage_v: f32,
    current_a: f32,
    charge_ratio: f32,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct InvalidState(&'static str);
impl std::fmt::Display for InvalidState {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.0)
    }
}
impl std::error::Error for InvalidState {}
impl State {
    pub fn try_new(
        voltage_v: f32,
        current_a: f32,
        charge_ratio: f32,
    ) -> Result<Self, InvalidState> {
        if !(voltage_v.is_finite()
            && voltage_v >= 0.0
            && current_a.is_finite()
            && charge_ratio.is_finite()
            && (0.0..=1.0).contains(&charge_ratio))
        {
            return Err(InvalidState(
                "battery voltage must be nonnegative and all values finite with charge in [0, 1]",
            ));
        }
        Ok(Self {
            voltage_v,
            current_a,
            charge_ratio,
        })
    }
}
impl TryFrom<StateWire> for State {
    type Error = InvalidState;
    fn try_from(v: StateWire) -> Result<Self, Self::Error> {
        Self::try_new(v.voltage_v, v.current_a, v.charge_ratio)
    }
}
#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn constructor_bounds_charge_and_voltage() {
        assert!(State::try_new(-1.0, 0.0, 0.5).is_err());
        assert!(State::try_new(1.0, 0.0, 1.01).is_err());
    }
}