6 releases

0.1.5 Nov 14, 2024
0.1.4 Sep 21, 2024

#1603 in Network programming

Download history 240/week @ 2024-08-30 78/week @ 2024-09-06 145/week @ 2024-09-13 186/week @ 2024-09-20 19/week @ 2024-09-27 8/week @ 2024-10-04 3/week @ 2024-10-11 13/week @ 2024-11-01 377/week @ 2024-11-08 1534/week @ 2024-11-15 1103/week @ 2024-11-22 1693/week @ 2024-11-29

4,715 downloads per month
Used in 3 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
~60K SLoC