bo4e-core 0.1.1

Core types for BO4E (Business Objects for Energy)
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! Consumed quantity (VerbrauchteQuantitaet) component.

use serde::{Deserialize, Serialize};

use crate::enums::Unit;
use crate::traits::{Bo4eMeta, Bo4eObject};

/// A consumed quantity with value and unit.
///
/// German: VerbrauchteQuantitaet
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::ConsumedQuantity;
/// use bo4e_core::enums::Unit;
///
/// let quantity = ConsumedQuantity {
///     value: Some(3500.0),
///     unit: Some(Unit::KilowattHour),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ConsumedQuantity {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// The quantity value (Wert)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<f64>,

    /// Unit of measurement (Einheit)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unit: Option<Unit>,
}

impl Bo4eObject for ConsumedQuantity {
    fn type_name_german() -> &'static str {
        "VerbrauchteQuantitaet"
    }

    fn type_name_english() -> &'static str {
        "ConsumedQuantity"
    }

    fn meta(&self) -> &Bo4eMeta {
        &self.meta
    }

    fn meta_mut(&mut self) -> &mut Bo4eMeta {
        &mut self.meta
    }
}

impl ConsumedQuantity {
    /// Create a quantity in kWh.
    pub fn kwh(value: f64) -> Self {
        Self {
            value: Some(value),
            unit: Some(Unit::KilowattHour),
            ..Default::default()
        }
    }

    /// Create a quantity in cubic meters.
    pub fn cubic_meters(value: f64) -> Self {
        Self {
            value: Some(value),
            unit: Some(Unit::CubicMeter),
            ..Default::default()
        }
    }
}

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

    #[test]
    fn test_kwh_quantity() {
        let quantity = ConsumedQuantity::kwh(3500.0);
        assert_eq!(quantity.value, Some(3500.0));
        assert_eq!(quantity.unit, Some(Unit::KilowattHour));
    }

    #[test]
    fn test_cubic_meters() {
        let quantity = ConsumedQuantity::cubic_meters(1250.0);
        assert_eq!(quantity.value, Some(1250.0));
        assert_eq!(quantity.unit, Some(Unit::CubicMeter));
    }

    #[test]
    fn test_default() {
        let quantity = ConsumedQuantity::default();
        assert!(quantity.value.is_none());
        assert!(quantity.unit.is_none());
    }

    #[test]
    fn test_roundtrip() {
        let quantity = ConsumedQuantity {
            value: Some(5678.9),
            unit: Some(Unit::KilowattHour),
            ..Default::default()
        };

        let json = serde_json::to_string(&quantity).unwrap();
        let parsed: ConsumedQuantity = serde_json::from_str(&json).unwrap();
        assert_eq!(quantity, parsed);
    }

    #[test]
    fn test_bo4e_object_impl() {
        assert_eq!(
            ConsumedQuantity::type_name_german(),
            "VerbrauchteQuantitaet"
        );
        assert_eq!(ConsumedQuantity::type_name_english(), "ConsumedQuantity");
    }
}