ethernet-info 0.0.4

A library uses SIOCETHTOOL ioctl command to get ethernet information
Documentation 
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

//! This module contains the SettingsParser struct and its implementation.
//! The SettingsParser struct is used to parse the bit settings of a network
//! interface.
use crate::ethtool_const::{
    EthtoolLinkModeBits, EthtoolPort, EthtoolPortBits, ETHTOOL_LINK_MODE_MASK_MAX_KERNEL_NBITS,
};
use enum_iterator::all;

/// # SettingsParser
/// The SettingsParser struct is used to parse the bit settings of a network
/// interface.
///
/// ## Arguments
/// * `port` - The port type number of the network interface.
/// * `supported_link_modes` - The supported link modes of the network interface.
pub struct SettingsParser<'a> {
    port: u8,
    supported_link_modes: &'a [u32],
    advertised_link_modes: &'a [u32],
}

impl<'a> SettingsParser<'a> {
    pub fn new(
        port: u8,
        supported_link_modes: &'a [u32],
        advertised_link_modes: &'a [u32],
    ) -> SettingsParser<'a> {
        SettingsParser {
            port,
            supported_link_modes,
            advertised_link_modes,
        }
    }

    /// Returns the supported port types of the network interface.
    pub fn supported_ports(&'a self) -> Vec<EthtoolPortBits> {
        let mut modes = Vec::new();

        for mode in all::<EthtoolPortBits>() {
            if ethtool_link_mode_test_bit(mode as u32, self.supported_link_modes) {
                modes.push(mode);
            }
        }
        modes
    }

    /// Returns the supported modes of the network interface.
    pub fn supported_link_modes(&'a self) -> Vec<EthtoolLinkModeBits> {
        let mut modes = Vec::new();

        for mode in all::<EthtoolLinkModeBits>() {
            if ethtool_link_mode_test_bit(mode as u32, self.supported_link_modes) {
                modes.push(mode);
            }
        }
        modes
    }

    /// Returns the supported modes of the network interface.
    pub fn advertised_link_modes(&'a self) -> Vec<EthtoolLinkModeBits> {
        let mut modes = Vec::new();

        for mode in all::<EthtoolLinkModeBits>() {
            if ethtool_link_mode_test_bit(mode as u32, self.advertised_link_modes) {
                modes.push(mode);
            }
        }
        modes
    }

    /// Returns the port type of the network interface.
    pub fn port(&'a self) -> EthtoolPort {
        let mode = EthtoolPort::default();
        for mode in all::<EthtoolPort>() {
            if mode as u8 == self.port {
                return mode;
            }
        }
        mode
    }
}

/// Test bit nr in mask
fn ethtool_link_mode_test_bit(nr: u32, mask: &[u32]) -> bool {
    if nr >= ETHTOOL_LINK_MODE_MASK_MAX_KERNEL_NBITS {
        false
    } else {
        (mask[(nr / 32) as usize] & (1 << (nr % 32))) != 0
    }
}