river-data-core 0.11.2

Client, sync runner, and shared types for the river-data platform
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

use serde::{Deserialize, Serialize};

/// The cadence vocabulary a reading is classified under. The wire fields stay strings, so a
/// producer names a value through this rather than spelling the literal and a consumer refuses
/// what it does not recognise instead of falling through to the default.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MeasurementType {
    Continuous,
    Spot,
    Derived,
}

impl MeasurementType {
    pub const ALL: &[MeasurementType] = &[Self::Continuous, Self::Spot, Self::Derived];

    pub const fn as_str(&self) -> &'static str {
        match self {
            Self::Continuous => "continuous",
            Self::Spot => "spot",
            Self::Derived => "derived",
        }
    }

    pub fn from_str(s: &str) -> Option<Self> {
        Self::ALL.iter().find(|v| v.as_str() == s).copied()
    }
}

impl std::fmt::Display for MeasurementType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_measurement_type_round_trips_every_member() {
        for v in MeasurementType::ALL {
            assert_eq!(MeasurementType::from_str(v.as_str()), Some(*v));
        }
    }

    #[test]
    fn test_measurement_type_refuses_what_it_does_not_know() {
        // The typo the classification chain would otherwise resolve to its default.
        assert_eq!(MeasurementType::from_str("spott"), None);
        assert_eq!(MeasurementType::from_str("Spot"), None);
        assert_eq!(MeasurementType::from_str(""), None);
    }

    #[test]
    fn test_measurement_type_serialises_as_the_stored_string() {
        assert_eq!(
            serde_json::to_value(MeasurementType::Continuous).unwrap(),
            serde_json::json!("continuous")
        );
        assert_eq!(MeasurementType::Spot.to_string(), "spot");
    }
}