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

// src/ie/gate_status.rs

//! Gate Status Information Element.

use crate::error::PfcpError;
use crate::ie::IeType;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum GateStatusValue {
    Open,
    Closed,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct GateStatus {
    pub downlink_gate: GateStatusValue,
    pub uplink_gate: GateStatusValue,
}

impl GateStatus {
    pub fn new(downlink_gate: GateStatusValue, uplink_gate: GateStatusValue) -> Self {
        GateStatus {
            downlink_gate,
            uplink_gate,
        }
    }

    pub fn marshal(&self) -> [u8; 1] {
        let mut value = 0;
        if let GateStatusValue::Closed = self.downlink_gate {
            value |= 0b01;
        }
        if let GateStatusValue::Closed = self.uplink_gate {
            value |= 0b10;
        }
        [value]
    }

    pub fn unmarshal(data: &[u8]) -> Result<Self, PfcpError> {
        if data.is_empty() {
            return Err(PfcpError::invalid_length(
                "Gate Status",
                IeType::GateStatus,
                1,
                0,
            ));
        }
        let downlink_gate = if (data[0] & 0b01) == 0b01 {
            GateStatusValue::Closed
        } else {
            GateStatusValue::Open
        };
        let uplink_gate = if (data[0] & 0b10) == 0b10 {
            GateStatusValue::Closed
        } else {
            GateStatusValue::Open
        };
        Ok(GateStatus {
            downlink_gate,
            uplink_gate,
        })
    }
}

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

    #[test]
    fn test_gate_status_marshal_unmarshal() {
        let gs = GateStatus::new(GateStatusValue::Closed, GateStatusValue::Open);
        let marshaled = gs.marshal();
        assert_eq!(marshaled, [0b01]);
        let unmarshaled = GateStatus::unmarshal(&marshaled).unwrap();
        assert_eq!(unmarshaled, gs);

        let gs = GateStatus::new(GateStatusValue::Open, GateStatusValue::Closed);
        let marshaled = gs.marshal();
        assert_eq!(marshaled, [0b10]);
        let unmarshaled = GateStatus::unmarshal(&marshaled).unwrap();
        assert_eq!(unmarshaled, gs);

        let gs = GateStatus::new(GateStatusValue::Closed, GateStatusValue::Closed);
        let marshaled = gs.marshal();
        assert_eq!(marshaled, [0b11]);
        let unmarshaled = GateStatus::unmarshal(&marshaled).unwrap();
        assert_eq!(unmarshaled, gs);

        let gs = GateStatus::new(GateStatusValue::Open, GateStatusValue::Open);
        let marshaled = gs.marshal();
        assert_eq!(marshaled, [0b00]);
        let unmarshaled = GateStatus::unmarshal(&marshaled).unwrap();
        assert_eq!(unmarshaled, gs);
    }

    #[test]
    fn test_gate_status_unmarshal_invalid_data() {
        let data = [];
        let result = GateStatus::unmarshal(&data);
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(matches!(err, PfcpError::InvalidLength { .. }));
        if let PfcpError::InvalidLength {
            ie_name,
            ie_type,
            expected,
            actual,
        } = err
        {
            assert_eq!(ie_name, "Gate Status");
            assert_eq!(ie_type, IeType::GateStatus);
            assert_eq!(expected, 1);
            assert_eq!(actual, 0);
        }
    }
}