openthread/ot/types/
scan_results.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::*;
6
7/// This structure holds information about a network beacon discovered during an active scan.
8///
9/// Functional equivalent of [`otsys::otActiveScanResult`](crate::otsys::otActiveScanResult).
10#[derive(Debug, Default, Clone)]
11#[repr(transparent)]
12pub struct ActiveScanResult(pub otActiveScanResult);
13
14impl_ot_castable!(ActiveScanResult, otActiveScanResult);
15
16impl ActiveScanResult {
17    /// Channel index.
18    pub fn channel(&self) -> ChannelIndex {
19        self.0.mChannel
20    }
21
22    /// RSSI of this beacon.
23    pub fn rssi(&self) -> Decibels {
24        self.0.mRssi
25    }
26
27    /// IEEE 802.15.4 Extended Address for this beacon.
28    pub fn ext_address(&self) -> ExtAddress {
29        self.0.mExtAddress.into()
30    }
31
32    /// Extended PAN-ID for this beacon.
33    pub fn extended_pan_id(&self) -> ExtendedPanId {
34        self.0.mExtendedPanId.into()
35    }
36
37    /// Deprecated. Use [`discover()`] instead.
38    ///
39    /// Returns true if this beacon is joinable.
40    #[deprecated]
41    pub fn is_joinable(&self) -> bool {
42        self.0.mDiscover()
43    }
44
45    /// Returns true if this beacon is discoverable.
46    pub fn discover(&self) -> bool {
47        self.0.mDiscover()
48    }
49
50    /// Returns true if this beacon is "native".
51    pub fn is_native(&self) -> bool {
52        self.0.mIsNative()
53    }
54
55    /// UDP Joiner port
56    pub fn joiner_udp_port(&self) -> u16 {
57        self.0.mJoinerUdpPort
58    }
59
60    /// LQI of this beacon.
61    pub fn lqi(&self) -> u8 {
62        self.0.mLqi
63    }
64
65    /// Network Name from this beacon.
66    pub fn network_name(&self) -> &NetworkName {
67        NetworkName::ref_from_ot_ref(&self.0.mNetworkName)
68    }
69
70    /// PAN-ID from this beacon.
71    pub fn pan_id(&self) -> PanId {
72        self.0.mPanId
73    }
74
75    /// Version field from this beacon.
76    pub fn version(&self) -> u32 {
77        self.0.mVersion()
78    }
79
80    /// Steering Data.
81    pub fn steering_data(&self) -> &[u8] {
82        &self.0.mSteeringData.m8[0..self.0.mSteeringData.mLength as usize]
83    }
84}
85
86/// This structure holds information about energy levels detected on a channel.
87///
88/// Functional equivalent of [`otsys::otEnergyScanResult`](crate::otsys::otEnergyScanResult).
89#[derive(Debug, Default, Clone)]
90#[repr(transparent)]
91pub struct EnergyScanResult(pub otEnergyScanResult);
92
93impl_ot_castable!(EnergyScanResult, otEnergyScanResult);
94
95impl EnergyScanResult {
96    /// Channel index.
97    pub fn channel(&self) -> ChannelIndex {
98        self.0.mChannel
99    }
100
101    /// Max RSSI
102    pub fn max_rssi(&self) -> Decibels {
103        self.0.mMaxRssi
104    }
105}
openthread/ot/types/scan_results.rs

openthread/ot/types/
scan_results.rs
