openthread/ot/types/
operational_dataset.rs

1// Copyright 2021 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::prelude_internal::*;
6use std::ops::Deref;
7
8/// Functional equivalent of [`otsys::otOperationalDataset`](crate::otsys::otOperationalDataset).
9#[derive(Default, Clone)]
10#[repr(transparent)]
11pub struct OperationalDataset(pub otOperationalDataset);
12
13impl_ot_castable!(OperationalDataset, otOperationalDataset);
14
15impl OperationalDataset {
16    /// Returns an empty operational dataset.
17    pub fn empty() -> OperationalDataset {
18        Self::default()
19    }
20
21    /// Returns true if this dataset is considered "complete"
22    pub fn is_complete(&self) -> bool {
23        self.get_active_timestamp().is_some()
24            && self.get_network_name().is_some()
25            && self.get_network_key().is_some()
26            && self.get_extended_pan_id().is_some()
27            && self.get_mesh_local_prefix().is_some()
28            && self.get_pan_id().is_some()
29            && self.get_channel().is_some()
30            && self.get_pskc().is_some()
31            && self.get_security_policy().is_some()
32            && self.get_channel_mask().is_some()
33    }
34
35    /// Clears all of the fields in this dataset.
36    pub fn clear(&mut self) {
37        *self = Self::empty();
38    }
39
40    // TODO: Not clear what the OpenThread API is to accomplish this.
41    // pub fn to_tlvs(&self) -> OperationalDatasetTlvs {
42    //     todo!()
43    // }
44}
45
46impl std::fmt::Debug for OperationalDataset {
47    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
48        let mut ds = f.debug_struct("OperationalDataset");
49
50        if let Some(x) = self.get_network_name() {
51            ds.field("network_name", &x);
52        }
53        if let Some(x) = self.get_extended_pan_id() {
54            ds.field("xpanid", &x);
55        }
56        if let Some(x) = self.get_network_key() {
57            ds.field("network_key", &x);
58        }
59        if let Some(x) = self.get_mesh_local_prefix() {
60            ds.field("mesh_local_prefix", &x);
61        }
62        if let Some(x) = self.get_pan_id() {
63            ds.field("panid", &x);
64        }
65        if let Some(x) = self.get_channel() {
66            ds.field("channel", &x);
67        }
68        if let Some(x) = self.get_channel_mask() {
69            ds.field("channel_mask", &x);
70        }
71        if let Some(x) = self.get_pskc() {
72            ds.field("pskc", &x);
73        }
74        if let Some(x) = self.get_security_policy() {
75            ds.field("security_policy", &x);
76        }
77        if let Some(x) = self.get_delay() {
78            ds.field("delay", &x);
79        }
80        if let Some(x) = self.get_active_timestamp() {
81            ds.field("active_timestamp", &x);
82        }
83        if let Some(x) = self.get_pending_timestamp() {
84            ds.field("pending_timestamp", &x);
85        }
86        ds.finish()
87    }
88}
89
90impl OperationalDataset {
91    /// Returns the channel index, if present.
92    pub fn get_channel(&self) -> Option<ChannelIndex> {
93        self.0.mComponents.mIsChannelPresent.then(|| self.0.mChannel.try_into().unwrap())
94    }
95
96    /// Returns the channel mask, if present.
97    pub fn get_channel_mask(&self) -> Option<ChannelMask> {
98        self.0.mComponents.mIsChannelMaskPresent.then(|| self.0.mChannelMask.into())
99    }
100
101    /// Returns the delay, if present.
102    pub fn get_delay(&self) -> Option<u32> {
103        self.0.mComponents.mIsDelayPresent.then_some(self.0.mDelay)
104    }
105
106    /// Returns the extended PAN-ID, if present.
107    pub fn get_extended_pan_id(&self) -> Option<&ExtendedPanId> {
108        self.0
109            .mComponents
110            .mIsExtendedPanIdPresent
111            .then(|| ExtendedPanId::ref_from_ot_ref(&self.0.mExtendedPanId))
112    }
113
114    /// Returns the network key, if present.
115    pub fn get_network_key(&self) -> Option<&NetworkKey> {
116        self.0
117            .mComponents
118            .mIsNetworkKeyPresent
119            .then(|| NetworkKey::ref_from_ot_ref(&self.0.mNetworkKey))
120    }
121
122    /// Returns the network key, if present.
123    pub fn get_pskc(&self) -> Option<&Pskc> {
124        self.0.mComponents.mIsPskcPresent.then(|| Pskc::ref_from_ot_ref(&self.0.mPskc))
125    }
126
127    /// Returns the network name, if present.
128    pub fn get_network_name(&self) -> Option<&NetworkName> {
129        self.0
130            .mComponents
131            .mIsNetworkNamePresent
132            .then(|| NetworkName::ref_from_ot_ref(&self.0.mNetworkName))
133    }
134
135    /// Returns the PAN-ID, if present.
136    pub fn get_pan_id(&self) -> Option<PanId> {
137        self.0.mComponents.mIsPanIdPresent.then_some(self.0.mPanId)
138    }
139
140    /// Returns the active timestamp, if present.
141    pub fn get_active_timestamp(&self) -> Option<Timestamp> {
142        self.0.mComponents.mIsActiveTimestampPresent.then(|| self.0.mActiveTimestamp.into())
143    }
144
145    /// Returns the pending timestamp, if present.
146    pub fn get_pending_timestamp(&self) -> Option<Timestamp> {
147        self.0.mComponents.mIsPendingTimestampPresent.then(|| self.0.mPendingTimestamp.into())
148    }
149
150    /// Returns the security policy, if present.
151    pub fn get_security_policy(&self) -> Option<&SecurityPolicy> {
152        self.0
153            .mComponents
154            .mIsSecurityPolicyPresent
155            .then(|| SecurityPolicy::ref_from_ot_ref(&self.0.mSecurityPolicy))
156    }
157
158    /// Returns the mesh-local prefix, if present.
159    pub fn get_mesh_local_prefix(&self) -> Option<&MeshLocalPrefix> {
160        self.0
161            .mComponents
162            .mIsMeshLocalPrefixPresent
163            .then_some(&self.0.mMeshLocalPrefix)
164            .map(Into::into)
165    }
166}
167
168impl OperationalDataset {
169    /// Sets or clears the channel index.
170    pub fn set_channel(&mut self, opt: Option<ChannelIndex>) {
171        if let Some(x) = opt {
172            self.0.mChannel = x.into();
173            self.0.mComponents.mIsChannelPresent = true;
174        } else {
175            self.0.mComponents.mIsChannelPresent = false;
176        }
177    }
178
179    /// Sets or clears the channel mask.
180    pub fn set_channel_mask(&mut self, opt: Option<ChannelMask>) {
181        if let Some(x) = opt {
182            self.0.mChannelMask = x.into();
183            self.0.mComponents.mIsChannelMaskPresent = true;
184        } else {
185            self.0.mComponents.mIsChannelMaskPresent = false;
186        }
187    }
188
189    /// Sets or clears the delay.
190    pub fn set_delay(&mut self, opt: Option<u32>) {
191        if let Some(x) = opt {
192            self.0.mDelay = x;
193            self.0.mComponents.mIsDelayPresent = true;
194        } else {
195            self.0.mComponents.mIsDelayPresent = false;
196        }
197    }
198
199    /// Sets or clears the extended PAN-ID.
200    pub fn set_extended_pan_id(&mut self, opt: Option<&ExtendedPanId>) {
201        if let Some(x) = opt {
202            self.0.mExtendedPanId = *x.as_ot_ref();
203            self.0.mComponents.mIsExtendedPanIdPresent = true;
204        } else {
205            self.0.mComponents.mIsExtendedPanIdPresent = false;
206        }
207    }
208
209    /// Sets or clears the network key.
210    pub fn set_network_key(&mut self, opt: Option<&NetworkKey>) {
211        if let Some(x) = opt {
212            self.0.mNetworkKey = *x.as_ot_ref();
213            self.0.mComponents.mIsNetworkKeyPresent = true;
214        } else {
215            self.0.mComponents.mIsNetworkKeyPresent = false;
216        }
217    }
218
219    /// Sets or clears the network name.
220    pub fn set_network_name(&mut self, opt: Option<&NetworkName>) {
221        if let Some(x) = opt {
222            self.0.mNetworkName = *x.as_ot_ref();
223            self.0.mComponents.mIsNetworkNamePresent = true;
224        } else {
225            self.0.mComponents.mIsNetworkNamePresent = false;
226        }
227    }
228
229    /// Sets or clears the PAN-ID.
230    pub fn set_pan_id(&mut self, opt: Option<PanId>) {
231        if let Some(x) = opt {
232            self.0.mPanId = x;
233            self.0.mComponents.mIsPanIdPresent = true;
234        } else {
235            self.0.mComponents.mIsPanIdPresent = false;
236        }
237    }
238
239    /// Sets or clears the active timestamp
240    pub fn set_active_timestamp(&mut self, opt: Option<Timestamp>) {
241        if let Some(x) = opt {
242            self.0.mActiveTimestamp = x.into();
243            self.0.mComponents.mIsActiveTimestampPresent = true;
244        } else {
245            self.0.mComponents.mIsActiveTimestampPresent = false;
246        }
247    }
248
249    /// Sets or clears the pending timestamp.
250    pub fn set_pending_timestamp(&mut self, opt: Option<Timestamp>) {
251        if let Some(x) = opt {
252            self.0.mPendingTimestamp = x.into();
253            self.0.mComponents.mIsPendingTimestampPresent = true;
254        } else {
255            self.0.mComponents.mIsPendingTimestampPresent = false;
256        }
257    }
258
259    /// Sets or clears the security policy.
260    pub fn set_security_policy(&mut self, opt: Option<SecurityPolicy>) {
261        if let Some(x) = opt {
262            self.0.mSecurityPolicy = *x.as_ot_ref();
263            self.0.mComponents.mIsSecurityPolicyPresent = true;
264        } else {
265            self.0.mComponents.mIsSecurityPolicyPresent = false;
266        }
267    }
268
269    /// Sets or clears the mesh-local prefix.
270    pub fn set_mesh_local_prefix(&mut self, opt: Option<&MeshLocalPrefix>) {
271        if let Some(x) = opt {
272            self.0.mMeshLocalPrefix = *x.as_ot_ref();
273            self.0.mComponents.mIsMeshLocalPrefixPresent = true;
274        } else {
275            self.0.mComponents.mIsMeshLocalPrefixPresent = false;
276        }
277    }
278}
279
280/// Functional equivalent of [`otsys::otOperationalDatasetTlvs`](crate::otsys::otOperationalDatasetTlvs).
281#[derive(Debug, Default, Clone)]
282#[repr(transparent)]
283pub struct OperationalDatasetTlvs(pub otOperationalDatasetTlvs);
284
285impl_ot_castable!(OperationalDatasetTlvs, otOperationalDatasetTlvs);
286
287impl OperationalDatasetTlvs {
288    /// Tries to parse the TLVs into a dataset
289    /// Functional equivalent to `otDatasetParseTlvs`
290    pub fn try_to_dataset(&self) -> Result<OperationalDataset> {
291        let mut ret = OperationalDataset::default();
292        Error::from(unsafe { otDatasetParseTlvs(self.as_ot_ptr(), ret.as_ot_mut_ptr()) })
293            .into_result()?;
294        Ok(ret)
295    }
296
297    /// Tries to create a `OperationalDatasetTlvs` instance from the given byte slice.
298    pub fn try_from_slice(slice: &[u8]) -> Result<Self, ot::WrongSize> {
299        let mut ret = Self::default();
300        let len = slice.len();
301
302        if len > OT_OPERATIONAL_DATASET_MAX_LENGTH as usize {
303            return Err(ot::WrongSize);
304        }
305
306        ret.0.mLength = len.try_into().unwrap();
307
308        ret.0.mTlvs[0..len].clone_from_slice(slice);
309
310        Ok(ret)
311    }
312
313    /// Returns length of the TLVs in bytes. 0-16.
314    #[allow(clippy::len_without_is_empty)]
315    pub fn len(&self) -> usize {
316        self.0.mLength as usize
317    }
318
319    /// Returns the TLVs as a byte slice with no trailing zeros.
320    pub fn as_slice(&self) -> &[u8] {
321        &self.0.mTlvs[0..self.len()]
322    }
323
324    /// Creates a `Vec<u8>` from the raw bytes of the TLVs
325    pub fn to_vec(&self) -> Vec<u8> {
326        self.as_slice().to_vec()
327    }
328}
329
330impl Deref for OperationalDatasetTlvs {
331    type Target = [u8];
332
333    fn deref(&self) -> &Self::Target {
334        self.as_slice()
335    }
336}
337
338impl<'a> TryFrom<&'a [u8]> for OperationalDatasetTlvs {
339    type Error = ot::WrongSize;
340
341    fn try_from(value: &'a [u8]) -> Result<Self, Self::Error> {
342        OperationalDatasetTlvs::try_from_slice(value)
343    }
344}
345
346impl TryFrom<Vec<u8>> for OperationalDatasetTlvs {
347    type Error = ot::WrongSize;
348
349    fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
350        OperationalDatasetTlvs::try_from_slice(&value)
351    }
352}
353
354impl From<OperationalDatasetTlvs> for Vec<u8> {
355    fn from(value: OperationalDatasetTlvs) -> Self {
356        value.to_vec()
357    }
358}
359
360impl TryFrom<OperationalDatasetTlvs> for OperationalDataset {
361    type Error = ot::Error;
362
363    fn try_from(value: OperationalDatasetTlvs) -> Result<Self, Self::Error> {
364        value.try_to_dataset()
365    }
366}
367
368#[cfg(test)]
369mod test {
370    use super::*;
371
372    #[test]
373    fn test_operational_dataset() {
374        let dataset_bytes = hex::decode("0e08000062cc8de70000000300001635060004001fffe0020830b02192978a444f0708fd70a9fb17d60000030d4e4553542d50414e2d3043454401020ced0410f73d3809ffd94b329fdab33ba781ba910c0402a0f778").unwrap();
375
376        let dataset_tlvs = OperationalDatasetTlvs::try_from_slice(&dataset_bytes).unwrap();
377
378        let dataset = dataset_tlvs.try_to_dataset().unwrap();
379
380        println!("dataset = {dataset:#?}");
381    }
382}
openthread/ot/types/operational_dataset.rs

openthread/ot/types/
operational_dataset.rs
