6 releases

0.1.5 Nov 14, 2024
0.1.4 Sep 21, 2024

#989 in Network programming

Download history 5/week @ 2024-10-31 26/week @ 2024-11-07 1687/week @ 2024-11-14 1022/week @ 2024-11-21 1699/week @ 2024-11-28 1324/week @ 2024-12-05 1219/week @ 2024-12-12 1176/week @ 2024-12-19 580/week @ 2024-12-26 1261/week @ 2025-01-02 1238/week @ 2025-01-09 568/week @ 2025-01-16 687/week @ 2025-01-23 544/week @ 2025-01-30

3,318 downloads per month
Used in 4 crates (via tun-rs)

MIT/Apache

39KB
764 lines

getifaddrs

A cross-platform library for retrieving network interface information.

This crate provides a simple and consistent API for querying network interface details across different operating systems. It supports Unix-like systems (Linux, macOS, *BSD) and Windows.

Features

  • Retrieve network interface information (name, IP address, netmask, flags, etc.)
  • Filter interfaces based on various criteria (loopback, IPv4/IPv6, name, index)
  • Cross-platform support (Unix-like systems and Windows)
  • Provides a cross-platform implementation of if_indextoname and if_nametoindex

Usage

Add this to your Cargo.toml:

[dependencies]
getifaddrs = "0.1"

Example

use getifaddrs::{getifaddrs, InterfaceFlags};

fn main() -> std::io::Result<()> {
    for interface in getifaddrs()? {
        println!("Interface: {}", interface.name);
        println!("  Address: {}", interface.address);
        if let Some(netmask) = interface.netmask {
            println!("  Netmask: {}", netmask);
        }
        println!("  Flags: {:?}", interface.flags);
        if interface.flags.contains(InterfaceFlags::UP) {
            println!("  Status: Up");
        } else {
            println!("  Status: Down");
        }
        println!();
    }
    Ok(())
}

License

This project is licensed under the MIT License.

Dependencies

~0–7.5MB
~55K SLoC