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

//! Position surcharge (PositionsAufAbschlag) component.

use serde::{Deserialize, Serialize};

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

/// A surcharge or discount applied to a specific position.
///
/// German: PositionsAufAbschlag
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::PositionSurcharge;
///
/// let surcharge = PositionSurcharge {
///     description: Some("Sonderrabatt".to_string()),
///     value: Some(-10.0),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PositionSurcharge {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Description (Bezeichnung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Type of surcharge (AufAbschlagstyp)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub surcharge_type: Option<SurchargeType>,

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

    /// Currency (Waehrung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<Currency>,
}

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

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

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

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

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

    #[test]
    fn test_position_surcharge() {
        let surcharge = PositionSurcharge {
            description: Some("Position discount".to_string()),
            surcharge_type: Some(SurchargeType::Absolute),
            value: Some(-5.0),
            currency: Some(Currency::Eur),
            ..Default::default()
        };

        assert_eq!(surcharge.value, Some(-5.0));
    }

    #[test]
    fn test_percentage_surcharge() {
        let surcharge = PositionSurcharge {
            description: Some("10% markup".to_string()),
            surcharge_type: Some(SurchargeType::Relative),
            value: Some(10.0),
            ..Default::default()
        };

        assert_eq!(surcharge.surcharge_type, Some(SurchargeType::Relative));
    }

    #[test]
    fn test_default() {
        let surcharge = PositionSurcharge::default();
        assert!(surcharge.description.is_none());
        assert!(surcharge.value.is_none());
    }

    #[test]
    fn test_roundtrip() {
        let surcharge = PositionSurcharge {
            description: Some("Test surcharge".to_string()),
            surcharge_type: Some(SurchargeType::Absolute),
            value: Some(15.50),
            currency: Some(Currency::Eur),
            ..Default::default()
        };

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

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