https://github.com/leoborai/local-ip-address
Retrieve system's local IP address and Network Interfaces/Adapters on FreeBSD, Linux, macOS and Windows
https://github.com/leoborai/local-ip-address
bsd dhcp freebsd ip linux local-ip macos network rust windows
Last synced: over 1 year ago
JSON representation
Retrieve system's local IP address and Network Interfaces/Adapters on FreeBSD, Linux, macOS and Windows
- Host: GitHub
- URL: https://github.com/leoborai/local-ip-address
- Owner: LeoBorai
- License: other
- Created: 2021-06-15T05:04:13.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T00:17:58.000Z (almost 2 years ago)
- Last Synced: 2025-03-18T06:40:35.918Z (over 1 year ago)
- Topics: bsd, dhcp, freebsd, ip, linux, local-ip, macos, network, rust, windows
- Language: Rust
- Homepage: https://crates.io/crates/local-ip-address
- Size: 114 KB
- Stars: 112
- Watchers: 3
- Forks: 30
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
local-ip-address
Retrieve system's local IP address and Network Interfaces/Adapters on
Linux, Windows, and macOS (and other BSD-based systems).
[](https://crates.io/crates/local-ip-address)
[](https://docs.rs/local-ip-address)
## Usage
Get the local IP address of your system by executing the `local_ip` function:
```rust
use local_ip_address::local_ip;
fn main() {
let my_local_ip = local_ip().unwrap();
println!("This is my local IP address: {:?}", my_local_ip);
}
```
Retrieve all the available network interfaces from both, the `AF_INET` and
the `AF_INET6` family by executing the `list_afinet_netifas` function:
```rust
use local_ip_address::list_afinet_netifas;
fn main() {
let network_interfaces = list_afinet_netifas().unwrap();
for (name, ip) in network_interfaces.iter() {
println!("{}:\t{:?}", name, ip);
}
}
```
Underlying approach on retrieving network interfaces or the local IP address
may differ based on the running operative system.
OS | Approach
--- | ---
Linux | Establishes a Netlink socket interchange to retrieve network interfaces
BSD-based | Uses of `getifaddrs` to retrieve network interfaces
Windows | Consumes Win32 API's to retrieve the network adapters table
## Operating System Support
Current supported platforms include:
- Linux (requires at least [v0.1.0](https://github.com/EstebanBorai/local-ip-address/releases/tag/v0.1.0));
- macOS (requires at least [v0.1.0](https://github.com/EstebanBorai/local-ip-address/releases/tag/v0.1.0));
- Windows (requires at least [v0.3.0](https://github.com/EstebanBorai/local-ip-address/releases/tag/v0.3.0));
- Other BSD-based (requires at least [v0.5.0](https://github.com/EstebanBorai/local-ip-address/releases/tag/v0.5.0)); including:
- FreeBSD
- OpenBSD
- NetBSD
- DragonFly
Please note that we only test the BSD implementation of this on macOS and FreeBSD, under the assumption that other BSD-based systems will behave similarly. If you have any complications using this library on the other BSD-based, please create an [issue](https://github.com/EstebanBorai/local-ip-address/issues).
## Release
In order to create a release you must push a Git tag as follows
```sh
git tag -a -m
```
**Example**
```sh
git tag -a v0.1.0 -m "First release"
```
> Tags must follow semver conventions
> Tags must be prefixed with a lowercase `v` letter.
Then push tags as follows:
```sh
git push origin main --follow-tags
```
## Contributing
Every contribution to this project is welcome. Feel free to open a pull request,
an issue or just by starting this project.
## License
Distributed under the terms of both the MIT license and the Apache License (Version 2.0)