bo4e-core 0.2.0

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

//! Amount (Betrag) component.

use serde::{Deserialize, Serialize};

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

/// A monetary amount with currency.
///
/// German: Betrag
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::Amount;
/// use bo4e_core::enums::Currency;
///
/// let amount = Amount {
///     value: Some(100.50),
///     currency: Some(Currency::Eur),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "json-schema", schemars(rename = "Betrag"))]
#[serde(rename_all = "camelCase")]
pub struct Amount {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// The amount value (Wert)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "wert"))]
    pub value: Option<f64>,

    /// Currency (Waehrung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "waehrung"))]
    pub currency: Option<Currency>,
}

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

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

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

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

impl Amount {
    /// Create an amount in EUR.
    pub fn eur(value: f64) -> Self {
        Self {
            value: Some(value),
            currency: Some(Currency::Eur),
            ..Default::default()
        }
    }
}

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

    #[test]
    fn test_eur_amount() {
        let amount = Amount::eur(100.50);
        assert_eq!(amount.value, Some(100.50));
        assert_eq!(amount.currency, Some(Currency::Eur));
    }

    #[test]
    fn test_default() {
        let amount = Amount::default();
        assert!(amount.value.is_none());
        assert!(amount.currency.is_none());
    }

    #[test]
    fn test_serialize() {
        let amount = Amount::eur(250.75);
        let json = serde_json::to_string(&amount).unwrap();
        assert!(json.contains(r#""value":250.75"#));
        assert!(json.contains(r#""currency":"EUR""#));
    }

    #[test]
    fn test_roundtrip() {
        let amount = Amount::eur(999.99);
        let json = serde_json::to_string(&amount).unwrap();
        let parsed: Amount = serde_json::from_str(&json).unwrap();
        assert_eq!(amount, parsed);
    }

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