Topics

#gateway #network #network-inference #rust #rust-crate #rust-library

Language breakdown

Rust 100.0%

▸ Files click to expand

README

[crates-badge]: https://img.shields.io/crates/v/netdev.svg [crates-url]: https://crates.io/crates/netdev [license-badge]: https://img.shields.io/crates/l/netdev.svg [examples-url]: https://github.com/shellrow/netdev/tree/main/examples [doc-url]: https://docs.rs/netdev/latest/netdev [doc-interface-url]: https://docs.rs/netdev/latest/netdev/interface/interface/struct.Interface.html [netdev-github-url]: https://github.com/shellrow/netdev [default-net-github-url]: https://github.com/shellrow/default-net [default-net-crates-io-url]: https://crates.io/crates/default-net

netdev [![Crates.io][crates-badge]][crates-url] ![License][license-badge]

Cross-platform library for enumerating network interfaces with metadata. netdev provides a unified API for discovering local network interfaces and retrieving commonly used metadata across platforms.

Key Features

Enumerate all available network interfaces
Detect the default network interface
Retrieve interface metadata:

- Interface type - MAC address - IPv4 / IPv6 addresses and prefixes - MTU, flags, operational state, etc...

Native traffic statistics (RX/TX bytes) for each interface
Designed for cross-platform

See the [Interface][doc-interface-url] struct documentation for more details.

Supported platforms

Linux
macOS
Windows
Android
iOS
BSDs

Usage

Add netdev to your Cargo.toml:

[dependencies]
netdev = "0.45"

For more details, see [examples][examples-url] or [doc][doc-url].

Feature flags

gateway (default)

- Enables default interface and default gateway helpers.

apple-system-configuration-extra (default)

- Enables deeper Apple metadata enrichment using SystemConfiguration APIs. - On Apple targets, this adds metadata such as interface display names, DHCP hints, and iOS DNS resolver lookup when the platform exposes them.

android-extra (default)

- Enables deeper Android metadata enrichment using Android platform APIs through JNI bindings. - On Android, this can add metadata such as traffic stats, DNS servers, DHCP hints, and Wi-Fi link speed when the app provides the required Android context and permissions.

To opt out of the additional Apple metadata enrichment while keeping gateway helpers:

[dependencies]
netdev = { version = "0.45", default-features = false, features = ["gateway"] }

Apple behavior

netdev links SystemConfiguration.framework automatically on macOS and iOS through its build script. If your app is ultimately linked by Xcode, you may still need to add SystemConfiguration.framework to the app target manually.

Android behavior

If you want Android-specific values such as DNS servers, DHCP hints, or Wi-Fi link speed, your app may still need to initialize the Android context for Rust and declare Android permissions such as ACCESSNETWORKSTATE and ACCESSWIFISTATE.

Project History

This crate was originally published as [default-net][default-net-crates-io-url] and was later rebranded to netdev by the author for future expansion, clearer naming, and long-term maintenance.