rs-pfcp 0.4.0

High-performance Rust implementation of PFCP (Packet Forwarding Control Protocol) for 5G networks with 100% 3GPP TS 29.244 Release 18 compliance
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

//! Aggregated URRs Information Element.
//!
//! Per 3GPP TS 29.244 Section 7.5.2.4-2, groups an Aggregated URR ID with
//! a Multiplier for aggregated usage reporting across multiple URRs.

use crate::error::PfcpError;
use crate::ie::aggregated_urr_id::AggregatedUrrId;
use crate::ie::multiplier::Multiplier;
use crate::ie::{marshal_ies, Ie, IeIterator, IeType};

/// Aggregated URRs per 3GPP TS 29.244 ยง7.5.2.4-2.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AggregatedUrrs {
    /// Aggregated URR ID (mandatory).
    pub aggregated_urr_id: AggregatedUrrId,
    /// Multiplier applied to the aggregated URR volumes (mandatory).
    pub multiplier: Multiplier,
}

impl AggregatedUrrs {
    pub fn new(aggregated_urr_id: AggregatedUrrId, multiplier: Multiplier) -> Self {
        AggregatedUrrs {
            aggregated_urr_id,
            multiplier,
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        marshal_ies(&[self.aggregated_urr_id.to_ie(), self.multiplier.to_ie()])
    }

    pub fn unmarshal(payload: &[u8]) -> Result<Self, PfcpError> {
        let mut aggregated_urr_id = None;
        let mut multiplier = None;

        for ie_result in IeIterator::new(payload) {
            let ie = ie_result?;
            match ie.ie_type {
                IeType::AggregatedUrrId => {
                    aggregated_urr_id = Some(AggregatedUrrId::unmarshal(&ie.payload)?);
                }
                IeType::Multiplier => {
                    multiplier = Some(Multiplier::unmarshal(&ie.payload)?);
                }
                _ => (),
            }
        }

        Ok(AggregatedUrrs {
            aggregated_urr_id: aggregated_urr_id.ok_or_else(|| {
                PfcpError::missing_ie_in_grouped(IeType::AggregatedUrrId, IeType::AggregatedUrrs)
            })?,
            multiplier: multiplier.ok_or_else(|| {
                PfcpError::missing_ie_in_grouped(IeType::Multiplier, IeType::AggregatedUrrs)
            })?,
        })
    }

    pub fn to_ie(&self) -> Ie {
        Ie::new(IeType::AggregatedUrrs, self.marshal())
    }
}

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

    fn make_ie() -> AggregatedUrrs {
        AggregatedUrrs::new(AggregatedUrrId::new(10), Multiplier::new(2))
    }

    #[test]
    fn test_marshal_unmarshal_round_trip() {
        let ie = make_ie();
        let parsed = AggregatedUrrs::unmarshal(&ie.marshal()).unwrap();
        assert_eq!(parsed, ie);
    }

    #[test]
    fn test_missing_aggregated_urr_id() {
        let ie = AggregatedUrrs::new(AggregatedUrrId::new(1), Multiplier::new(1));
        let payload = marshal_ies(&[ie.multiplier.to_ie()]);
        assert!(matches!(
            AggregatedUrrs::unmarshal(&payload),
            Err(PfcpError::MissingMandatoryIe { .. })
        ));
    }

    #[test]
    fn test_missing_multiplier() {
        let ie = make_ie();
        let payload = marshal_ies(&[ie.aggregated_urr_id.to_ie()]);
        assert!(matches!(
            AggregatedUrrs::unmarshal(&payload),
            Err(PfcpError::MissingMandatoryIe { .. })
        ));
    }

    #[test]
    fn test_to_ie() {
        let ie = make_ie().to_ie();
        assert_eq!(ie.ie_type, IeType::AggregatedUrrs);
        assert!(!ie.payload.is_empty());
    }
}