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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
//! RQI (Reflective QoS Indicator) Information Element
//!
//! The RQI IE indicates whether reflective QoS should be enabled for the QoS flow.
//! Per 3GPP TS 29.244 Section 8.2.88, this is a simple flag IE.
//!
//! Reflective QoS allows the UE to derive uplink QoS rules from downlink traffic,
//! simplifying QoS management in 5G networks.
use crate::error::PfcpError;
use crate::ie::{Ie, IeType};
/// RQI (Reflective QoS Indicator)
///
/// Indicates whether reflective QoS is enabled for a QoS flow in 5G networks.
///
/// # 3GPP Reference
/// 3GPP TS 29.244 Section 8.2.88
///
/// # Structure
/// - Bit 1 (LSB): RQI flag (0 = disabled, 1 = enabled)
/// - Bits 2-8: Spare (set to 0)
///
/// # Examples
///
/// ```
/// use rs_pfcp::ie::rqi::Rqi;
///
/// // Create RQI with reflective QoS enabled
/// let rqi = Rqi::enabled();
/// assert!(rqi.is_enabled());
///
/// // Create RQI with reflective QoS disabled
/// let rqi = Rqi::disabled();
/// assert!(!rqi.is_enabled());
///
/// // Marshal and unmarshal
/// let bytes = rqi.marshal();
/// let parsed = Rqi::unmarshal(&bytes).unwrap();
/// assert_eq!(rqi, parsed);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub struct Rqi {
/// Reflective QoS indicator flag
rqi: bool,
}
impl Rqi {
/// Create a new RQI IE
///
/// # Arguments
/// * `enabled` - true if reflective QoS is enabled, false otherwise
///
/// # Example
/// ```
/// use rs_pfcp::ie::rqi::Rqi;
///
/// let rqi = Rqi::new(true);
/// assert!(rqi.is_enabled());
/// ```
pub fn new(enabled: bool) -> Self {
Rqi { rqi: enabled }
}
/// Create RQI with reflective QoS enabled
///
/// # Example
/// ```
/// use rs_pfcp::ie::rqi::Rqi;
///
/// let rqi = Rqi::enabled();
/// assert!(rqi.is_enabled());
/// ```
pub fn enabled() -> Self {
Rqi { rqi: true }
}
/// Create RQI with reflective QoS disabled
///
/// # Example
/// ```
/// use rs_pfcp::ie::rqi::Rqi;
///
/// let rqi = Rqi::disabled();
/// assert!(!rqi.is_enabled());
/// ```
pub fn disabled() -> Self {
Rqi { rqi: false }
}
/// Check if reflective QoS is enabled
///
/// # Example
/// ```
/// use rs_pfcp::ie::rqi::Rqi;
///
/// let rqi = Rqi::enabled();
/// assert!(rqi.is_enabled());
///
/// let rqi = Rqi::disabled();
/// assert!(!rqi.is_enabled());
/// ```
pub fn is_enabled(&self) -> bool {
self.rqi
}
/// Marshal RQI to bytes
///
/// # Returns
/// 1-byte array with RQI flag in bit 1 (LSB)
pub fn marshal(&self) -> [u8; 1] {
let flags = if self.rqi { 0x01 } else { 0x00 };
[flags]
}
/// Unmarshal RQI from bytes
///
/// # Arguments
/// * `data` - Byte slice containing RQI data (must be at least 1 byte)
///
/// # Errors
/// Returns error if data is too short
///
/// # Example
/// ```
/// use rs_pfcp::ie::rqi::Rqi;
///
/// let rqi = Rqi::enabled();
/// let bytes = rqi.marshal();
/// let parsed = Rqi::unmarshal(&bytes).unwrap();
/// assert_eq!(rqi, parsed);
/// ```
pub fn unmarshal(data: &[u8]) -> Result<Self, PfcpError> {
if data.is_empty() {
return Err(PfcpError::invalid_length("RQI", IeType::Rqi, 1, 0));
}
// Extract bit 1 (LSB) per 3GPP TS 29.244 Section 8.2.88
Ok(Rqi {
rqi: (data[0] & 0x01) != 0,
})
}
/// Convert to generic IE
///
/// # Example
/// ```
/// use rs_pfcp::ie::rqi::Rqi;
/// use rs_pfcp::ie::IeType;
///
/// let rqi = Rqi::enabled();
/// let ie = rqi.to_ie();
/// assert_eq!(ie.ie_type, IeType::Rqi);
/// ```
pub fn to_ie(&self) -> Ie {
Ie::new(IeType::Rqi, self.marshal().to_vec())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_rqi_new() {
let rqi = Rqi::new(true);
assert!(rqi.is_enabled());
let rqi = Rqi::new(false);
assert!(!rqi.is_enabled());
}
#[test]
fn test_rqi_enabled() {
let rqi = Rqi::enabled();
assert!(rqi.is_enabled());
assert_eq!(rqi, Rqi::new(true));
}
#[test]
fn test_rqi_disabled() {
let rqi = Rqi::disabled();
assert!(!rqi.is_enabled());
assert_eq!(rqi, Rqi::new(false));
}
#[test]
fn test_rqi_marshal_enabled() {
let rqi = Rqi::enabled();
let bytes = rqi.marshal();
assert_eq!(bytes.len(), 1);
assert_eq!(bytes[0], 0x01);
}
#[test]
fn test_rqi_marshal_disabled() {
let rqi = Rqi::disabled();
let bytes = rqi.marshal();
assert_eq!(bytes.len(), 1);
assert_eq!(bytes[0], 0x00);
}
#[test]
fn test_rqi_unmarshal_enabled() {
let data = [0x01];
let rqi = Rqi::unmarshal(&data).unwrap();
assert!(rqi.is_enabled());
}
#[test]
fn test_rqi_unmarshal_disabled() {
let data = [0x00];
let rqi = Rqi::unmarshal(&data).unwrap();
assert!(!rqi.is_enabled());
}
#[test]
fn test_rqi_unmarshal_with_spare_bits() {
// Spare bits (b7-b2) should be ignored per 3GPP spec
let data = [0xFF]; // All bits set
let rqi = Rqi::unmarshal(&data).unwrap();
assert!(rqi.is_enabled()); // Only bit 1 matters
}
#[test]
fn test_rqi_unmarshal_empty() {
let data = [];
let result = Rqi::unmarshal(&data);
assert!(result.is_err());
let err = result.unwrap_err();
assert!(matches!(err, PfcpError::InvalidLength { .. }));
assert!(err.to_string().contains("RQI"));
assert!(err.to_string().contains("1"));
assert!(err.to_string().contains("0"));
}
#[test]
fn test_rqi_round_trip_enabled() {
let original = Rqi::enabled();
let marshaled = original.marshal();
let unmarshaled = Rqi::unmarshal(&marshaled).unwrap();
assert_eq!(original, unmarshaled);
}
#[test]
fn test_rqi_round_trip_disabled() {
let original = Rqi::disabled();
let marshaled = original.marshal();
let unmarshaled = Rqi::unmarshal(&marshaled).unwrap();
assert_eq!(original, unmarshaled);
}
#[test]
fn test_rqi_to_ie() {
let rqi = Rqi::enabled();
let ie = rqi.to_ie();
assert_eq!(ie.ie_type, IeType::Rqi);
assert_eq!(ie.payload.len(), 1);
assert_eq!(ie.payload[0], 0x01);
// Verify IE can be unmarshaled
let parsed = Rqi::unmarshal(&ie.payload).unwrap();
assert_eq!(rqi, parsed);
}
#[test]
fn test_rqi_default() {
let rqi = Rqi::default();
assert!(!rqi.is_enabled()); // Default is disabled
}
#[test]
fn test_rqi_clone() {
let rqi1 = Rqi::enabled();
let rqi2 = rqi1;
assert_eq!(rqi1, rqi2);
}
#[test]
fn test_rqi_5g_scenarios() {
// Scenario 1: Enable reflective QoS for a premium QoS flow
let rqi_premium = Rqi::enabled();
assert!(rqi_premium.is_enabled());
// Scenario 2: Disable reflective QoS for best-effort traffic
let rqi_best_effort = Rqi::disabled();
assert!(!rqi_best_effort.is_enabled());
// Scenario 3: Parse from network message
let network_data = [0x01];
let rqi_parsed = Rqi::unmarshal(&network_data).unwrap();
assert!(rqi_parsed.is_enabled());
}
}