openthread/ot/types/
neighbor_info.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 diagnostic information for a neighboring Thread node.
8///
9/// Functional equivalent of [`otsys::otNeighborInfo`](crate::otsys::otNeighborInfo).
10#[derive(Debug, Default, Clone)]
11#[repr(transparent)]
12pub struct NeighborInfo(pub otNeighborInfo);
13
14impl_ot_castable!(NeighborInfo, otNeighborInfo);
15
16impl NeighborInfo {
17    /// Last time heard from this neighbor, in seconds.
18    pub fn age(&self) -> u32 {
19        self.0.mAge
20    }
21
22    /// Average RSSI of this neighbor.
23    pub fn average_rssi(&self) -> Decibels {
24        self.0.mAverageRssi
25    }
26
27    /// Last RSSI of this neighbor.
28    pub fn last_rssi(&self) -> Decibels {
29        self.0.mLastRssi
30    }
31
32    /// IEEE 802.15.4 Extended Address for this neighbor.
33    pub fn ext_address(&self) -> ExtAddress {
34        self.0.mExtAddress.into()
35    }
36
37    /// Returns true if this neighbor needs full network data.
38    pub fn needs_full_network_data(&self) -> bool {
39        self.0.mFullNetworkData()
40    }
41
42    /// Returns true if this neighbor is a full thread device.
43    pub fn is_full_thread_device(&self) -> bool {
44        self.0.mFullThreadDevice()
45    }
46
47    /// Returns true if this neighbor is a child of this device.
48    pub fn is_child(&self) -> bool {
49        self.0.mIsChild()
50    }
51
52    /// Link Frame Counter for this neighbor.
53    pub fn link_frame_counter(&self) -> u32 {
54        self.0.mLinkFrameCounter
55    }
56
57    /// MLE Frame Counter for this neighbor.
58    pub fn mle_frame_counter(&self) -> u32 {
59        self.0.mMleFrameCounter
60    }
61
62    /// Inbound Link-Quality Indicator value for this neighbor.
63    pub fn lqi_in(&self) -> u8 {
64        self.0.mLinkQualityIn
65    }
66
67    /// Returns true when this neighbor has RX on when idle.
68    pub fn has_rx_on_when_idle(&self) -> bool {
69        self.0.mRxOnWhenIdle()
70    }
71
72    /// RLOC16 for this neighbor.
73    pub fn rloc16(&self) -> ShortAddress {
74        self.0.mRloc16
75    }
76}
openthread/ot/types/neighbor_info.rs

openthread/ot/types/
neighbor_info.rs
