8 releases
0.6.2 | Aug 2, 2023 |
---|---|
0.6.1 | Oct 23, 2022 |
0.6.0 | May 13, 2022 |
0.5.2 | Apr 28, 2022 |
0.3.1 | Nov 7, 2021 |
#1355 in Command line utilities
23KB
193 lines
ipify-rs
Rust API & CLI for accessing the ipify.org HTTP API
Licensed under the MIT.
About
This is my attempt at writing an API & CLI client for the IPIFY API (aka ipify.org). After looking at all the other crates, they are all flawed in some way (only IPv4, not really cargo compliant, etc.).
Supported Platforms
- Unix (tested on FreeBSD, Linux and macOS)
- Windows
- cmd.exe
- Powershell
API Usage
You first create an instance of Ipify
with new()
set the result you want (IPv4, IPv6) and its format (plain text, json). Result is a string.
use ipify_rs::{Ipify,Op};
let ip = Ipify::new().set(Op::IPv4).call();
println!("My IP is {}", ip);
The four operations are specified as below:
OP::IPv4
OP::IPv6
(the default)OP::IPv4J
(json output)Op::IPv6J
(json output)
Minimalistic API
If you only care about the default (plain text, IPv6 query) and don't want to reuse anything later, then myip()
is what you want:
use ipify_rs::myip;
fn main() {
println!("{}", myip());
}
CLI utility
There is a CLI utility bundled with the API called ipify-cli
.
ipify-cli 0.4.0
Ollivier Robert <roberto@keltia.net>
Rust CLI for IPIFY API.
USAGE:
ipify-cli.exe [OPTIONS]
OPTIONS:
-4, --ipv4 Force getting IPv4
-6, --ipv6 Force getting IPv6
-h, --help Print help information
-J, --json Request JSON output
-q, --quiet Quiet mode
-V, --version Display version and exit
You can see both API & CLI versions:
$ ipify-cli -V
CLI ipify-cli/0.4.0 using API ipify-rs/0.5.0
Example
The file showall.rs
inside examples
show almost all parameters for the API. You can run it with:
$ cargo run --example showall
...
INFO - Start
INFO - Using default, minimal API
IP=aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh
INFO - Using defaults (ipv6)
IP=aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh
INFO - Using defaults, get json
IP={"ip":"aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh"}
IP4="A.B.C.D"
IP6="aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh"
crates.io
You can use this package in your project by adding the following
to your Cargo.toml
:
[dependencies]
ipify-rs = "0.5.0"
then you can use it in your own crates.
Documentation
Full description of the API with examples is on docs.rs as usual: Ipify.
Contributing
Please see CONTRIBUTING.md for some simple rules.
I use Git Flow for this package so please use something similar or the usual github workflow.
- Fork it ( https://github.com/keltia/dmarc-rs/fork )
- Checkout the develop branch (
git checkout develop
) - Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Dependencies
~11–24MB
~391K SLoC