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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

//! Reporting Suggestion Information Information Element.
//!
//! Per 3GPP TS 29.244 Section 8.2.229, contains an urgency level and optional
//! reporting time information for a reporting suggestion.

use crate::error::PfcpError;
use crate::ie::{Ie, IeType};

/// Reporting Suggestion Information per 3GPP TS 29.244 §8.2.229.
///
/// # Wire Format
/// - Byte 0: bits 1–4 = urgency level (mask 0x0F)
/// - Bytes 1–4 (optional): u32 reporting time info
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ReportingSuggestionInfo {
    /// Urgency level (lower 4 bits, 0–15).
    pub urgency: u8,
    /// Optional reporting time information.
    pub reporting_time_info: Option<u32>,
}

impl ReportingSuggestionInfo {
    pub fn new(urgency: u8, reporting_time_info: Option<u32>) -> Self {
        Self {
            urgency: urgency & 0x0F,
            reporting_time_info,
        }
    }

    pub fn marshal(&self) -> Vec<u8> {
        let mut data = vec![self.urgency & 0x0F];
        if let Some(t) = self.reporting_time_info {
            data.extend_from_slice(&t.to_be_bytes());
        }
        data
    }

    pub fn unmarshal(data: &[u8]) -> Result<Self, PfcpError> {
        if data.is_empty() {
            return Err(PfcpError::invalid_length(
                "Reporting Suggestion Information",
                IeType::ReportingSuggestionInfo,
                1,
                0,
            ));
        }
        let urgency = data[0] & 0x0F;
        let reporting_time_info = if data.len() >= 5 {
            Some(u32::from_be_bytes(data[1..5].try_into().unwrap()))
        } else {
            None
        };
        Ok(Self {
            urgency,
            reporting_time_info,
        })
    }

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

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

    #[test]
    fn test_marshal_unmarshal_with_time_info() {
        let ie = ReportingSuggestionInfo::new(3, Some(0xDEADBEEF));
        let parsed = ReportingSuggestionInfo::unmarshal(&ie.marshal()).unwrap();
        assert_eq!(parsed, ie);
    }

    #[test]
    fn test_marshal_unmarshal_without_time_info() {
        let ie = ReportingSuggestionInfo::new(7, None);
        let parsed = ReportingSuggestionInfo::unmarshal(&ie.marshal()).unwrap();
        assert_eq!(parsed, ie);
    }

    #[test]
    fn test_urgency_masks_high_bits() {
        // Urgency nibble masked to 0x0F on construction and on unmarshal
        let ie = ReportingSuggestionInfo::new(0xFF, None);
        assert_eq!(ie.urgency, 0x0F);
        let parsed = ReportingSuggestionInfo::unmarshal(&ie.marshal()).unwrap();
        assert_eq!(parsed.urgency, 0x0F);
    }

    #[test]
    fn test_marshal_byte_layout() {
        let ie = ReportingSuggestionInfo::new(5, Some(1));
        let data = ie.marshal();
        assert_eq!(data[0], 0x05);
        assert_eq!(data[1..5], [0x00, 0x00, 0x00, 0x01]);
    }

    #[test]
    fn test_unmarshal_empty() {
        assert!(matches!(
            ReportingSuggestionInfo::unmarshal(&[]),
            Err(PfcpError::InvalidLength { .. })
        ));
    }

    #[test]
    fn test_unmarshal_partial_time_info_ignored() {
        // Only 3 bytes total - reporting_time_info should be None
        let parsed = ReportingSuggestionInfo::unmarshal(&[0x02, 0x00, 0x01]).unwrap();
        assert_eq!(parsed.urgency, 2);
        assert_eq!(parsed.reporting_time_info, None);
    }

    #[test]
    fn test_to_ie() {
        let ie = ReportingSuggestionInfo::new(1, Some(100)).to_ie();
        assert_eq!(ie.ie_type, IeType::ReportingSuggestionInfo);
        assert_eq!(ie.payload.len(), 5);
    }
}