dvb_si/descriptors/
private_data_specifier.rs

1//! Private Data Specifier Descriptor — ETSI EN 300 468 §6.2.31 (tag 0x5F).
2//!
3//! Table 85 (PDF p. 98). A single 32-bit `private_data_specifier` value
4//! (registered in EN 300 468 Annex/TR 101 162) that scopes the interpretation
5//! of any subsequent private (user-defined) descriptors in the same loop.
6
7use crate::error::{Error, Result};
8use crate::traits::Descriptor;
9use dvb_common::{Parse, Serialize};
10
11/// Descriptor tag for private_data_specifier_descriptor.
12pub const TAG: u8 = 0x5F;
13const HEADER_LEN: usize = 2;
14/// Fixed payload length: a single 32-bit specifier (EN 300 468 Table 85).
15const BODY_LEN: u8 = 4;
16
17/// Private Data Specifier Descriptor (tag 0x5F).
18#[derive(Debug, Clone, PartialEq, Eq)]
19#[cfg_attr(feature = "serde", derive(serde::Serialize))]
20pub struct PrivateDataSpecifierDescriptor {
21    /// 32-bit registered private_data_specifier (ETSI Table 85, PDF p. 98).
22    pub private_data_specifier: u32,
23}
24
25impl<'a> Parse<'a> for PrivateDataSpecifierDescriptor {
26    type Error = crate::error::Error;
27    fn parse(bytes: &'a [u8]) -> Result<Self> {
28        if bytes.len() < HEADER_LEN {
29            return Err(Error::BufferTooShort {
30                need: HEADER_LEN,
31                have: bytes.len(),
32                what: "PrivateDataSpecifierDescriptor header",
33            });
34        }
35        if bytes[0] != TAG {
36            return Err(Error::InvalidDescriptor {
37                tag: bytes[0],
38                reason: "unexpected tag for private_data_specifier_descriptor",
39            });
40        }
41        let length = bytes[1] as usize;
42        let total = HEADER_LEN + length;
43        if bytes.len() < total {
44            return Err(Error::BufferTooShort {
45                need: total,
46                have: bytes.len(),
47                what: "PrivateDataSpecifierDescriptor body",
48            });
49        }
50        if length != BODY_LEN as usize {
51            return Err(Error::InvalidDescriptor {
52                tag: TAG,
53                reason: "private_data_specifier_descriptor length must equal 4",
54            });
55        }
56        let private_data_specifier = u32::from_be_bytes([
57            bytes[HEADER_LEN],
58            bytes[HEADER_LEN + 1],
59            bytes[HEADER_LEN + 2],
60            bytes[HEADER_LEN + 3],
61        ]);
62        Ok(Self {
63            private_data_specifier,
64        })
65    }
66}
67
68impl Serialize for PrivateDataSpecifierDescriptor {
69    type Error = crate::error::Error;
70    fn serialized_len(&self) -> usize {
71        HEADER_LEN + BODY_LEN as usize
72    }
73
74    fn serialize_into(&self, buf: &mut [u8]) -> Result<usize> {
75        let len = self.serialized_len();
76        if buf.len() < len {
77            return Err(Error::OutputBufferTooSmall {
78                need: len,
79                have: buf.len(),
80            });
81        }
82        buf[0] = TAG;
83        buf[1] = BODY_LEN;
84        buf[HEADER_LEN..HEADER_LEN + 4].copy_from_slice(&self.private_data_specifier.to_be_bytes());
85        Ok(len)
86    }
87}
88
89impl<'a> Descriptor<'a> for PrivateDataSpecifierDescriptor {
90    const TAG: u8 = TAG;
91    fn descriptor_length(&self) -> u8 {
92        BODY_LEN
93    }
94}
95
96impl<'a> crate::traits::DescriptorDef<'a> for PrivateDataSpecifierDescriptor {
97    const TAG: u8 = TAG;
98    const NAME: &'static str = "PRIVATE_DATA_SPECIFIER";
99}
100
101#[cfg(test)]
102mod tests {
103    use super::*;
104
105    #[test]
106    fn parse_extracts_specifier() {
107        let bytes = [TAG, 4, 0x00, 0x00, 0x00, 0x28];
108        let d = PrivateDataSpecifierDescriptor::parse(&bytes).unwrap();
109        assert_eq!(d.private_data_specifier, 0x0000_0028);
110    }
111
112    #[test]
113    fn parse_rejects_wrong_tag() {
114        let err = PrivateDataSpecifierDescriptor::parse(&[0x60, 4, 0, 0, 0, 0]).unwrap_err();
115        assert!(matches!(err, Error::InvalidDescriptor { tag: 0x60, .. }));
116    }
117
118    #[test]
119    fn parse_rejects_short_buffer() {
120        let err = PrivateDataSpecifierDescriptor::parse(&[TAG]).unwrap_err();
121        assert!(matches!(err, Error::BufferTooShort { .. }));
122    }
123
124    #[test]
125    fn parse_rejects_truncated_body() {
126        // length=4 but only 2 payload bytes present.
127        let err = PrivateDataSpecifierDescriptor::parse(&[TAG, 4, 0, 0]).unwrap_err();
128        assert!(matches!(err, Error::BufferTooShort { .. }));
129    }
130
131    #[test]
132    fn parse_rejects_wrong_length() {
133        let err = PrivateDataSpecifierDescriptor::parse(&[TAG, 3, 0, 0, 0]).unwrap_err();
134        assert!(matches!(err, Error::InvalidDescriptor { .. }));
135    }
136
137    #[test]
138    fn serialize_round_trip() {
139        let d = PrivateDataSpecifierDescriptor {
140            private_data_specifier: 0xDEAD_BEEF,
141        };
142        let mut buf = vec![0u8; d.serialized_len()];
143        d.serialize_into(&mut buf).unwrap();
144        let re = PrivateDataSpecifierDescriptor::parse(&buf).unwrap();
145        assert_eq!(d, re);
146    }
147
148    #[test]
149    fn serialize_rejects_too_small_buffer() {
150        let d = PrivateDataSpecifierDescriptor {
151            private_data_specifier: 1,
152        };
153        let mut tiny = [0u8; 3];
154        let err = d.serialize_into(&mut tiny).unwrap_err();
155        assert!(matches!(err, Error::OutputBufferTooSmall { .. }));
156    }
157
158    #[test]
159    fn descriptor_length_matches_payload() {
160        let d = PrivateDataSpecifierDescriptor {
161            private_data_specifier: 0,
162        };
163        assert_eq!(d.descriptor_length(), 4);
164    }
165
166    #[cfg(feature = "serde")]
167    #[test]
168    fn serde_round_trip() {
169        let d = PrivateDataSpecifierDescriptor {
170            private_data_specifier: 0x0000_233A,
171        };
172        let json = serde_json::to_string(&d).unwrap();
173        // Serialize-only: assert the emitted JSON re-parses (serialize-stable).
174        let _v: serde_json::Value = serde_json::from_str(&json).unwrap();
175    }
176}
dvb_si/descriptors/private_data_specifier.rs

dvb_si/descriptors/
private_data_specifier.rs
