inherface 0.2.0

Retrieve a system's Network Interfaces on Linux
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

# inherface

This project is used to get a linux system's network interfaces.
It is a fork of `network-interface`, a project by Esteban Borai and others.
We'll talk about why you might choose `inherface` vs `network-interface` below. 

## Usage

This project provides both a binary and a library.

### Binary

Install with `cargo install inherface` then run `inherface`. At this moment, there are no CLI arguments to pass.

### Library

Add to your project with `cargo add inherface`.
All features except `serde` are enabled by default. Adjust as necessary.

Here is an example to get a specific interface by name:

```rust
use inherface::get_interfaces;

fn main() {
    // interfaces is a HashMap<String, NetworkInterface>
    let interfaces = get_interfaces().unwrap();
    let ethernet_interface = interfaces.get("eth0").expect("Interface not found");
}   
```

Or iterating through all interfaces:

```rust
use inherface::get_interfaces;

fn main() {
    let interfaces = get_interfaces().unwrap();
    interfaces.values().for_each(|interface| println!("{:?}", interface));
}
```

Would output something like:

```
NetworkInterface { name: "eth0", index: 2, v4_addr: [V4IfAddr { ip: 192.168.1.123, broadcast: Some(192.168.1.255), netmask: Some(255.255.255.0) }], v6_addr: [V6IfAddr { ip: <redacted>, broadcast: None, netmask: Some(ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff) }, V6IfAddr { ip: <redacted>, broadcast: None, netmask: Some(ffff:ffff:ffff:ffff::) }, V6IfAddr { ip: <redacted>, broadcast: None, netmask: Some(ffff:ffff:ffff:ffff::) }], mac_addr: Some(MacAddress { bytes: [<redacted>] }) }
NetworkInterface { name: "lo", index: 1, v4_addr: [V4IfAddr { ip: 127.0.0.1, broadcast: Some(127.255.255.255), netmask: Some(255.0.0.0) }], v6_addr: [V6IfAddr { ip: ::1, broadcast: None, netmask: Some(ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff) }], mac_addr: Some(MacAddress { bytes: [0, 0, 0, 0, 0, 0] }) }
NetworkInterface { name: "wlan0", index: 3, v4_addr: [], v6_addr: [], mac_addr: Some(MacAddress { bytes: [<redacted>] }) }
```

## Comparison

At the time of writing...

Pros of using `inherface`:
- Improved performance and added benchmarking.
- Reduced overall code and added features to allow further reduction.
- Fixed getting the ipv4 broadcast.
- Added binary (see above).
- Open license (GNU LGPL).
- Hosted on open git forge (Codeberg).
- Get interface by name.
- Latest 2024 edition.

Cons of using `inherface` (consider using `network-interface`): 
- Removed support for all systems except linux.
- Lack of CI/CD.

## License

Distributed under the terms of the GNU Library General Public License (Version 2.0). See the LICENSE file for more information.